Documentation
¶
Index ¶
- Constants
- func IsHTTPNotFound(e error) bool
- type Address
- type BlobData
- type BlobInfo
- type Bytes
- type ChainID
- type ChainInfo
- type ChainNodeStatus
- type ChainRecord
- type ConsensusPipeMetrics
- type ConsensusWorkflowStatus
- type DKSharesInfo
- type DKSharesPostRequest
- type HTTPError
- type HashValue
- type InfoResponse
- type NodeConnectionMessageMetrics
- type NodeConnectionMessagesMetrics
- type NodeConnectionMetrics
- type NodeOwnerCertificateRequest
- type NodeOwnerCertificateResponse
- type OffLedgerRequestBody
- type PeeringNodeStatus
- type PeeringTrustedNode
- type RequestID
- type RequestReceiptResponse
- type ValueTxID
- type WaitRequestProcessedParams
Constants ¶
const WaitRequestProcessedDefaultTimeout = 30 * time.Second
Variables ¶
This section is empty.
Functions ¶
func IsHTTPNotFound ¶
IsHTTPNotFound returns true if the error is an HTTPError with status code http.StatusNotFound
Types ¶
type Address ¶
type Address string
Address is the string representation of iotago.Address
func NewAddress ¶
func (Address) MarshalJSON ¶
func (*Address) UnmarshalJSON ¶
type BlobData ¶
type BlobData struct {
Data Bytes `swagger:"desc(Blob content (base64))"`
}
func NewBlobData ¶
type BlobInfo ¶
type Bytes ¶
type Bytes string
Bytes is the base64 representation of a byte slice. It is intended to be a replacement for any []byte attribute in JSON models. Normally it shouldn't be necessary since the standard json package already handles []byte data, but this makes sure that the swagger documentation shows examples correctly (instead of as if a []byte was json-encoded as an array of ints).
func (Bytes) MarshalJSON ¶
func (*Bytes) UnmarshalJSON ¶
type ChainID ¶
type ChainID string
ChainID is the string representation of isc.ChainID (bech32)
func NewChainID ¶
func (ChainID) MarshalJSON ¶
func (*ChainID) UnmarshalJSON ¶
type ChainInfo ¶ added in v0.2.4
type ChainInfo struct {
ChainID ChainID `swagger:"desc(ChainID (base58-encoded))"`
Active bool `swagger:"desc(Whether or not the chain is active)"`
StateAddress Address `swagger:"desc(State address, if we are part of it.)"`
CommitteeNodes []*ChainNodeStatus `swagger:"desc(Committee nodes and their peering info.)"`
AccessNodes []*ChainNodeStatus `swagger:"desc(Access nodes and their peering info.)"`
CandidateNodes []*ChainNodeStatus `swagger:"desc(Candidate nodes and their peering info.)"`
}
type ChainNodeStatus ¶ added in v0.2.4
type ChainNodeStatus struct {
Node PeeringNodeStatus
ForCommittee bool
ForAccess bool
AccessAPI string
}
type ChainRecord ¶
type ChainRecord struct {
ChainID ChainID `swagger:"desc(ChainID (bech32))"`
Active bool `swagger:"desc(Whether or not the chain is active)"`
}
func NewChainRecord ¶
func NewChainRecord(rec *registry.ChainRecord) *ChainRecord
func (*ChainRecord) Record ¶ added in v0.2.0
func (bd *ChainRecord) Record() *registry.ChainRecord
type ConsensusPipeMetrics ¶ added in v0.2.5
type ConsensusPipeMetrics struct {
EventStateTransitionMsgPipeSize int
EventPeerLogIndexMsgPipeSize int
EventInclusionStateMsgPipeSize int
EventACSMsgPipeSize int
EventVMResultMsgPipeSize int
EventTimerMsgPipeSize int
}
func NewConsensusPipeMetrics ¶ added in v0.2.5
func NewConsensusPipeMetrics(pipeMetrics chain.ConsensusPipeMetrics) *ConsensusPipeMetrics
type ConsensusWorkflowStatus ¶ added in v0.2.4
type ConsensusWorkflowStatus struct {
FlagStateReceived bool `swagger:"desc(Shows if state output is received in current consensus iteration)"`
FlagBatchProposalSent bool `swagger:"desc(Shows if batch proposal is sent out in current consensus iteration)"`
FlagConsensusBatchKnown bool `swagger:"desc(Shows if consensus on batch is reached and known in current consensus iteration)"`
FlagVMStarted bool `swagger:"desc(Shows if virtual machine is started in current consensus iteration)"`
FlagVMResultSigned bool `swagger:"desc(Shows if virtual machine has returned its results in current consensus iteration)"`
FlagTransactionFinalized bool `swagger:"desc(Shows if consensus on transaction is reached in current consensus iteration)"`
FlagTransactionPosted bool `swagger:"desc(Shows if transaction is posted to L1 in current consensus iteration)"`
FlagTransactionSeen bool `swagger:"desc(Shows if L1 reported that it has seen the transaction of current consensus iteration)"`
FlagInProgress bool `swagger:"desc(Shows if consensus algorithm is still not completed in current consensus iteration)"`
TimeBatchProposalSent time.Time `swagger:"desc(Shows when batch proposal was last sent out in current consensus iteration)"`
TimeConsensusBatchKnown time.Time `swagger:"desc(Shows when ACS results of consensus on batch was last received in current consensus iteration)"`
TimeVMStarted time.Time `swagger:"desc(Shows when virtual machine was last started in current consensus iteration)"`
TimeVMResultSigned time.Time `swagger:"desc(Shows when virtual machine results were last received and signed in current consensus iteration)"`
TimeTransactionFinalized time.Time `` /* 143-byte string literal not displayed */
TimeTransactionPosted time.Time `swagger:"desc(Shows when transaction was last posted to L1 in current consensus iteration)"`
TimeTransactionSeen time.Time `swagger:"desc(Shows when algorithm last noted that transaction hadd been seen by L1 in current consensus iteration)"`
TimeCompleted time.Time `swagger:"desc(Shows when algorithm was last completed in current consensus iteration)"`
CurrentStateIndex uint32 `swagger:"desc(Shows current state index of the consensus)"`
}
func NewConsensusWorkflowStatus ¶ added in v0.2.4
func NewConsensusWorkflowStatus(status chain.ConsensusWorkflowStatus) *ConsensusWorkflowStatus
type DKSharesInfo ¶
type DKSharesInfo struct {
}
DKSharesInfo stands for the DKShare representation, returned by the GET and POST methods.
type DKSharesPostRequest ¶
type DKSharesPostRequest struct {
}
DKSharesPostRequest is a POST request for creating new DKShare.
type HTTPError ¶
type HTTPError struct {
// StatusCode is the associated HTTP status code (default: htttp.StatusInternalServerError)
StatusCode int
// Message is the error message
Message string
}
HTTPError is the standard error response for all webapi endpoints, and also implements the Go error interface.
func NewHTTPError ¶
NewHTTPError creates a new HTTPError
type HashValue ¶
type HashValue string
HashValue is the base58 representation of a hashing.HashValue
func NewHashValue ¶
func (HashValue) MarshalJSON ¶
func (*HashValue) UnmarshalJSON ¶
type InfoResponse ¶
type NodeConnectionMessageMetrics ¶ added in v0.2.3
type NodeConnectionMessageMetrics struct {
Total uint32 `swagger:"desc(Total number of messages sent/received)"`
LastEvent time.Time `swagger:"desc(Last time the message was sent/received)"`
LastMessage string `swagger:"desc(The print out of the last message)"`
}
func NewNodeConnectionMessageMetrics ¶ added in v0.2.3
func NewNodeConnectionMessageMetrics(metrics nodeconnmetrics.NodeConnectionMessageMetrics) *NodeConnectionMessageMetrics
type NodeConnectionMessagesMetrics ¶ added in v0.2.3
type NodeConnectionMessagesMetrics struct {
OutPublishStateTransaction *NodeConnectionMessageMetrics `swagger:"desc(Stats of sent out PublishStateTransaction messages)"`
OutPublishGovernanceTransaction *NodeConnectionMessageMetrics `swagger:"desc(Stats of sent out PublishGovernanceTransaction messages)"`
OutPullLatestOutput *NodeConnectionMessageMetrics `swagger:"desc(Stats of sent out PullLatestOutput messages)"`
OutPullTxInclusionState *NodeConnectionMessageMetrics `swagger:"desc(Stats of sent out PullTxInclusionState messages)"`
OutPullOutputByID *NodeConnectionMessageMetrics `swagger:"desc(Stats of sent out PullOutputByID messages)"`
InStateOutput *NodeConnectionMessageMetrics `swagger:"desc(Stats of received State output messages)"`
InAliasOutput *NodeConnectionMessageMetrics `swagger:"desc(Stats of received AliasOutput messages)"`
InOutput *NodeConnectionMessageMetrics `swagger:"desc(Stats of received Output messages)"`
InOnLedgerRequest *NodeConnectionMessageMetrics `swagger:"desc(Stats of received OnLedgerRequest messages)"`
InTxInclusionState *NodeConnectionMessageMetrics `swagger:"desc(Stats of received TxInclusionState messages)"`
}
func NewNodeConnectionMessagesMetrics ¶ added in v0.2.3
func NewNodeConnectionMessagesMetrics(metrics nodeconnmetrics.NodeConnectionMessagesMetrics) *NodeConnectionMessagesMetrics
type NodeConnectionMetrics ¶ added in v0.2.3
type NodeConnectionMetrics struct {
NodeConnectionMessagesMetrics
InMilestone *NodeConnectionMessageMetrics `swagger:"desc(Stats of received Milestone messages)"`
Registered []ChainID `swagger:"desc(Chain IDs of the chains registered to receiving L1 events)"`
}
func NewNodeConnectionMetrics ¶ added in v0.2.3
func NewNodeConnectionMetrics(metrics nodeconnmetrics.NodeConnectionMetrics) *NodeConnectionMetrics
type NodeOwnerCertificateRequest ¶ added in v0.2.4
type NodeOwnerCertificateResponse ¶ added in v0.2.4
type NodeOwnerCertificateResponse struct {
Certificate Bytes `swagger:"desc(Certificate stating the ownership. (base64))"`
}
type OffLedgerRequestBody ¶ added in v0.2.0
type OffLedgerRequestBody struct {
Request Bytes `swagger:"desc(Offledger Request (base64))"`
}
type PeeringNodeStatus ¶ added in v0.2.0
type PeeringTrustedNode ¶ added in v0.2.0
type PeeringTrustedNode struct {
PubKey string `json:"pubKey" swagger:"desc(Public key of the NetID.)"`
NetID string `json:"netID" swagger:"desc(NetID of a peer to trust.)"`
}
PeeringTrustedNode describes single node in the list of trusted peering nodes.
func NewPeeringTrustedNode ¶ added in v0.2.0
func NewPeeringTrustedNode(tp *peering.TrustedPeer) *PeeringTrustedNode
type RequestID ¶ added in v0.3.0
type RequestID string
RequestID is the string representation of isc.RequestID
func NewRequestID ¶ added in v0.3.0
func (RequestID) MarshalJSON ¶ added in v0.3.0
func (*RequestID) UnmarshalJSON ¶ added in v0.3.0
type RequestReceiptResponse ¶ added in v0.3.0
type RequestReceiptResponse struct {
Receipt string `swagger:"desc(Request receipt, empty if request was not processed)"`
}
type ValueTxID ¶
type ValueTxID string
ValueTxID is the base58 representation of a transaction ID
func NewValueTxID ¶
func NewValueTxID(id *iotago.TransactionID) ValueTxID
func (ValueTxID) ID ¶
func (id ValueTxID) ID() iotago.TransactionID