sdk

Documentation

Index

• func WithApi(a string) error
• func WithApiKey(k string) error
• func WithToken(t string) error
• func WithUrl(u string) error
• type Config
  • func (c Config) FilterByName(name string) Config
• type ConsumerHandleFunc
• type Contract
  • func (c Contract) Call(ctx context.Context, client rpc.RpcProvider, fn string, calldata ...*felt.Felt) ([]*felt.Felt, error)
• type HandlerCancelFunc
  • func RegisterHandler(n string, s string, cb ConsumerHandleFunc) (HandlerCancelFunc, error)
• type MiddlewareHandleFunc
• type RawEvent
• type RegisterResponse
  • func Configure(c Config) (*RegisterResponse, error)

Functions

func WithApi

func WithApi(a string) error

func WithApiKey

func WithApiKey(k string) error

func WithToken

func WithToken(t string) error

func WithUrl

func WithUrl(u string) error

Types

type Config

type Config struct {
	AppName    string     `json:"app_name"`
	Contracts  []Contract `json:"contracts"`
	StartBlock uint64     `json:"start_block"`
}

Indexer configuration

func (Config) FilterByName

func (c Config) FilterByName(name string) Config

type ConsumerHandleFunc

type ConsumerHandleFunc func(string, uint64, RawEvent) error

type Contract

type Contract struct {
	Events  map[string]string `json:"events"`
	Name    string            `json:"name"`
	Address string            `json:"address"`
}

func (Contract) Call

func (c Contract) Call(ctx context.Context, client rpc.RpcProvider, fn string, calldata ...*felt.Felt) ([]*felt.Felt, error)

type HandlerCancelFunc

type HandlerCancelFunc func()

func RegisterHandler

func RegisterHandler(n string, s string, cb ConsumerHandleFunc) (HandlerCancelFunc, error)

type MiddlewareHandleFunc

type MiddlewareHandleFunc func(ConsumerHandleFunc) ConsumerHandleFunc

type RawEvent

type RawEvent struct {
	RecordedAt  time.Time `json:"recorded_at"`
	EventId     string    `json:"event_id"`
	FromAddress string    `json:"from_address"`
	Keys        []string  `json:"keys"`
	Data        []string  `json:"data"`
}

Event directly pulled onchain

type RegisterResponse

type RegisterResponse struct {
	AppName string `json:"app_name"`
	Hash    string `json:"hash"`
}

RegisterResponse

func Configure

func Configure(c Config) (*RegisterResponse, error)