github.com/diadata-org/diadata@v1.4.593/pkg/dia/helpers/substrate-helper/gsrpc/rpc/state/state.go (about)

     1  // Go Substrate RPC Client (GSRPC) provides APIs and types around Polkadot and any Substrate-based chain RPC calls
     2  //
     3  // Copyright 2019 Centrifuge GmbH
     4  //
     5  // Licensed under the Apache License, Version 2.0 (the "License");
     6  // you may not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  //     http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing, software
    12  // distributed under the License is distributed on an "AS IS" BASIS,
    13  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  // See the License for the specific language governing permissions and
    15  // limitations under the License.
    16  
    17  //go:generate mockery --name State --filename state.go
    18  
    19  package state
    20  
    21  import (
    22  	"github.com/diadata-org/diadata/pkg/dia/helpers/substrate-helper/gsrpc/client"
    23  	"github.com/diadata-org/diadata/pkg/dia/helpers/substrate-helper/gsrpc/types"
    24  )
    25  
    26  type State interface {
    27  	GetStorage(key types.StorageKey, target interface{}, blockHash types.Hash) (ok bool, err error)
    28  	GetStorageLatest(key types.StorageKey, target interface{}) (ok bool, err error)
    29  	GetStorageRaw(key types.StorageKey, blockHash types.Hash) (*types.StorageDataRaw, error)
    30  	GetStorageRawLatest(key types.StorageKey) (*types.StorageDataRaw, error)
    31  
    32  	GetChildStorageSize(childStorageKey, key types.StorageKey, blockHash types.Hash) (types.U64, error)
    33  	GetChildStorageSizeLatest(childStorageKey, key types.StorageKey) (types.U64, error)
    34  	GetChildStorage(childStorageKey, key types.StorageKey, target interface{}, blockHash types.Hash) (ok bool, err error)
    35  	GetChildStorageLatest(childStorageKey, key types.StorageKey, target interface{}) (ok bool, err error)
    36  	GetChildStorageRaw(childStorageKey, key types.StorageKey, blockHash types.Hash) (*types.StorageDataRaw, error)
    37  	GetChildStorageRawLatest(childStorageKey, key types.StorageKey) (*types.StorageDataRaw, error)
    38  
    39  	GetMetadata(blockHash types.Hash) (*types.Metadata, error)
    40  	GetMetadataLatest() (*types.Metadata, error)
    41  
    42  	GetStorageHash(key types.StorageKey, blockHash types.Hash) (types.Hash, error)
    43  	GetStorageHashLatest(key types.StorageKey) (types.Hash, error)
    44  
    45  	SubscribeStorageRaw(keys []types.StorageKey) (*StorageSubscription, error)
    46  
    47  	GetRuntimeVersion(blockHash types.Hash) (*types.RuntimeVersion, error)
    48  	GetRuntimeVersionLatest() (*types.RuntimeVersion, error)
    49  
    50  	GetChildKeys(childStorageKey, prefix types.StorageKey, blockHash types.Hash) ([]types.StorageKey, error)
    51  	GetChildKeysLatest(childStorageKey, prefix types.StorageKey) ([]types.StorageKey, error)
    52  
    53  	SubscribeRuntimeVersion() (*RuntimeVersionSubscription, error)
    54  
    55  	QueryStorage(keys []types.StorageKey, startBlock types.Hash, block types.Hash) ([]types.StorageChangeSet, error)
    56  	QueryStorageLatest(keys []types.StorageKey, startBlock types.Hash) ([]types.StorageChangeSet, error)
    57  
    58  	QueryStorageAt(keys []types.StorageKey, block types.Hash) ([]types.StorageChangeSet, error)
    59  	QueryStorageAtLatest(keys []types.StorageKey) ([]types.StorageChangeSet, error)
    60  
    61  	GetKeys(prefix types.StorageKey, blockHash types.Hash) ([]types.StorageKey, error)
    62  	GetKeysLatest(prefix types.StorageKey) ([]types.StorageKey, error)
    63  
    64  	GetStorageSize(key types.StorageKey, blockHash types.Hash) (types.U64, error)
    65  	GetStorageSizeLatest(key types.StorageKey) (types.U64, error)
    66  
    67  	GetChildStorageHash(childStorageKey, key types.StorageKey, blockHash types.Hash) (types.Hash, error)
    68  	GetChildStorageHashLatest(childStorageKey, key types.StorageKey) (types.Hash, error)
    69  }
    70  
    71  // state exposes methods for querying state
    72  type state struct {
    73  	client client.Client
    74  }
    75  
    76  // NewState creates a new state struct
    77  func NewState(c client.Client) State {
    78  	return &state{client: c}
    79  }