blockchain

Documentation

Index

• Variables
• func NewAddressGenerator(coordinator *shardCoordinator) (*addressGenerator, error)
• func NewProxy(args ArgsProxy) (*proxy, error)
• func NewShardCoordinator(numOfShardsWithoutMeta uint32, currentShard uint32) (*shardCoordinator, error)
• type ArgsProxy
• type EndpointProvider
• type FinalityProvider
• type Proxy

Variables

var ErrHTTPStatusCodeIsNotOK = errors.New("HTTP status code is not OK")

ErrHTTPStatusCodeIsNotOK signals that the returned HTTP status code is not OK

var ErrInvalidAddress = errors.New("invalid address")

ErrInvalidAddress signals that the provided address is invalid

var ErrInvalidAllowedDeltaToFinal = errors.New("invalid allowed delta to final value")

ErrInvalidAllowedDeltaToFinal signals that an invalid allowed delta to final value has been provided

var ErrInvalidCacherDuration = errors.New("invalid caching duration")

ErrInvalidCacherDuration signals that the provided caching duration is invalid

var ErrInvalidEndpointProvider = errors.New("invalid endpoint provider")

ErrInvalidEndpointProvider signals that an invalid endpoint provider was provided

var ErrNilAddress = errors.New("nil address")

ErrNilAddress signals that the provided address is nil

var ErrNilEndpointProvider = errors.New("nil endpoint provider")

ErrNilEndpointProvider signals that a nil endpoint provider was provided

var ErrNilHTTPClientWrapper = errors.New("nil HTTP client wrapper")

ErrNilHTTPClientWrapper signals that a nil HTTP client wrapper was provided

var ErrNilNetworkConfigs = errors.New("nil network configs")

ErrNilNetworkConfigs signals that the provided network configs is nil

var ErrNilNetworkStatus = errors.New("nil network status")

ErrNilNetworkStatus signals that nil network status was received

var ErrNilShardCoordinator = errors.New("nil shard coordinator")

ErrNilShardCoordinator signals that the provided shard coordinator is nil

var ErrShardIDMismatch = errors.New("shard ID mismatch")

ErrShardIDMismatch signals that a shard ID mismatch has occurred

Functions

func NewAddressGenerator

func NewAddressGenerator(coordinator *shardCoordinator) (*addressGenerator, error)

NewAddressGenerator will create an address generator instance

func NewProxy

func NewProxy(args ArgsProxy) (*proxy, error)

NewProxy initializes and returns a proxy object

func NewShardCoordinator

func NewShardCoordinator(numOfShardsWithoutMeta uint32, currentShard uint32) (*shardCoordinator, error)

NewShardCoordinator returns a shard coordinator instance that is able to execute sharding-related operations

Types

type ArgsProxy

type ArgsProxy struct {
	ProxyURL            string
	Client              erdgoHttp.Client
	SameScState         bool
	ShouldBeSynced      bool
	FinalityCheck       bool
	AllowedDeltaToFinal int
	CacheExpirationTime time.Duration
	EntityType          erdgoCore.RestAPIEntityType
}

ArgsProxy is the DTO used in the multiversx proxy constructor

type EndpointProvider

type EndpointProvider interface {
	GetNetworkConfig() string
	GetNetworkEconomics() string
	GetRatingsConfig() string
	GetEnableEpochsConfig() string
	GetAccount(addressAsBech32 string) string
	GetCostTransaction() string
	GetSendTransaction() string
	GetSendMultipleTransactions() string
	GetTransactionStatus(hexHash string) string
	GetTransactionInfo(hexHash string) string
	GetHyperBlockByNonce(nonce uint64) string
	GetHyperBlockByHash(hexHash string) string
	GetVmValues() string
	GetGenesisNodesConfig() string
	GetRawStartOfEpochMetaBlock(epoch uint32) string
	GetNodeStatus(shardID uint32) string
	ShouldCheckShardIDForNodeStatus() bool
	GetRawBlockByHash(shardID uint32, hexHash string) string
	GetRawBlockByNonce(shardID uint32, nonce uint64) string
	GetRawMiniBlockByHash(shardID uint32, hexHash string, epoch uint32) string
	GetRestAPIEntityType() core.RestAPIEntityType
	GetValidatorsInfo(epoch uint32) string
	IsInterfaceNil() bool
}

EndpointProvider is able to return endpoint routes strings

type FinalityProvider

type FinalityProvider interface {
	CheckShardFinalization(ctx context.Context, targetShardID uint32, maxNoncesDelta uint64) error
	IsInterfaceNil() bool
}

FinalityProvider is able to check the shard finalization status

type Proxy

type Proxy interface {
	GetNetworkConfig(ctx context.Context) (*data.NetworkConfig, error)
	GetAccount(ctx context.Context, address core.AddressHandler) (*data.Account, error)
	SendTransaction(ctx context.Context, tx *transaction.FrontendTransaction) (string, error)
	SendTransactions(ctx context.Context, txs []*transaction.FrontendTransaction) ([]string, error)
	ExecuteVMQuery(ctx context.Context, vmRequest *data.VmValueRequest) (*data.VmValuesResponseData, error)
	IsInterfaceNil() bool
}

Proxy holds the primitive functions that the multiversx proxy engine supports & implements