Documentation ¶
Index ¶
- Variables
- func ConvertAPIs(in []*runtime.APIItem) []interface{}
- type AuthorModule
- func (cm *AuthorModule) HasKey(r *http.Request, req *[]string, res *bool) error
- func (cm *AuthorModule) InsertKey(r *http.Request, req *KeyInsertRequest, res *KeyInsertResponse) error
- func (cm *AuthorModule) PendingExtrinsics(r *http.Request, req *EmptyRequest, res *PendingExtrinsicsResponse) error
- func (cm *AuthorModule) RemoveExtrinsic(r *http.Request, req *ExtrinsicOrHashRequest, res *RemoveExtrinsicsResponse) error
- func (cm *AuthorModule) RotateKeys(r *http.Request, req *EmptyRequest, res *KeyRotateResponse) error
- func (cm *AuthorModule) SubmitAndWatchExtrinsic(r *http.Request, req *Extrinsic, res *ExtrinsicStatus) error
- func (cm *AuthorModule) SubmitExtrinsic(r *http.Request, req *Extrinsic, res *ExtrinsicHashResponse) error
- type BlockAPI
- type BlockProducerAPI
- type ChainBlock
- type ChainBlockHeaderDigest
- type ChainBlockHeaderResponse
- type ChainBlockNumberRequest
- type ChainBlockResponse
- type ChainFinalizedHeadRequest
- type ChainHashRequest
- type ChainHashResponse
- type ChainModule
- func (cm *ChainModule) GetBlock(r *http.Request, req *ChainHashRequest, res *ChainBlockResponse) error
- func (cm *ChainModule) GetBlockHash(r *http.Request, req *ChainBlockNumberRequest, res *ChainHashResponse) error
- func (cm *ChainModule) GetFinalizedHead(r *http.Request, req *EmptyRequest, res *ChainHashResponse) error
- func (cm *ChainModule) GetFinalizedHeadByRound(r *http.Request, req *ChainFinalizedHeadRequest, res *ChainHashResponse) error
- func (cm *ChainModule) GetHead(r *http.Request, req *ChainBlockNumberRequest, res *ChainHashResponse) error
- func (cm *ChainModule) GetHeader(r *http.Request, req *ChainHashRequest, res *ChainBlockHeaderResponse) error
- func (cm *ChainModule) SubscribeFinalizedHeads(r *http.Request, req *EmptyRequest, res *ChainBlockHeaderResponse) error
- func (cm *ChainModule) SubscribeNewHead(r *http.Request, req *EmptyRequest, res *ChainBlockHeaderResponse) error
- func (cm *ChainModule) SubscribeNewHeads(r *http.Request, req *EmptyRequest, res *ChainBlockHeaderResponse) error
- type CoreAPI
- type DevModule
- type EmptyRequest
- type Extrinsic
- type ExtrinsicHashResponse
- type ExtrinsicOrHash
- type ExtrinsicOrHashRequest
- type ExtrinsicStatus
- type GrandpaModule
- type KeyInsertRequest
- type KeyInsertResponse
- type KeyRotateResponse
- type KeyValueOption
- type MethodsResponse
- type NetworkAPI
- type NetworkStateString
- type PendingExtrinsicsResponse
- type ProveFinalityRequest
- type ProveFinalityResponse
- type RPCAPI
- type RPCModule
- type RemoveExtrinsicsResponse
- type RuntimeAPI
- type StateCallRequest
- type StateCallResponse
- type StateChildStorageRequest
- type StateChildStorageResponse
- type StateChildStorageSizeResponse
- type StateKeysResponse
- type StateMetadataResponse
- type StateModule
- func (sm *StateModule) Call(r *http.Request, req *StateCallRequest, res *StateCallResponse) error
- func (sm *StateModule) GetChildKeys(r *http.Request, req *StateChildStorageRequest, res *StateKeysResponse) error
- func (sm *StateModule) GetChildStorage(r *http.Request, req *StateChildStorageRequest, res *StateStorageDataResponse) error
- func (sm *StateModule) GetChildStorageHash(r *http.Request, req *StateChildStorageRequest, res *StateChildStorageResponse) error
- func (sm *StateModule) GetChildStorageSize(r *http.Request, req *StateChildStorageRequest, ...) error
- func (sm *StateModule) GetKeysPaged(r *http.Request, req *StateStorageKeyRequest, res *StateStorageKeysResponse) error
- func (sm *StateModule) GetMetadata(r *http.Request, req *StateRuntimeMetadataQuery, res *StateMetadataResponse) error
- func (sm *StateModule) GetPairs(r *http.Request, req *StatePairRequest, res *StatePairResponse) error
- func (sm *StateModule) GetRuntimeVersion(r *http.Request, req *StateRuntimeVersionRequest, ...) error
- func (sm *StateModule) GetStorage(r *http.Request, req *StateStorageRequest, res *StateStorageResponse) error
- func (sm *StateModule) GetStorageHash(r *http.Request, req *StateStorageHashRequest, res *StateStorageHashResponse) error
- func (sm *StateModule) GetStorageSize(r *http.Request, req *StateStorageSizeRequest, res *StateStorageSizeResponse) error
- func (sm *StateModule) QueryStorage(r *http.Request, req *StateStorageQueryRangeRequest, ...) error
- func (sm *StateModule) SubscribeRuntimeVersion(r *http.Request, req *StateStorageQueryRangeRequest, ...) error
- func (sm *StateModule) SubscribeStorage(r *http.Request, req *StateStorageQueryRangeRequest, ...) error
- type StatePairRequest
- type StatePairResponse
- type StateRuntimeMetadataQuery
- type StateRuntimeVersionRequest
- type StateRuntimeVersionResponse
- type StateStorageDataResponse
- type StateStorageHashRequest
- type StateStorageHashResponse
- type StateStorageKeyRequest
- type StateStorageKeysQuery
- type StateStorageKeysResponse
- type StateStorageQueryRangeRequest
- type StateStorageRequest
- type StateStorageResponse
- type StateStorageSizeRequest
- type StateStorageSizeResponse
- type StorageAPI
- type StorageChangeSetResponse
- type StorageKey
- type StringRequest
- type StringResponse
- type SystemAPI
- type SystemHealthResponse
- type SystemModule
- func (sm *SystemModule) AccountNextIndex(r *http.Request, req *StringRequest, res *U64Response) error
- func (sm *SystemModule) Chain(r *http.Request, req *EmptyRequest, res *string) error
- func (sm *SystemModule) ChainType(r *http.Request, req *EmptyRequest, res *string) error
- func (sm *SystemModule) Health(r *http.Request, req *EmptyRequest, res *SystemHealthResponse) error
- func (sm *SystemModule) Name(r *http.Request, req *EmptyRequest, res *string) error
- func (sm *SystemModule) NetworkState(r *http.Request, req *EmptyRequest, res *SystemNetworkStateResponse) error
- func (sm *SystemModule) NodeRoles(r *http.Request, req *EmptyRequest, res *[]interface{}) error
- func (sm *SystemModule) Peers(r *http.Request, req *EmptyRequest, res *SystemPeersResponse) error
- func (sm *SystemModule) Properties(r *http.Request, req *EmptyRequest, res *interface{}) error
- func (sm *SystemModule) Version(r *http.Request, req *EmptyRequest, res *string) error
- type SystemNetworkStateResponse
- type SystemPeersResponse
- type TransactionStateAPI
- type U64Response
Constants ¶
This section is empty.
Variables ¶
var ErrSubscriptionTransport = errors.New("subscriptions are not available on this transport")
ErrSubscriptionTransport error sent when trying to access websocket subscriptions via http
Functions ¶
func ConvertAPIs ¶ added in v0.3.2
ConvertAPIs runtime.APIItems to []interface
Types ¶
type AuthorModule ¶
type AuthorModule struct {
// contains filtered or unexported fields
}
AuthorModule holds a pointer to the API
func NewAuthorModule ¶
func NewAuthorModule(logger log.Logger, coreAPI CoreAPI, runtimeAPI RuntimeAPI, txStateAPI TransactionStateAPI) *AuthorModule
NewAuthorModule creates a new Author module.
func (*AuthorModule) HasKey ¶
HasKey Checks if the keystore has private keys for the given public key and key type.
func (*AuthorModule) InsertKey ¶
func (cm *AuthorModule) InsertKey(r *http.Request, req *KeyInsertRequest, res *KeyInsertResponse) error
InsertKey inserts a key into the keystore
func (*AuthorModule) PendingExtrinsics ¶
func (cm *AuthorModule) PendingExtrinsics(r *http.Request, req *EmptyRequest, res *PendingExtrinsicsResponse) error
PendingExtrinsics Returns all pending extrinsics
func (*AuthorModule) RemoveExtrinsic ¶
func (cm *AuthorModule) RemoveExtrinsic(r *http.Request, req *ExtrinsicOrHashRequest, res *RemoveExtrinsicsResponse) error
RemoveExtrinsic Remove given extrinsic from the pool and temporarily ban it to prevent reimporting
func (*AuthorModule) RotateKeys ¶
func (cm *AuthorModule) RotateKeys(r *http.Request, req *EmptyRequest, res *KeyRotateResponse) error
RotateKeys Generate new session keys and returns the corresponding public keys
func (*AuthorModule) SubmitAndWatchExtrinsic ¶
func (cm *AuthorModule) SubmitAndWatchExtrinsic(r *http.Request, req *Extrinsic, res *ExtrinsicStatus) error
SubmitAndWatchExtrinsic Submit and subscribe to watch an extrinsic until unsubscribed
func (*AuthorModule) SubmitExtrinsic ¶
func (cm *AuthorModule) SubmitExtrinsic(r *http.Request, req *Extrinsic, res *ExtrinsicHashResponse) error
SubmitExtrinsic Submit a fully formatted extrinsic for block inclusion
type BlockAPI ¶
type BlockAPI interface { GetHeader(hash common.Hash) (*types.Header, error) BestBlockHash() common.Hash GetBlockByHash(hash common.Hash) (*types.Block, error) GetBlockHash(blockNumber *big.Int) (*common.Hash, error) GetFinalizedHash(uint64, uint64) (common.Hash, error) HasJustification(hash common.Hash) (bool, error) GetJustification(hash common.Hash) ([]byte, error) RegisterImportedChannel(ch chan<- *types.Block) (byte, error) UnregisterImportedChannel(id byte) RegisterFinalizedChannel(ch chan<- *types.Header) (byte, error) UnregisterFinalizedChannel(id byte) SubChain(start, end common.Hash) ([]common.Hash, error) }
BlockAPI is the interface for the block state
type BlockProducerAPI ¶ added in v0.2.0
type BlockProducerAPI interface { Pause() error Resume() error EpochLength() uint64 SlotDuration() uint64 }
BlockProducerAPI is the interface for BlockProducer methods
type ChainBlock ¶
type ChainBlock struct { Header ChainBlockHeaderResponse `json:"header"` Body []string `json:"extrinsics"` }
ChainBlock struct to hold json instance of a block
type ChainBlockHeaderDigest ¶
type ChainBlockHeaderDigest struct {
Logs []string `json:"logs"`
}
ChainBlockHeaderDigest struct to hold digest logs
type ChainBlockHeaderResponse ¶
type ChainBlockHeaderResponse struct { ParentHash string `json:"parentHash"` Number string `json:"number"` StateRoot string `json:"stateRoot"` ExtrinsicsRoot string `json:"extrinsicsRoot"` Digest ChainBlockHeaderDigest `json:"digest"` }
ChainBlockHeaderResponse struct
func HeaderToJSON ¶
func HeaderToJSON(header types.Header) (ChainBlockHeaderResponse, error)
HeaderToJSON converts types.Header to ChainBlockHeaderResponse
type ChainBlockNumberRequest ¶
type ChainBlockNumberRequest struct {
Block interface{}
}
ChainBlockNumberRequest interface can accept string, float64 or []
type ChainBlockResponse ¶
type ChainBlockResponse struct {
Block ChainBlock `json:"block"`
}
ChainBlockResponse struct
type ChainFinalizedHeadRequest ¶ added in v0.3.0
ChainFinalizedHeadRequest ...
type ChainHashRequest ¶
ChainHashRequest Hash as a string
type ChainHashResponse ¶
type ChainHashResponse interface{}
ChainHashResponse interface to handle response
type ChainModule ¶
type ChainModule struct {
// contains filtered or unexported fields
}
ChainModule is an RPC module providing access to storage API points.
func NewChainModule ¶
func NewChainModule(api BlockAPI) *ChainModule
NewChainModule creates a new State module.
func (*ChainModule) GetBlock ¶
func (cm *ChainModule) GetBlock(r *http.Request, req *ChainHashRequest, res *ChainBlockResponse) error
GetBlock Get header and body of a relay chain block. If no block hash is provided,
the latest block body will be returned.
func (*ChainModule) GetBlockHash ¶
func (cm *ChainModule) GetBlockHash(r *http.Request, req *ChainBlockNumberRequest, res *ChainHashResponse) error
GetBlockHash Get hash of the 'n-th' block in the canon chain. If no parameters are provided,
the latest block hash gets returned.
func (*ChainModule) GetFinalizedHead ¶
func (cm *ChainModule) GetFinalizedHead(r *http.Request, req *EmptyRequest, res *ChainHashResponse) error
GetFinalizedHead returns the most recently finalized block hash
func (*ChainModule) GetFinalizedHeadByRound ¶ added in v0.2.0
func (cm *ChainModule) GetFinalizedHeadByRound(r *http.Request, req *ChainFinalizedHeadRequest, res *ChainHashResponse) error
GetFinalizedHeadByRound returns the hash of the block finalized at the given round and setID
func (*ChainModule) GetHead ¶
func (cm *ChainModule) GetHead(r *http.Request, req *ChainBlockNumberRequest, res *ChainHashResponse) error
GetHead alias for GetBlockHash
func (*ChainModule) GetHeader ¶
func (cm *ChainModule) GetHeader(r *http.Request, req *ChainHashRequest, res *ChainBlockHeaderResponse) error
GetHeader Get header of a relay chain block. If no block hash is provided, the latest block header will be returned.
func (*ChainModule) SubscribeFinalizedHeads ¶
func (cm *ChainModule) SubscribeFinalizedHeads(r *http.Request, req *EmptyRequest, res *ChainBlockHeaderResponse) error
SubscribeFinalizedHeads handled by websocket handler, but this func should remain
here so it's added to rpc_methods list
func (*ChainModule) SubscribeNewHead ¶
func (cm *ChainModule) SubscribeNewHead(r *http.Request, req *EmptyRequest, res *ChainBlockHeaderResponse) error
SubscribeNewHead handled by websocket handler, but this func should remain
here so it's added to rpc_methods list
func (*ChainModule) SubscribeNewHeads ¶
func (cm *ChainModule) SubscribeNewHeads(r *http.Request, req *EmptyRequest, res *ChainBlockHeaderResponse) error
SubscribeNewHeads handled by websocket handler, but this func should remain
here so it's added to rpc_methods list
type CoreAPI ¶
type CoreAPI interface { InsertKey(kp crypto.Keypair) HasKey(pubKeyStr string, keyType string) (bool, error) GetRuntimeVersion(bhash *common.Hash) (runtime.Version, error) IsBlockProducer() bool HandleSubmittedExtrinsic(types.Extrinsic) error GetMetadata(bhash *common.Hash) ([]byte, error) }
CoreAPI is the interface for the core methods
type DevModule ¶ added in v0.2.0
type DevModule struct {
// contains filtered or unexported fields
}
DevModule is an RPC module that provides developer endpoints
func NewDevModule ¶ added in v0.2.0
func NewDevModule(bp BlockProducerAPI, net NetworkAPI) *DevModule
NewDevModule creates a new Dev module.
func (*DevModule) EpochLength ¶ added in v0.3.0
EpochLength Dev RPC to return epoch length
func (*DevModule) SlotDuration ¶ added in v0.3.0
SlotDuration Dev RPC to return slot duration
type EmptyRequest ¶
type EmptyRequest struct{}
EmptyRequest represents an RPC request with no fields
type ExtrinsicHashResponse ¶
type ExtrinsicHashResponse string
ExtrinsicHashResponse is used as Extrinsic hash response
type ExtrinsicOrHash ¶
ExtrinsicOrHash is a type for Hash and Extrinsic array of bytes
type ExtrinsicOrHashRequest ¶
type ExtrinsicOrHashRequest []ExtrinsicOrHash
ExtrinsicOrHashRequest is a array of ExtrinsicOrHash
type ExtrinsicStatus ¶
type ExtrinsicStatus struct { IsFuture bool IsReady bool IsFinalized bool AsFinalized common.Hash IsUsurped bool AsUsurped common.Hash IsBroadcast bool AsBroadcast []string IsDropped bool IsInvalid bool }
ExtrinsicStatus holds the actual valid statuses
type GrandpaModule ¶ added in v0.3.0
type GrandpaModule struct {
// contains filtered or unexported fields
}
GrandpaModule init parameters
func NewGrandpaModule ¶ added in v0.3.0
func NewGrandpaModule(api BlockAPI) *GrandpaModule
NewGrandpaModule creates a new Grandpa rpc module.
func (*GrandpaModule) ProveFinality ¶ added in v0.3.0
func (gm *GrandpaModule) ProveFinality(r *http.Request, req *ProveFinalityRequest, res *ProveFinalityResponse) error
ProveFinality for the provided block range. Returns NULL if there are no known finalized blocks in the range. If no authorities set is provided, the current one will be attempted.
type KeyInsertRequest ¶
type KeyInsertRequest []string
KeyInsertRequest is used as model for the JSON
type KeyRotateResponse ¶
type KeyRotateResponse []byte
KeyRotateResponse is a byte array used to rotate
type MethodsResponse ¶
type MethodsResponse struct {
Methods []string `json:"methods"`
}
MethodsResponse struct representing methods
type NetworkAPI ¶
type NetworkAPI interface { Health() common.Health NetworkState() common.NetworkState Peers() []common.PeerInfo NodeRoles() byte Stop() error Start() error IsStopped() bool }
NetworkAPI interface for network state methods
type NetworkStateString ¶ added in v0.2.0
NetworkStateString Network State represented as string so JSON encode/decoding works
type PendingExtrinsicsResponse ¶
type PendingExtrinsicsResponse []string
PendingExtrinsicsResponse is a bi-dimensional array of bytes for allocating the pending extrisics
type ProveFinalityRequest ¶ added in v0.3.0
type ProveFinalityRequest struct {
// contains filtered or unexported fields
}
ProveFinalityRequest request struct
type ProveFinalityResponse ¶ added in v0.3.0
type ProveFinalityResponse [][]byte
ProveFinalityResponse is an optional SCALE encoded proof array
type RPCModule ¶
type RPCModule struct {
// contains filtered or unexported fields
}
RPCModule is a RPC module providing access to RPC methods
func NewRPCModule ¶
NewRPCModule creates a new RPC api module
func (*RPCModule) Methods ¶
func (rm *RPCModule) Methods(r *http.Request, req *EmptyRequest, res *MethodsResponse) error
Methods responds with list of methods available via RPC call
type RemoveExtrinsicsResponse ¶
RemoveExtrinsicsResponse is a array of hash used to Remove extrinsics
type RuntimeAPI ¶
type RuntimeAPI interface {
ValidateTransaction(e types.Extrinsic) (*transaction.Validity, error)
}
RuntimeAPI is the interface for runtime methods
type StateCallRequest ¶
type StateCallRequest struct { Method string `json:"method"` Data []byte `json:"data"` Block *common.Hash `json:"block"` }
StateCallRequest holds json fields
type StateChildStorageRequest ¶
type StateChildStorageRequest struct { ChildStorageKey []byte `json:"childStorageKey"` Key []byte `json:"key"` Block *common.Hash `json:"block"` }
StateChildStorageRequest holds json fields
type StateChildStorageResponse ¶ added in v0.3.0
type StateChildStorageResponse string
StateChildStorageResponse is a hash value
type StateChildStorageSizeResponse ¶ added in v0.3.0
type StateChildStorageSizeResponse uint64
StateChildStorageSizeResponse is a unint value
type StateKeysResponse ¶
type StateKeysResponse [][]byte
StateKeysResponse field to store the state keys
type StateMetadataResponse ¶
type StateMetadataResponse string
StateMetadataResponse holds the metadata TODO: Determine actual type
type StateModule ¶
type StateModule struct {
// contains filtered or unexported fields
}
StateModule is an RPC module providing access to storage API points.
func NewStateModule ¶
func NewStateModule(net NetworkAPI, storage StorageAPI, core CoreAPI) *StateModule
NewStateModule creates a new State module.
func (*StateModule) Call ¶
func (sm *StateModule) Call(r *http.Request, req *StateCallRequest, res *StateCallResponse) error
Call isn't implemented properly yet.
func (*StateModule) GetChildKeys ¶
func (sm *StateModule) GetChildKeys(r *http.Request, req *StateChildStorageRequest, res *StateKeysResponse) error
GetChildKeys isn't implemented properly yet.
func (*StateModule) GetChildStorage ¶
func (sm *StateModule) GetChildStorage(r *http.Request, req *StateChildStorageRequest, res *StateStorageDataResponse) error
GetChildStorage isn't implemented properly yet.
func (*StateModule) GetChildStorageHash ¶
func (sm *StateModule) GetChildStorageHash(r *http.Request, req *StateChildStorageRequest, res *StateChildStorageResponse) error
GetChildStorageHash isn't implemented properly yet.
func (*StateModule) GetChildStorageSize ¶
func (sm *StateModule) GetChildStorageSize(r *http.Request, req *StateChildStorageRequest, res *StateChildStorageSizeResponse) error
GetChildStorageSize isn't implemented properly yet.
func (*StateModule) GetKeysPaged ¶ added in v0.3.0
func (sm *StateModule) GetKeysPaged(r *http.Request, req *StateStorageKeyRequest, res *StateStorageKeysResponse) error
GetKeysPaged Returns the keys with prefix with pagination support.
func (*StateModule) GetMetadata ¶
func (sm *StateModule) GetMetadata(r *http.Request, req *StateRuntimeMetadataQuery, res *StateMetadataResponse) error
GetMetadata calls runtime Metadata_metadata function
func (*StateModule) GetPairs ¶
func (sm *StateModule) GetPairs(r *http.Request, req *StatePairRequest, res *StatePairResponse) error
GetPairs returns the keys with prefix, leave empty to get all the keys.
func (*StateModule) GetRuntimeVersion ¶
func (sm *StateModule) GetRuntimeVersion(r *http.Request, req *StateRuntimeVersionRequest, res *StateRuntimeVersionResponse) error
GetRuntimeVersion Get the runtime version at a given block.
If no block hash is provided, the latest version gets returned.
TODO currently only returns latest version, add functionality to lookup runtime by block hash (see issue #834)
func (*StateModule) GetStorage ¶
func (sm *StateModule) GetStorage(r *http.Request, req *StateStorageRequest, res *StateStorageResponse) error
GetStorage Returns a storage entry at a specific block's state. If not block hash is provided, the latest value is returned.
func (*StateModule) GetStorageHash ¶
func (sm *StateModule) GetStorageHash(r *http.Request, req *StateStorageHashRequest, res *StateStorageHashResponse) error
GetStorageHash returns the hash of a storage entry at a block's state.
If no block hash is provided, the latest value is returned. TODO implement change storage trie so that block hash parameter works (See issue #834)
func (*StateModule) GetStorageSize ¶
func (sm *StateModule) GetStorageSize(r *http.Request, req *StateStorageSizeRequest, res *StateStorageSizeResponse) error
GetStorageSize returns the size of a storage entry at a block's state.
If no block hash is provided, the latest value is used.
TODO implement change storage trie so that block hash parameter works (See issue #834)
func (*StateModule) QueryStorage ¶
func (sm *StateModule) QueryStorage(r *http.Request, req *StateStorageQueryRangeRequest, res *StorageChangeSetResponse) error
QueryStorage isn't implemented properly yet.
func (*StateModule) SubscribeRuntimeVersion ¶
func (sm *StateModule) SubscribeRuntimeVersion(r *http.Request, req *StateStorageQueryRangeRequest, res *StateRuntimeVersionResponse) error
SubscribeRuntimeVersion isn't implemented properly yet. TODO make this actually a subscription that pushes data
func (*StateModule) SubscribeStorage ¶
func (sm *StateModule) SubscribeStorage(r *http.Request, req *StateStorageQueryRangeRequest, res *StorageChangeSetResponse) error
SubscribeStorage Storage subscription. If storage keys are specified, it creates a message for each block which
changes the specified storage keys. If none are specified, then it creates a message for every block. This endpoint communicates over the Websocket protocol, but this func should remain here so it's added to rpc_methods list
type StatePairRequest ¶ added in v0.3.0
StatePairRequest holds json field
type StatePairResponse ¶ added in v0.3.0
type StatePairResponse []interface{}
StatePairResponse is a key values
type StateRuntimeMetadataQuery ¶
StateRuntimeMetadataQuery is a hash value
type StateRuntimeVersionRequest ¶ added in v0.3.0
StateRuntimeVersionRequest is hash value
type StateRuntimeVersionResponse ¶
type StateRuntimeVersionResponse struct { SpecName string `json:"specName"` ImplName string `json:"implName"` AuthoringVersion uint32 `json:"authoringVersion"` SpecVersion uint32 `json:"specVersion"` ImplVersion uint32 `json:"implVersion"` TransactionVersion uint32 `json:"transactionVersion"` Apis []interface{} `json:"apis"` }
StateRuntimeVersionResponse is the runtime version response
type StateStorageDataResponse ¶
type StateStorageDataResponse string
StateStorageDataResponse field to store data response
type StateStorageHashRequest ¶ added in v0.3.0
StateStorageHashRequest holds json field
type StateStorageHashResponse ¶
type StateStorageHashResponse string
StateStorageHashResponse is a hash value
type StateStorageKeyRequest ¶
type StateStorageKeyRequest struct { Prefix string `json:"prefix"` Qty uint32 `json:"qty"` AfterKey string `json:"afterKey"` Block *common.Hash `json:"block"` }
StateStorageKeyRequest holds json fields
type StateStorageKeysQuery ¶
type StateStorageKeysQuery [][]byte
StateStorageKeysQuery field to store storage keys
type StateStorageKeysResponse ¶
type StateStorageKeysResponse []string
StateStorageKeysResponse field for storage keys
type StateStorageQueryRangeRequest ¶
type StateStorageQueryRangeRequest struct { Keys []*common.Hash `json:"keys" validate:"required"` StartBlock *common.Hash `json:"startBlock" validate:"required"` Block *common.Hash `json:"block"` }
StateStorageQueryRangeRequest holds json fields
type StateStorageRequest ¶ added in v0.3.0
StateStorageRequest holds json field
type StateStorageResponse ¶ added in v0.3.0
type StateStorageResponse string
StateStorageResponse storage hash value
type StateStorageSizeRequest ¶ added in v0.3.0
StateStorageSizeRequest holds json field
type StateStorageSizeResponse ¶
type StateStorageSizeResponse uint64
StateStorageSizeResponse the default size for response
type StorageAPI ¶
type StorageAPI interface { GetStorage(root *common.Hash, key []byte) ([]byte, error) GetStorageByBlockHash(bhash common.Hash, key []byte) ([]byte, error) Entries(root *common.Hash) (map[string][]byte, error) RegisterStorageChangeChannel(sub state.StorageSubscription) (byte, error) UnregisterStorageChangeChannel(id byte) GetStateRootFromBlock(bhash *common.Hash) (*common.Hash, error) GetKeysWithPrefix(root *common.Hash, prefix []byte) ([][]byte, error) }
StorageAPI is the interface for the storage state
type StorageChangeSetResponse ¶
type StorageChangeSetResponse struct { Block *common.Hash Changes []KeyValueOption }
StorageChangeSetResponse is the struct that holds the block and changes
type StringRequest ¶ added in v0.3.0
type StringRequest struct {
String string
}
StringRequest holds string request
type SystemAPI ¶
type SystemAPI interface { SystemName() string SystemVersion() string Properties() map[string]interface{} ChainType() string ChainName() string }
SystemAPI is the interface for handling system methods
type SystemHealthResponse ¶
SystemHealthResponse struct to marshal json
type SystemModule ¶
type SystemModule struct {
// contains filtered or unexported fields
}
SystemModule is an RPC module providing access to core API points
func NewSystemModule ¶
func NewSystemModule(net NetworkAPI, sys SystemAPI, core CoreAPI, storage StorageAPI, txAPI TransactionStateAPI) *SystemModule
NewSystemModule creates a new API instance
func (*SystemModule) AccountNextIndex ¶ added in v0.3.0
func (sm *SystemModule) AccountNextIndex(r *http.Request, req *StringRequest, res *U64Response) error
AccountNextIndex Returns the next valid index (aka. nonce) for given account.
func (*SystemModule) Chain ¶
func (sm *SystemModule) Chain(r *http.Request, req *EmptyRequest, res *string) error
Chain returns the runtime chain
func (*SystemModule) ChainType ¶ added in v0.3.0
func (sm *SystemModule) ChainType(r *http.Request, req *EmptyRequest, res *string) error
ChainType returns the chain type
func (*SystemModule) Health ¶
func (sm *SystemModule) Health(r *http.Request, req *EmptyRequest, res *SystemHealthResponse) error
Health returns the information about the health of the network
func (*SystemModule) Name ¶
func (sm *SystemModule) Name(r *http.Request, req *EmptyRequest, res *string) error
Name returns the runtime name
func (*SystemModule) NetworkState ¶
func (sm *SystemModule) NetworkState(r *http.Request, req *EmptyRequest, res *SystemNetworkStateResponse) error
NetworkState returns the network state (basic information about the host)
func (*SystemModule) NodeRoles ¶
func (sm *SystemModule) NodeRoles(r *http.Request, req *EmptyRequest, res *[]interface{}) error
NodeRoles Returns the roles the node is running as.
func (*SystemModule) Peers ¶
func (sm *SystemModule) Peers(r *http.Request, req *EmptyRequest, res *SystemPeersResponse) error
Peers returns peer information for each connected and confirmed peer
func (*SystemModule) Properties ¶
func (sm *SystemModule) Properties(r *http.Request, req *EmptyRequest, res *interface{}) error
Properties returns the runtime properties
func (*SystemModule) Version ¶
func (sm *SystemModule) Version(r *http.Request, req *EmptyRequest, res *string) error
Version returns the runtime version
type SystemNetworkStateResponse ¶
type SystemNetworkStateResponse struct {
NetworkState NetworkStateString `json:"networkState"`
}
SystemNetworkStateResponse struct to marshal json
type SystemPeersResponse ¶
SystemPeersResponse struct to marshal json
type TransactionStateAPI ¶ added in v0.2.0
type TransactionStateAPI interface { AddToPool(*transaction.ValidTransaction) common.Hash Pop() *transaction.ValidTransaction Peek() *transaction.ValidTransaction Pending() []*transaction.ValidTransaction }
TransactionStateAPI ...