liteclient

Documentation

Index

• Constants
• Variables
• type ConnectionPool
  • func NewConnectionPool() *ConnectionPool
  • func (c *ConnectionPool) AddConnection(ctx context.Context, addr, serverKey string) error
  • func (c *ConnectionPool) AddConnectionsFromConfig(ctx context.Context, config *GlobalConfig) error
  • func (c *ConnectionPool) AddConnectionsFromConfigUrl(ctx context.Context, configUrl string) error
  • func (c *ConnectionPool) DefaultReconnect(waitBeforeReconnect time.Duration, maxTries int) OnDisconnectCallback
  • func (c *ConnectionPool) Do(ctx context.Context, typeID int32, payload []byte) (*LiteResponse, error)
  • func (c *ConnectionPool) SetOnDisconnect(cb OnDisconnectCallback)
  • func (c *ConnectionPool) StickyContext(ctx context.Context) context.Context
• type DHTAddress
• type DHTAddressList
• type DHTConfig
• type DHTNode
• type DHTNodes
• type GlobalConfig
  • func GetConfigFromUrl(ctx context.Context, url string) (*GlobalConfig, error)
• type LiteRequest
• type LiteResponse
• type LiteserverConfig
• type OnDisconnectCallback
• type ServerID
• type ValidatorConfig
• type ValidatorHardfork
• type ValidatorInitBlock
• type ValidatorZeroState

Constants

const ADNLQuery int32 = -1265895046

const ADNLQueryResponse int32 = 262964246

const LiteServerQuery int32 = 2039219935

const TCPPing int32 = 1292381082

const TCPPong int32 = -597034237

Variables

var ErrNoActiveConnections = errors.New("no active connections")

var (
	ErrNoConnections = errors.New("no connections established")
)

Types

type ConnectionPool

type ConnectionPool struct {
	// contains filtered or unexported fields
}

func NewConnectionPool

func NewConnectionPool() *ConnectionPool

func (*ConnectionPool) AddConnection

func (c *ConnectionPool) AddConnection(ctx context.Context, addr, serverKey string) error

func (*ConnectionPool) AddConnectionsFromConfig

func (c *ConnectionPool) AddConnectionsFromConfig(ctx context.Context, config *GlobalConfig) error

func (*ConnectionPool) AddConnectionsFromConfigUrl

func (c *ConnectionPool) AddConnectionsFromConfigUrl(ctx context.Context, configUrl string) error

func (*ConnectionPool) DefaultReconnect

func (c *ConnectionPool) DefaultReconnect(waitBeforeReconnect time.Duration, maxTries int) OnDisconnectCallback

func (*ConnectionPool) Do

func (c *ConnectionPool) Do(ctx context.Context, typeID int32, payload []byte) (*LiteResponse, error)

Do - builds and executes request to liteserver

func (*ConnectionPool) SetOnDisconnect

func (c *ConnectionPool) SetOnDisconnect(cb OnDisconnectCallback)

func (*ConnectionPool) StickyContext

func (c *ConnectionPool) StickyContext(ctx context.Context) context.Context

StickyContext - bounds all requests with this context to the same lite-server node, if possible. This is useful when we are doing some requests which depends on each other.

For example: we requested MasterchainInfo from node A, and we are trying to request account with this block info from node B but node B don't have yet information about this block, so it can return error. If we use StickyContext, all requests where its passed will be routed to same node.

In case if sticky node goes down, default balancer will be used as fallback

type DHTAddress

type DHTAddress struct {
	Type string `json:"@type"`
	IP   int    `json:"ip"`
	Port int    `json:"port"`
}

type DHTAddressList

type DHTAddressList struct {
	Type       string       `json:"@type"`
	Addrs      []DHTAddress `json:"addrs"`
	Version    int          `json:"version"`
	ReinitDate int          `json:"reinit_date"`
	Priority   int          `json:"priority"`
	ExpireAt   int          `json:"expire_at"`
}

type DHTConfig

type DHTConfig struct {
	Type        string   `json:"@type"`
	K           int      `json:"k"`
	A           int      `json:"a"`
	StaticNodes DHTNodes `json:"static_nodes"`
}

type DHTNode

type DHTNode struct {
	Type      string         `json:"@type"`
	ID        ServerID       `json:"id"`
	AddrList  DHTAddressList `json:"addr_list"`
	Version   int            `json:"version"`
	Signature string         `json:"signature"`
}

type DHTNodes

type DHTNodes struct {
	Type  string    `json:"@type"`
	Nodes []DHTNode `json:"nodes"`
}

type GlobalConfig

type GlobalConfig struct {
	Type        string             `json:"@type"`
	DHT         DHTConfig          `json:"dht"`
	Liteservers []LiteserverConfig `json:"liteservers"`
	Validator   ValidatorConfig    `json:"validator"`
}

func GetConfigFromUrl

func GetConfigFromUrl(ctx context.Context, url string) (*GlobalConfig, error)

type LiteRequest

type LiteRequest struct {
	TypeID   int32
	QueryID  []byte
	Data     []byte
	RespChan chan *LiteResponse
}

type LiteResponse

type LiteResponse struct {
	TypeID int32
	Data   []byte
	// contains filtered or unexported fields
}

type LiteserverConfig

type LiteserverConfig struct {
	IP   int64    `json:"ip"`
	Port int      `json:"port"`
	ID   ServerID `json:"id"`
}

type OnDisconnectCallback

type OnDisconnectCallback func(addr, key string)

type ServerID

type ServerID struct {
	Type string `json:"@type"`
	Key  string `json:"key"`
}

type ValidatorConfig

type ValidatorConfig struct {
	Type      string              `json:"@type"`
	ZeroState ValidatorZeroState  `json:"zero_state"`
	InitBlock ValidatorInitBlock  `json:"init_block"`
	Hardforks []ValidatorHardfork `json:"hardforks"`
}

type ValidatorHardfork

type ValidatorHardfork struct {
	FileHash  string `json:"file_hash"`
	Seqno     int    `json:"seqno"`
	RootHash  string `json:"root_hash"`
	Workchain int    `json:"workchain"`
	Shard     int64  `json:"shard"`
}

type ValidatorInitBlock

type ValidatorInitBlock struct {
	RootHash  string `json:"root_hash"`
	Seqno     int    `json:"seqno"`
	FileHash  string `json:"file_hash"`
	Workchain int    `json:"workchain"`
	Shard     int64  `json:"shard"`
}

type ValidatorZeroState

type ValidatorZeroState struct {
	Workchain int    `json:"workchain"`
	Shard     int64  `json:"shard"`
	Seqno     int    `json:"seqno"`
	RootHash  string `json:"root_hash"`
	FileHash  string `json:"file_hash"`
}