Documentation
¶
Index ¶
- Constants
- type EstimateSettlementResponse
- type EstimateWithdrawRequest
- type EstimateWithdrawResponse
- type GetAccountInfoResponse
- type ListLogLevelsResponse
- type RailView
- type SetLogLevelRegexRequest
- type SetLogLevelRequest
- type SettleRailResponse
- type SettlementStatusResponse
- type WithdrawRequest
- type WithdrawResponse
- type WithdrawalStatusResponse
Constants ¶
View Source
const ( // Route path segments used by both server handlers and HTTP clients. AdminRoutePath = "/admin" LogRoutePath = "/log" PaymentRoutePath = "/payment" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EstimateSettlementResponse ¶ added in v0.2.2
type EstimateSettlementResponse struct {
RailID string `json:"rail_id"`
DataSetID string `json:"data_set_id"`
GrossSettleableAmount string `json:"gross_settleable_amount"` // before proof reduction
NetSettleableAmount string `json:"net_settleable_amount"` // after proof reduction
ProofReductionPct string `json:"proof_reduction_pct"` // percentage reduced due to missed proofs
NetworkFee string `json:"network_fee"`
GasLimit string `json:"gas_limit"`
GasPrice string `json:"gas_price"`
GasCost string `json:"gas_cost"`
NetAmount string `json:"net_amount"` // final amount after all deductions
UntilEpoch string `json:"until_epoch"`
}
Payment
type EstimateWithdrawRequest ¶ added in v0.2.2
type EstimateWithdrawRequest struct {
Recipient string `json:"recipient"` // optional, defaults to owner
Amount string `json:"amount"` // optional, defaults to max available
}
Withdrawal
type EstimateWithdrawResponse ¶ added in v0.2.2
type EstimateWithdrawResponse struct {
AvailableToWithdraw string `json:"available_to_withdraw"`
WithdrawAmount string `json:"withdraw_amount"`
Recipient string `json:"recipient"`
GasLimit string `json:"gas_limit"`
GasPrice string `json:"gas_price"`
GasCost string `json:"gas_cost"`
}
Withdrawal
type GetAccountInfoResponse ¶ added in v0.2.2
type GetAccountInfoResponse struct {
Funds string `json:"funds"`
LockupCurrent string `json:"lockup_current"`
LockupRate string `json:"lockup_rate"`
LockupLastSettledAt string `json:"lockup_last_settled_at"`
AvailableToWithdraw string `json:"available_to_withdraw"`
CurrentEpoch string `json:"current_epoch"`
OwnerAddress string `json:"owner_address"`
Rails []RailView `json:"rails"`
}
Payment
type ListLogLevelsResponse ¶
Logging
type RailView ¶ added in v0.2.2
type RailView struct {
RailID string `json:"rail_id"`
DataSetID string `json:"data_set_id"`
Token string `json:"token"`
From string `json:"from"`
To string `json:"to"`
Operator string `json:"operator"`
Validator string `json:"validator"`
PaymentRate string `json:"payment_rate"`
LockupPeriod string `json:"lockup_period"`
LockupFixed string `json:"lockup_fixed"`
SettledUpTo string `json:"settled_up_to"`
EndEpoch string `json:"end_epoch"`
CommissionRateBps string `json:"commission_rate_bps"`
ServiceFeeRecipient string `json:"service_fee_recipient"`
IsTerminated bool `json:"is_terminated"`
UnsettledEpochs string `json:"unsettled_epochs"`
UnsettledAmount string `json:"unsettled_amount"`
SettleableEpochs string `json:"settleable_epochs"`
SettleableAmount string `json:"settleable_amount"` // gross amount (epochs * rate)
NetSettleableAmount string `json:"net_settleable_amount"` // actual amount after proof validation
CommissionFee string `json:"commission_fee"`
}
Payment
type SetLogLevelRegexRequest ¶
type SetLogLevelRegexRequest struct {
Expression string `json:"expression"`
Level string `json:"level"`
}
Logging
type SetLogLevelRequest ¶
Logging
type SettleRailResponse ¶ added in v0.2.2
type SettleRailResponse struct {
TxHash string `json:"tx_hash"`
Status string `json:"status"` // "pending", "confirmed", "failed"
Error string `json:"error,omitempty"` // error message if any
}
Payment
type SettlementStatusResponse ¶ added in v0.2.2
type SettlementStatusResponse struct {
RailID string `json:"rail_id"`
TxHash string `json:"tx_hash,omitempty"`
Status string `json:"status"` // "none", "pending", "confirmed"
Success bool `json:"success,omitempty"`
ConfirmedBlock string `json:"confirmed_block,omitempty"`
}
Payment
type WithdrawRequest ¶ added in v0.2.2
type WithdrawRequest struct {
Recipient string `json:"recipient"` // optional, defaults to owner
Amount string `json:"amount"` // optional, defaults to max available
}
Withdrawal
type WithdrawResponse ¶ added in v0.2.2
type WithdrawResponse struct {
TxHash string `json:"tx_hash"`
Status string `json:"status"` // "pending", "confirmed", "failed"
Error string `json:"error,omitempty"` // error message if any
}
Withdrawal
type WithdrawalStatusResponse ¶ added in v0.2.2
type WithdrawalStatusResponse struct {
TxHash string `json:"tx_hash,omitempty"`
Status string `json:"status"` // "none", "pending", "confirmed"
Success bool `json:"success,omitempty"`
ConfirmedBlock string `json:"confirmed_block,omitempty"`
}
Withdrawal
Click to show internal directories.
Click to hide internal directories.