client

Documentation

Overview

Package client is a very limited Tezos RPC client library

Index

• Constants
• type BasicBlockInfo
• type BigUint
• type BlockHash
• type BlockHeaderInfo
• type BlockInfo
• type BlockProtocols
• type BlockRequest
• type BlockShellHeader
• type BootstrappedResponse
• type ChainID
• type Client
  • func (client *Client) BasicBlockInfo(ctx context.Context, chain string, blockID string) (*BasicBlockInfo, error)
  • func (client *Client) Block(ctx context.Context, r *BlockRequest) (BlockInfo, error)
  • func (client *Client) BlockHash(ctx context.Context, r *SimpleRequest) (*BlockHash, error)
  • func (client *Client) BlockHeader(ctx context.Context, r *BlockRequest) (BlockHeaderInfo, error)
  • func (client *Client) BlockProtocols(ctx context.Context, r *SimpleRequest) (*BlockProtocols, error)
  • func (client *Client) BlockShellHeader(ctx context.Context, r *SimpleRequest) (*BlockShellHeader, error)
  • func (client *Client) Constants(ctx context.Context, r *ContextRequest) (Constants, error)
  • func (client *Client) ContractBalance(ctx context.Context, r *ContractRequest) (BigUint, error)
  • func (client *Client) ContractBalanceAndFrozenBonds(ctx context.Context, r *ContractRequest) (BigUint, error)
  • func (client *Client) ContractCounter(ctx context.Context, r *ContractRequest) (BigUint, error)
  • func (client *Client) Heads(ctx context.Context, r *HeadsRequest) (<-chan *Head, <-chan error, error)
  • func (client *Client) InjectOperation(ctx context.Context, r *InjectOperationRequest) (*OperationHash, error)
  • func (client *Client) IsBootstrapped(ctx context.Context, r *ChainID) (*BootstrappedResponse, error)
  • func (client *Client) RunOperation(ctx context.Context, r *RunOperationRequest) (*OperationWithOptionalMetadata, error)
• type Constants
• type ContextRequest
• type ContractRequest
• type Error
• type Flag
• type Head
• type HeadsRequest
• type InjectOperationRequest
• type InjectRequestPayload
• type Logger
• type MetadataMode
• type OperationHash
• type OperationWithOptionalMetadata
• type RunOperationRequest
• type SimpleRequest
• type SyncState

Constants

const (
	SyncStateSynced   = utils.SyncStateSynced
	SyncStateUnsynced = utils.SyncStateUnsynced
	SyncStateStuck    = utils.SyncStateStuck
)

Types

type BasicBlockInfo

type BasicBlockInfo = block.BasicBlockInfo

type BigUint

type BigUint = tz.BigUint

type BlockHash

type BlockHash = tz.BlockHash

type BlockHeaderInfo

type BlockHeaderInfo = protocol.BlockHeaderInfo

type BlockInfo

type BlockInfo = protocol.BlockInfo

type BlockProtocols

type BlockProtocols = core.BlockProtocols

type BlockRequest

type BlockRequest = block.BlockRequest

type BlockShellHeader

type BlockShellHeader = core.ShellHeader

type BootstrappedResponse

type BootstrappedResponse = utils.BootstrappedResponse

type ChainID

type ChainID = tz.ChainID

type Client

type Client clientv2.Client

func (*Client) BasicBlockInfo

func (client *Client) BasicBlockInfo(ctx context.Context, chain string, blockID string) (*BasicBlockInfo, error)

BasicBlockInfo returns hash and protocol of the block (usually head) to be used for sequent requests

func (*Client) Block

func (client *Client) Block(ctx context.Context, r *BlockRequest) (BlockInfo, error)

func (*Client) BlockHash

func (client *Client) BlockHash(ctx context.Context, r *SimpleRequest) (*BlockHash, error)

func (*Client) BlockHeader

func (client *Client) BlockHeader(ctx context.Context, r *BlockRequest) (BlockHeaderInfo, error)

func (*Client) BlockProtocols

func (client *Client) BlockProtocols(ctx context.Context, r *SimpleRequest) (*BlockProtocols, error)

func (*Client) BlockShellHeader

func (client *Client) BlockShellHeader(ctx context.Context, r *SimpleRequest) (*BlockShellHeader, error)

func (*Client) Constants

func (client *Client) Constants(ctx context.Context, r *ContextRequest) (Constants, error)

func (*Client) ContractBalance

func (client *Client) ContractBalance(ctx context.Context, r *ContractRequest) (BigUint, error)

func (*Client) ContractBalanceAndFrozenBonds

func (client *Client) ContractBalanceAndFrozenBonds(ctx context.Context, r *ContractRequest) (BigUint, error)

func (*Client) ContractCounter

func (client *Client) ContractCounter(ctx context.Context, r *ContractRequest) (BigUint, error)

func (*Client) Heads

func (client *Client) Heads(ctx context.Context, r *HeadsRequest) (<-chan *Head, <-chan error, error)

func (*Client) InjectOperation

func (client *Client) InjectOperation(ctx context.Context, r *InjectOperationRequest) (*OperationHash, error)

func (*Client) IsBootstrapped

func (client *Client) IsBootstrapped(ctx context.Context, r *ChainID) (*BootstrappedResponse, error)

func (*Client) RunOperation

func (client *Client) RunOperation(ctx context.Context, r *RunOperationRequest) (*OperationWithOptionalMetadata, error)

type Constants

type Constants = core.Constants

type ContextRequest

type ContextRequest = block.ContextRequest

type ContractRequest

type ContractRequest = block.ContractRequest

type Error

type Error = clientv2.Error

type Flag

type Flag = clientv2.Flag

type Head

type Head = monitor.Head

type HeadsRequest

type HeadsRequest = monitor.HeadsRequest

type InjectOperationRequest

type InjectOperationRequest = utils.InjectOperationRequest

type InjectRequestPayload

type InjectRequestPayload = utils.InjectRequestPayload

type Logger

type Logger = clientv2.Logger

type MetadataMode

type MetadataMode = block.MetadataMode

type OperationHash

type OperationHash = tz.OperationHash

type OperationWithOptionalMetadata

type OperationWithOptionalMetadata = latest.OperationWithOptionalMetadata

type RunOperationRequest

type RunOperationRequest = block.RunOperationRequest

type SimpleRequest

type SimpleRequest = block.SimpleRequest

type SyncState

type SyncState = utils.SyncState