api

Documentation

Index

• Constants
• type CheckTxRequest
• type Event
• type GetBlockRequest
• type GetEventsRequest
• type GetTransactionsRequest
• type PlainEvent
• type QueryRequest
• type QueryResponse
• type RuntimeHostError
• type SubmitTxMetaResponse
• type SubmitTxRequest
• type SubmitTxResult
• type TransactionWithResults

Constants

const (
	// ModuleName is the runtime client module name.
	ModuleName = "runtime/client"

	// RoundLatest is a special round number always referring to the latest round.
	RoundLatest = roothash.RoundLatest
)

Types

type CheckTxRequest

type CheckTxRequest struct {
	RuntimeID common.Namespace `json:"runtime_id"`
	Data      []byte           `json:"data"`
}

CheckTxRequest is a CheckTx request.

type Event

type Event struct {
	Key    []byte    `json:"key"`
	Value  []byte    `json:"value"`
	TxHash hash.Hash `json:"tx_hash"`
}

Event is an event emitted by a runtime in the form of a runtime transaction tag.

Key and value semantics are runtime-dependent.

type GetBlockRequest

type GetBlockRequest struct {
	RuntimeID common.Namespace `json:"runtime_id"`
	Round     uint64           `json:"round"`
}

GetBlockRequest is a GetBlock request.

type GetEventsRequest

type GetEventsRequest struct {
	RuntimeID common.Namespace `json:"runtime_id"`
	Round     uint64           `json:"round"`
}

GetEventsRequest is a GetEvents request.

type GetTransactionsRequest

type GetTransactionsRequest struct {
	RuntimeID common.Namespace `json:"runtime_id"`
	Round     uint64           `json:"round"`
}

GetTransactionsRequest is a GetTransactions request.

type PlainEvent

type PlainEvent struct {
	Key   []byte `json:"key"`
	Value []byte `json:"value"`
}

PlainEvent is an event emitted by a runtime in the form of a runtime transaction tag. It does not include the transaction hash.

Key and value semantics are runtime-dependent.

type QueryRequest

type QueryRequest struct {
	RuntimeID common.Namespace `json:"runtime_id"`
	Round     uint64           `json:"round"`
	Method    string           `json:"method"`
	Args      []byte           `json:"args"`
}

QueryRequest is a Query request.

type QueryResponse

type QueryResponse struct {
	Data []byte `json:"data"`
}

QueryResponse is a response to the runtime query.

type RuntimeHostError

type RuntimeHostError struct {
	Module  string `json:"module,omitempty"`
	Code    uint32 `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

RuntimeHostError is a message body representing an error. NOTE: RENAMED from "Error" and imported from github.com/oasisprotocol/oasis-core/go/runtime/host/protocol as a manual step when vendoring oasis-core v22.2.11.

type SubmitTxMetaResponse

type SubmitTxMetaResponse struct {
	// Output is the transaction output.
	Output []byte `json:"data,omitempty"`
	// Round is the roothash round in which the transaction was executed.
	Round uint64 `json:"round,omitempty"`
	// BatchOrder is the order of the transaction in the execution batch.
	BatchOrder uint32 `json:"batch_order,omitempty"`

	// CheckTxError is the CheckTx error in case transaction failed the transaction check.
	CheckTxError RuntimeHostError `json:"check_tx_error,omitempty"`
}

SubmitTxMetaResponse is the SubmitTxMeta response.

type SubmitTxRequest

type SubmitTxRequest struct {
	RuntimeID common.Namespace `json:"runtime_id"`
	Data      []byte           `json:"data"`
}

SubmitTxRequest is a SubmitTx request.

type SubmitTxResult

type SubmitTxResult struct {
	Error  error
	Result *SubmitTxMetaResponse
}

SubmitTxResult is the raw result of submitting a transaction for processing.

type TransactionWithResults

type TransactionWithResults struct {
	Tx     []byte        `json:"tx"`
	Result []byte        `json:"result"`
	Events []*PlainEvent `json:"events,omitempty"`
}

TransactionWithResults is a transaction with its raw result and emitted events.