provider

Documentation

Index

• type ChainProvider
• type ChainQuery
• type CommonConfig
  • func (c *CommonConfig) Enabled() bool
  • func (pc *CommonConfig) GetWallet() string
  • func (pc *CommonConfig) SetWallet(addr string)
  • func (pc *CommonConfig) Validate() error
• type Config

Types

type ChainProvider

type ChainProvider interface {
	ChainQuery
	NID() string
	Name() string
	Init(context.Context, string, kms.KMS) error
	Type() string
	Config() Config
	Listener(ctx context.Context, lastSavedHeight uint64, blockInfo chan *types.BlockInfo) error
	Route(ctx context.Context, message *types.Message, callback types.TxResponseFunc) error
	ShouldReceiveMessage(ctx context.Context, message *types.Message) (bool, error)
	ShouldSendMessage(ctx context.Context, message *types.Message) (bool, error)
	SetLastSavedHeightFunc(func() uint64)
	MessageReceived(ctx context.Context, key *types.MessageKey) (bool, error)
	SetAdmin(context.Context, string) error

	FinalityBlock(ctx context.Context) uint64
	GenerateMessages(ctx context.Context, messageKey *types.MessageKeyWithMessageHeight) ([]*types.Message, error)
	QueryBalance(ctx context.Context, addr string) (*types.Coin, error)

	NewKeystore(string) (string, error)
	RestoreKeystore(context.Context) error
	ImportKeystore(context.Context, string, string) (string, error)
	RevertMessage(context.Context, *big.Int) error
	GetFee(context.Context, string, bool) (uint64, error)
	SetFee(context.Context, string, *big.Int, *big.Int) error
	ClaimFee(context.Context) error
}

type ChainQuery

type ChainQuery interface {
	QueryLatestHeight(ctx context.Context) (uint64, error)
	QueryTransactionReceipt(ctx context.Context, txHash string) (*types.Receipt, error)
}

type CommonConfig

type CommonConfig struct {
	ChainName     string                  `json:"-" yaml:"-"`
	ChainID       string                  `json:"chain-id" yaml:"chain-id"`
	RPCUrl        string                  `json:"rpc-url" yaml:"rpc-url"`
	StartHeight   uint64                  `json:"start-height" yaml:"start-height"`
	Address       string                  `json:"address" yaml:"address"`
	Contracts     types.ContractConfigMap `json:"contracts" yaml:"contracts"`
	FinalityBlock uint64                  `json:"finality-block" yaml:"finality-block"`
	NID           string                  `json:"nid" yaml:"nid"`
	HomeDir       string                  `json:"-" yaml:"-"`
	Disabled      bool                    `json:"disabled" yaml:"disabled"`
}

CommonConfig is the common configuration for all chain providers

func (*CommonConfig) Enabled

func (c *CommonConfig) Enabled() bool

Enabled returns true if the provider is enabled

func (*CommonConfig) GetWallet

func (pc *CommonConfig) GetWallet() string

func (*CommonConfig) SetWallet

func (pc *CommonConfig) SetWallet(addr string)

func (*CommonConfig) Validate

func (pc *CommonConfig) Validate() error

type Config

type Config interface {
	NewProvider(context.Context, *zap.Logger, string, bool, string) (ChainProvider, error)
	SetWallet(string)
	GetWallet() string
	Validate() error
	Enabled() bool
}