gear_go

README

gear-go

Documentation

Index

• type EnquedSubscription
  • func NewEnq(responseType gear_client.ResponseType, callName, module, method string, ...) *EnquedSubscription
• type Gear
  • func NewGear() (*Gear, error)
  • func (gear *Gear) EnqueuedSubscriptions(methods []string, rtypes []gear_client.ResponseType, ...) SubscriptionFunc
  • func (gear *Gear) EnqueuedSubscriptionsOptional(enq []*EnquedSubscription, interruptions ...*Interruption) SubscriptionFunc
  • func (gear *Gear) EventsSubscription() SubscriptionFunc
  • func (gear *Gear) GetCalls() *calls.Calls
  • func (gear *Gear) GetClient() gear_client.IClient
  • func (gear *Gear) GetConfig() *config.Scheme
  • func (gear *Gear) GetMeta() *metadata.Metadata
  • func (gear *Gear) GetRPC() gear_rpc.IGearRPC
  • func (gear *Gear) GetWsClient() gear_client.IWsClient
  • func (gear *Gear) InitSubscriptions() error
  • func (gear *Gear) MergeSubscriptionFunctions(fo ...SubscriptionFunc)
  • func (gear *Gear) SubmitAndWatchExtrinsic(args []any, t string) SubscriptionFunc
• type Interruption
  • func NewInterruption(interruptionCause string, interFunc func() ([]any, error)) *Interruption
• type SendMessage
• type SubscriptionFunc

Types

type EnquedSubscription

type EnquedSubscription struct {
	ResponseType                 gear_client.ResponseType
	CallName, ModuleName, Method string
	Args                         []any
	IsExtrinsic                  bool
	IsCustomBuilder              bool
	CustomBuilderKeyRing         keyring.IKeyRing
	CustomFunc                   func() error
	AfterFinalizationFunc        func() error
}

func NewEnq

func NewEnq(responseType gear_client.ResponseType, callName, module, method string, isExtr bool) *EnquedSubscription

type Gear

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

func NewGear

func NewGear() (*Gear, error)

NewGear creates fully functional gear-go API instance

func (*Gear) EnqueuedSubscriptions

func (gear *Gear) EnqueuedSubscriptions(methods []string, rtypes []gear_client.ResponseType, callNames, moduleNames []string, args [][]any, interruptions ...*Interruption) SubscriptionFunc

EnqueuedSubscriptions is

func (*Gear) EnqueuedSubscriptionsOptional

func (gear *Gear) EnqueuedSubscriptionsOptional(enq []*EnquedSubscription, interruptions ...*Interruption) SubscriptionFunc

func (*Gear) EventsSubscription

func (gear *Gear) EventsSubscription() SubscriptionFunc

EventsSubscription implements state_subscribeStorage method

as it is shown in "example/code/example_subscription_upload" (line 23) example function is added via MergeSubscriptionFunctions

func (*Gear) GetCalls

func (gear *Gear) GetCalls() *calls.Calls

func (*Gear) GetClient

func (gear *Gear) GetClient() gear_client.IClient

func (*Gear) GetConfig

func (gear *Gear) GetConfig() *config.Scheme

func (*Gear) GetMeta

func (gear *Gear) GetMeta() *metadata.Metadata

func (*Gear) GetRPC

func (gear *Gear) GetRPC() gear_rpc.IGearRPC

func (*Gear) GetWsClient

func (gear *Gear) GetWsClient() gear_client.IWsClient

func (*Gear) InitSubscriptions

func (gear *Gear) InitSubscriptions() error

InitSubscriptions is the main func to handle ws subscriptions Required both AddResponseTypesAndMakeWsConnectionsPool and MergeSubscriptionFunctions had been called before using as it is shown in "example/code/example_subscription_upload" example

func (*Gear) MergeSubscriptionFunctions

func (gear *Gear) MergeSubscriptionFunctions(fo ...SubscriptionFunc)

func (*Gear) SubmitAndWatchExtrinsic

func (gear *Gear) SubmitAndWatchExtrinsic(args []any, t string) SubscriptionFunc

type Interruption

type Interruption struct {
	InterruptFunc     func() ([]any, error)
	InterruptionCause string
}

func NewInterruption

func NewInterruption(interruptionCause string, interFunc func() ([]any, error)) *Interruption

type SendMessage

type SendMessage struct {
	Destination string `json:"destination"`
	Payload     string `json:"payload"`
	GasLimit    int    `json:"gas_limit"`
	Value       string `json:"value"`
	KeepAlive   bool   `json:"keep_alive"`
}

type SubscriptionFunc

type SubscriptionFunc func() error

SubscriptionFunc is a subscription builder func