modules

package

Go to main page

Versions in this module

v0

v0.9.0

Mar 1, 2024

v0.8.0

Dec 11, 2023

Changes in this version

+ func NewMockAnyAPI(ctrl *gomock.Controller) *modulesmocks.MockCoreAPI

+ func NewMockAnyBlockAPI(ctrl *gomock.Controller) *modulesmocks.MockBlockAPI

+ func NewMockAnyStorageAPI(ctrl *gomock.Controller) *modulesmocks.MockStorageAPI

type BlockAPI

+ RangeInMemory func(start, end common.Hash) ([]common.Hash, error)

+ type Infoer interface

+ Info func(s string)

type StateCallRequest

+ Params string

type StateModule

+ func (sm *StateModule) QueryStorageAt(_ *http.Request, request *StateStorageQueryAtRequest, ...) error

+ func (sm *StateModule) Trie(_ *http.Request, req *StateTrieAtRequest, res *StateTrieResponse) error

+ type StateStorageQueryAtRequest struct

+ At common.Hash

+ Keys []string

+ type StateTrieAtRequest struct

+ At *common.Hash

+ type StateTrieResponse []string

+ type Telemetry interface

+ SendMessage func(msg json.Marshaler)

v0.7.0

Nov 23, 2022

Changes in this version

+ var AliasesMethods = map[string]string

+ var ErrProvidedKeyDoesNotMatch = errors.New("generated public key does not equal provided public key")

+ var ErrStartBlockHashEmpty = errors.New("the start block hash cannot be an empty value")

+ var UnsafeMethods = []string

+ func IsUnsafe(name string) bool

+ func NewMockCoreAPI(t *testing.T) *modulesmocks.CoreAPI

+ func NewMockTransactionStateAPI(t *testing.T) *modulesmocks.TransactionStateAPI

+ func NewMockeryBlockAPI(t *testing.T) *modulesmocks.BlockAPI

+ func NewMockeryStorageAPI(t *testing.T) *modulesmocks.StorageAPI

type AuthorModule

+ func (am *AuthorModule) HasSessionKeys(r *http.Request, req *HasSessionKeyRequest, res *HasSessionKeyResponse) error

type BlockAPI

+ FreeFinalisedNotifierChannel func(ch chan *types.FinalisationInfo)

+ FreeImportedBlockNotifierChannel func(ch chan *types.Block)

+ GetFinalisedHash func(uint64, uint64) (common.Hash, error)

+ GetFinalisedNotifierChannel func() chan *types.FinalisationInfo

+ GetHashByNumber func(blockNumber uint) (common.Hash, error)

+ GetHighestFinalisedHash func() (common.Hash, error)

+ GetImportedBlockNotifierChannel func() chan *types.Block

+ GetRuntime func(blockHash common.Hash) (instance runtime.Instance, err error)

+ RegisterRuntimeUpdatedChannel func(ch chan<- runtime.Version) (uint32, error)

+ UnregisterRuntimeUpdatedChannel func(id uint32) bool

+ type BlockFinalityAPI interface

+ GetRound func() uint64

+ GetSetID func() uint64

+ GetVoters func() grandpa.Voters

+ PreCommits func() []ed25519.PublicKeyBytes

+ PreVotes func() []ed25519.PublicKeyBytes

+ type ChildStateModule struct

+ func NewChildStateModule(s StorageAPI, b BlockAPI) *ChildStateModule

+ func (cs *ChildStateModule) GetKeys(_ *http.Request, req *GetKeysRequest, res *[]string) error

+ func (cs *ChildStateModule) GetStorage(_ *http.Request, req *ChildStateStorageRequest, res *StateStorageResponse) error

+ func (cs *ChildStateModule) GetStorageHash(_ *http.Request, req *GetStorageHash, res *string) error

+ func (cs *ChildStateModule) GetStorageSize(_ *http.Request, req *GetChildStorageRequest, res *uint64) error

+ type ChildStateStorageRequest struct

+ ChildStorageKey []byte

+ Hash *common.Hash

+ Key []byte

type CoreAPI

+ DecodeSessionKeys func(enc []byte) ([]byte, error)

+ GetReadProofAt func(block common.Hash, keys [][]byte) (common.Hash, [][]byte, error)

+ type GenSyncSpecRequest struct

+ Raw bool

+ type GetChildStorageRequest struct

+ EntryKey []byte

+ Hash *common.Hash

+ KeyChild []byte

+ type GetKeysRequest struct

+ Hash *common.Hash

+ Key []byte

+ Prefix []byte

+ type GetStorageHash struct

+ EntryKey []byte

+ Hash *common.Hash

+ KeyChild []byte

type GrandpaModule

+ func (gm *GrandpaModule) RoundState(r *http.Request, req *EmptyRequest, res *RoundStateResponse) error

+ type HasSessionKeyRequest struct

+ PublicKeys string

+ type HasSessionKeyResponse bool

type KeyInsertRequest

+ PublicKey string

+ Seed string

+ Type string

type NetworkAPI

+ AddReservedPeers func(addrs ...string) error

+ RemoveReservedPeers func(addrs ...string) error

+ StartingBlock func() int64

+ type OffchainLocalStorageGet struct

+ Key string

+ Kind string

+ type OffchainLocalStorageSet struct

+ Key string

+ Kind string

+ Value string

+ type OffchainModule struct

+ func NewOffchainModule(ns RuntimeStorageAPI) *OffchainModule

+ func (s *OffchainModule) LocalStorageGet(_ *http.Request, req *OffchainLocalStorageGet, res *StringResponse) error

+ func (s *OffchainModule) LocalStorageSet(_ *http.Request, req *OffchainLocalStorageSet, _ *StringResponse) error

+ type PaymentModule struct

+ func NewPaymentModule(blockAPI BlockAPI) *PaymentModule

+ func (p *PaymentModule) QueryInfo(_ *http.Request, req *PaymentQueryInfoRequest, res *PaymentQueryInfoResponse) error

+ type PaymentQueryInfoRequest struct

+ Ext string

+ Hash *common.Hash

+ type PaymentQueryInfoResponse struct

+ Class int

+ PartialFee string

+ Weight uint64

type ProveFinalityRequest

+ BlockNumber uint32

+ type RoundState struct

+ Precommits Votes

+ Prevotes Votes

+ Round uint32

+ ThresholdWeight uint32

+ TotalWeight uint32

+ type RoundStateResponse struct

+ Background []RoundState

+ Best RoundState

+ SetID uint32

+ type RuntimeStorageAPI interface

+ GetLocal func(k []byte) ([]byte, error)

+ GetPersistent func(k []byte) ([]byte, error)

+ SetLocal func(k, v []byte) error

+ SetPersistent func(k, v []byte) error

+ type StateGetReadProofRequest struct

+ Hash common.Hash

+ Keys []string

+ type StateGetReadProofResponse struct

+ At common.Hash

+ Proof []string

type StateModule

+ func (sm *StateModule) GetReadProof(_ *http.Request, req *StateGetReadProofRequest, res *StateGetReadProofResponse) error

type StateRuntimeVersionResponse

+ func NewStateRuntimeVersionResponse(runtimeVersion runtime.Version) (response StateRuntimeVersionResponse)

type StateStorageQueryRangeRequest

+ EndBlock common.Hash

type StorageAPI

+ GetStorageChild func(root *common.Hash, keyToChild []byte) (*trie.Trie, error)

+ GetStorageFromChild func(root *common.Hash, keyToChild, key []byte) ([]byte, error)

+ RegisterStorageObserver func(observer state.Observer)

+ UnregisterStorageObserver func(observer state.Observer)

+ type SyncAPI interface

+ HighestBlock func() uint

+ type SyncStateAPI interface

+ GenSyncSpec func(raw bool) (*genesis.Genesis, error)

+ func NewStateSync(gData *genesis.Data, storageAPI StorageAPI) (SyncStateAPI, error)

+ type SyncStateModule struct

+ func NewSyncStateModule(syncStateAPI SyncStateAPI) *SyncStateModule

+ func (ss *SyncStateModule) GenSyncSpec(_ *http.Request, req *GenSyncSpecRequest, res *genesis.Genesis) error

+ type SyncStateResponse struct

+ CurrentBlock uint32

+ HighestBlock uint32

+ StartingBlock uint32

type SystemModule

+ func (sm *SystemModule) AddReservedPeer(r *http.Request, req *StringRequest, res *[]byte) error

+ func (sm *SystemModule) LocalListenAddresses(r *http.Request, req *EmptyRequest, res *[]string) error

+ func (sm *SystemModule) LocalPeerId(r *http.Request, req *EmptyRequest, res *string) error

+ func (sm *SystemModule) RemoveReservedPeer(r *http.Request, req *StringRequest, res *[]byte) error

+ func (sm *SystemModule) SyncState(r *http.Request, req *EmptyRequest, res *SyncStateResponse) error

type TransactionStateAPI

+ FreeStatusNotifierChannel func(ch chan transaction.Status)

+ GetStatusNotifierChannel func(ext types.Extrinsic) chan transaction.Status

+ type Votes struct

+ CurrentWeight uint32

+ Missing []string

v0.6.0

Apr 8, 2021

v0.5.2

Apr 7, 2021

v0.5.1

Apr 7, 2021

v0.5.0

Apr 7, 2021

v0.4.1

Apr 14, 2021

Changes in this version

type SystemAPI

+ ChainName func() string

v0.4.0

Apr 6, 2021

v0.3.2

Mar 22, 2021

Changes in this version

+ func ConvertAPIs(in []*runtime.APIItem) []interface

v0.3.1

Mar 8, 2021

v0.3.0

Feb 25, 2021

Changes in this version

type BlockAPI

+ GetJustification func(hash common.Hash) ([]byte, error)

+ HasJustification func(hash common.Hash) (bool, error)

+ SubChain func(start, end common.Hash) ([]common.Hash, error)

type BlockProducerAPI

+ EpochLength func() uint64

+ SlotDuration func() uint64

type ChainBlockNumberRequest

+ Block interface{}

+ type ChainFinalizedHeadRequest struct

+ Round uint64

+ SetID uint64

type ChainHashRequest

+ Bhash *common.Hash

type DevModule

+ func (m *DevModule) EpochLength(r *http.Request, req *EmptyRequest, res *string) error

+ func (m *DevModule) SlotDuration(r *http.Request, req *EmptyRequest, res *string) error

type Extrinsic

+ Data string

+ type GrandpaModule struct

+ func NewGrandpaModule(api BlockAPI) *GrandpaModule

+ func (gm *GrandpaModule) ProveFinality(r *http.Request, req *ProveFinalityRequest, res *ProveFinalityResponse) error

+ type ProveFinalityRequest struct

+ type ProveFinalityResponse [][]byte

+ type StateChildStorageResponse string

+ type StateChildStorageSizeResponse uint64

type StateModule

+ func (sm *StateModule) GetKeysPaged(r *http.Request, req *StateStorageKeyRequest, res *StateStorageKeysResponse) error

+ type StatePairRequest struct

+ Bhash *common.Hash

+ Prefix *string

+ type StatePairResponse []interface

type StateRuntimeMetadataQuery

+ Bhash *common.Hash

+ type StateRuntimeVersionRequest struct

+ Bhash *common.Hash

type StateRuntimeVersionResponse

+ TransactionVersion uint32

+ type StateStorageHashRequest struct

+ Bhash *common.Hash

+ Key string

type StateStorageKeyRequest

+ AfterKey string

+ Prefix string

+ Qty uint32

+ type StateStorageRequest struct

+ Bhash *common.Hash

+ Key string

+ type StateStorageResponse string

+ type StateStorageSizeRequest struct

+ Bhash *common.Hash

+ Key string

type StorageAPI

+ GetKeysWithPrefix func(root *common.Hash, prefix []byte) ([][]byte, error)

+ GetStateRootFromBlock func(bhash *common.Hash) (*common.Hash, error)

+ type StringRequest struct

+ String string

type SystemAPI

+ ChainType func() string

type SystemModule

+ func (sm *SystemModule) AccountNextIndex(r *http.Request, req *StringRequest, res *U64Response) error

+ func (sm *SystemModule) ChainType(r *http.Request, req *EmptyRequest, res *string) error

+ type U64Response uint64

v0.2.0

Nov 10, 2020

Changes in this version

+ var ErrSubscriptionTransport = errors.New("subscriptions are not available on this transport")

type BlockAPI

+ BestBlockHash func() common.Hash

+ GetFinalizedHash func(uint64, uint64) (common.Hash, error)

+ RegisterFinalizedChannel func(ch chan<- *types.Header) (byte, error)

+ RegisterImportedChannel func(ch chan<- *types.Block) (byte, error)

+ UnregisterFinalizedChannel func(id byte)

+ UnregisterImportedChannel func(id byte)

+ type BlockProducerAPI interface

+ Pause func() error

+ Resume func() error

+ SetAuthorities func(data []*types.Authority) error

+ SetRandomness func([types.RandomnessLength]byte)

+ SetThreshold func(*big.Int)

+ type ChainIntRequest uint64

type ChainModule

+ func (cm *ChainModule) GetFinalizedHeadByRound(r *http.Request, req *[]ChainIntRequest, res *ChainHashResponse) error

type CoreAPI

+ IsBlockProducer func() bool

+ type DevModule struct

+ func NewDevModule(bp BlockProducerAPI, net NetworkAPI) *DevModule

+ func (m *DevModule) Control(r *http.Request, req *[]string, res *string) error

+ func (m *DevModule) SetBABEEpochThreshold(r *http.Request, req *string, res *string) error

+ func (m *DevModule) SetBABERandomness(r *http.Request, req *[]string, res *string) error

+ func (m *DevModule) SetBlockProducerAuthorities(r *http.Request, req *[]interface{}, res *string) error

type NetworkAPI

+ IsStopped func() bool

+ Start func() error

+ Stop func() error

+ type NetworkStateString struct

+ Multiaddrs []string

+ PeerID string

type StorageAPI

+ GetStorageByBlockHash func(bhash common.Hash, key []byte) ([]byte, error)

+ RegisterStorageChangeChannel func(ch chan<- *state.KeyValue) (byte, error)

+ UnregisterStorageChangeChannel func(id byte)

+ type TransactionStateAPI interface

+ AddToPool func(*transaction.ValidTransaction) common.Hash

+ Peek func() *transaction.ValidTransaction

+ Pending func() []*transaction.ValidTransaction

+ Pop func() *transaction.ValidTransaction

v0.1.0

May 27, 2020

Changes in this version

+ type AuthorModule struct

+ func NewAuthorModule(coreAPI CoreAPI, runtimeAPI RuntimeAPI, txQueueAPI TransactionQueueAPI) *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 interface

+ GetBlockByHash func(hash common.Hash) (*types.Block, error)

+ GetBlockHash func(blockNumber *big.Int) (*common.Hash, error)

+ GetHeader func(hash common.Hash) (*types.Header, error)

+ HighestBlockHash func() common.Hash

+ SetBlockAddedChannel func(chan<- *types.Block, <-chan struct{})

+ type ChainBlock struct

+ Body []string

+ Header ChainBlockHeaderResponse

+ type ChainBlockHeaderDigest struct

+ Logs []string

+ type ChainBlockHeaderResponse struct

+ Digest ChainBlockHeaderDigest

+ ExtrinsicsRoot string

+ Number string

+ ParentHash string

+ StateRoot string

+ func HeaderToJSON(header types.Header) ChainBlockHeaderResponse

+ type ChainBlockNumberRequest interface

+ type ChainBlockResponse struct

+ Block ChainBlock

+ type ChainHashRequest string

+ type ChainHashResponse interface

+ type ChainModule struct

+ func NewChainModule(api BlockAPI) *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)

+ 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 interface

+ GetMetadata func() ([]byte, error)

+ GetRuntimeVersion func() (*runtime.VersionAPI, error)

+ HandleSubmittedExtrinsic func(types.Extrinsic) error

+ HasKey func(pubKeyStr string, keyType string) (bool, error)

+ InsertKey func(kp crypto.Keypair)

+ IsBabeAuthority func() bool

+ type EmptyRequest struct

+ type Extrinsic string

+ type ExtrinsicHashResponse string

+ type ExtrinsicOrHash struct

+ Extrinsic []byte

+ Hash common.Hash

+ type ExtrinsicOrHashRequest []ExtrinsicOrHash

+ type ExtrinsicStatus struct

+ AsBroadcast []string

+ AsFinalized common.Hash

+ AsUsurped common.Hash

+ IsBroadcast bool

+ IsDropped bool

+ IsFinalized bool

+ IsFuture bool

+ IsInvalid bool

+ IsReady bool

+ IsUsurped bool

+ type KeyInsertRequest []string

+ type KeyInsertResponse []byte

+ type KeyRotateResponse []byte

+ type KeyValueOption struct

+ StorageData []byte

+ StorageKey []byte

+ type MethodsResponse struct

+ Methods []string

+ type NetworkAPI interface

+ Health func() common.Health

+ NetworkState func() common.NetworkState

+ NodeRoles func() byte

+ Peers func() []common.PeerInfo

+ type PendingExtrinsicsResponse [][]byte

+ type RPCAPI interface

+ BuildMethodNames func(rcvr interface{}, name string)

+ Methods func() []string

+ type RPCModule struct

+ func NewRPCModule(rpcapi RPCAPI) *RPCModule

+ func (rm *RPCModule) Methods(r *http.Request, req *EmptyRequest, res *MethodsResponse) error

+ type RemoveExtrinsicsResponse []common.Hash

+ type RuntimeAPI interface

+ ValidateTransaction func(e types.Extrinsic) (*transaction.Validity, error)

+ type StateBlockHashQuery common.Hash

+ type StateCallRequest struct

+ Block common.Hash

+ Data []byte

+ Method string

+ type StateCallResponse struct

+ StateCallResponse []byte

+ type StateChildStorageRequest struct

+ Block common.Hash

+ ChildStorageKey []byte

+ Key []byte

+ type StateKeysResponse [][]byte

+ type StateMetadataResponse string

+ type StateModule struct

+ func NewStateModule(net NetworkAPI, storage StorageAPI, core CoreAPI) *StateModule

+ func (sm *StateModule) Call(r *http.Request, req *StateCallRequest, res *StateCallResponse)

+ func (sm *StateModule) GetChildKeys(r *http.Request, req *StateChildStorageRequest, res *StateKeysResponse)

+ func (sm *StateModule) GetChildStorage(r *http.Request, req *StateChildStorageRequest, res *StateStorageDataResponse)

+ func (sm *StateModule) GetChildStorageHash(r *http.Request, req *StateChildStorageRequest, res *StateStorageHashResponse)

+ func (sm *StateModule) GetChildStorageSize(r *http.Request, req *StateChildStorageRequest, res *StateStorageSizeResponse)

+ func (sm *StateModule) GetKeys(r *http.Request, req *StateStorageKeyRequest, res *StateStorageKeysResponse)

+ func (sm *StateModule) GetMetadata(r *http.Request, req *StateRuntimeMetadataQuery, res *string) error

+ func (sm *StateModule) GetPairs(r *http.Request, req *[]string, res *[]interface{}) error

+ func (sm *StateModule) GetRuntimeVersion(r *http.Request, req *StateBlockHashQuery, res *StateRuntimeVersionResponse) error

+ func (sm *StateModule) GetStorage(r *http.Request, req *[]string, res *interface{}) error

+ func (sm *StateModule) GetStorageHash(r *http.Request, req *[]string, res *interface{}) error

+ func (sm *StateModule) GetStorageSize(r *http.Request, req *[]string, res *interface{}) error

+ func (sm *StateModule) QueryStorage(r *http.Request, req *StateStorageQueryRangeRequest, ...)

+ func (sm *StateModule) SubscribeRuntimeVersion(r *http.Request, req *StateStorageQueryRangeRequest, ...) error

+ func (sm *StateModule) SubscribeStorage(r *http.Request, req *StateStorageQueryRangeRequest, ...)

+ type StateRuntimeMetadataQuery common.Hash

+ type StateRuntimeVersionResponse struct

+ Apis []interface{}

+ AuthoringVersion int32

+ ImplName string

+ ImplVersion int32

+ SpecName string

+ SpecVersion int32

+ type StateStorageDataResponse string

+ type StateStorageHashResponse common.Hash

+ type StateStorageKeyRequest struct

+ Block common.Hash

+ Key []byte

+ type StateStorageKeysQuery [][]byte

+ type StateStorageKeysResponse [][]byte

+ type StateStorageQueryRangeRequest struct

+ Block common.Hash

+ Keys []byte

+ StartBlock common.Hash

+ type StateStorageSizeResponse uint64

+ type StorageAPI interface

+ Entries func() map[string][]byte

+ GetStorage func(key []byte) ([]byte, error)

+ type StorageChangeSetResponse struct

+ Block common.Hash

+ Changes []KeyValueOption

+ type StorageKey []byte

+ type StringResponse string

+ type SystemAPI interface

+ NodeName func() string

+ Properties func() map[string]interface{}

+ SystemName func() string

+ SystemVersion func() string

+ type SystemHealthResponse struct

+ Health common.Health

+ type SystemModule struct

+ func NewSystemModule(net NetworkAPI, sys SystemAPI) *SystemModule

+ func (sm *SystemModule) Chain(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 struct

+ NetworkState common.NetworkState

+ type SystemPeersResponse struct

+ Peers []common.PeerInfo

+ type TransactionQueueAPI interface

+ Peek func() *transaction.ValidTransaction

+ Pending func() []*transaction.ValidTransaction

+ Pop func() *transaction.ValidTransaction

+ Push func(*transaction.ValidTransaction) (common.Hash, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL