github.com/diadata-org/diadata@v1.4.593/pkg/dia/helpers/substrate-helper/gsrpc/rpc/chain/chain.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 Chain --filename chain.go
    18  
    19  package chain
    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  	"github.com/diadata-org/diadata/pkg/dia/helpers/substrate-helper/gsrpc/types/block"
    25  )
    26  
    27  //go:generate mockery --name Chain --filename chain.go
    28  
    29  type Chain interface {
    30  	SubscribeFinalizedHeads() (*FinalizedHeadsSubscription, error)
    31  	SubscribeNewHeads() (*NewHeadsSubscription, error)
    32  	GetBlockHash(blockNumber uint64) (types.Hash, error)
    33  	GetBlockHashLatest() (types.Hash, error)
    34  	GetFinalizedHead() (types.Hash, error)
    35  	GetBlock(blockHash types.Hash) (*block.SignedBlock, error)
    36  	GetBlockLatest() (*block.SignedBlock, error)
    37  	GetHeader(blockHash types.Hash) (*types.Header, error)
    38  	GetHeaderLatest() (*types.Header, error)
    39  }
    40  
    41  // chain exposes methods for retrieval of chain data
    42  type chain struct {
    43  	client client.Client
    44  }
    45  
    46  // NewChain creates a new chain struct
    47  func NewChain(cl client.Client) Chain {
    48  	return &chain{cl}
    49  }