abicodec

README

ABI Encoder / Decoder Service

This service keeps a live-updating cache of all ABIs at any point in time, and allows consistent encoding and decoding of table rows or action payloads, at any block height or block ID.

Usage

Exposed through the REST interface currently. See https://docs.dfuse.io/reference/zswhq/rest/state-abi-decode/

Documentation

Index

• type ABICacheItem
• type ABISyncer
  • func NewSyncer(cache Cache, dbReader trxdb.DBReader, searchAddr string, onLive func()) (*ABISyncer, error)
  • func (s *ABISyncer) Sync()
• type Backuper
  • func NewBackuper(cache Cache, exportABIsEnabled bool, ...) *Backuper
  • func (b *Backuper) BackupPeriodically(every time.Duration)
• type Cache
• type Decoder
  • func NewDecoder(cache Cache) *Decoder
  • func (d *Decoder) DecodeAction(ctx context.Context, req *pbabicodec.DecodeActionRequest) (*pbabicodec.Response, error)
  • func (d *Decoder) DecodeTable(cxt context.Context, req *pbabicodec.DecodeTableRequest) (*pbabicodec.Response, error)
  • func (d *Decoder) GetAbi(ctx context.Context, req *pbabicodec.GetAbiRequest) (*pbabicodec.Response, error)
• type DefaultCache
  • func NewABICache(store dstore.Store, cacheName string) (*DefaultCache, error)
  • func (c *DefaultCache) ABIAtBlockNum(account string, blockNum uint32) *ABICacheItem
  • func (c *DefaultCache) Export(baseURL, filename string) error
  • func (c *DefaultCache) GetCursor() string
  • func (c *DefaultCache) Load(workerID string) (string, error)
  • func (c *DefaultCache) RemoveABIAtBlockNum(account string, blockNum uint32)
  • func (c *DefaultCache) Save(cursor string, workerID string) error
  • func (c *DefaultCache) SaveState() error
  • func (c *DefaultCache) SetABIAtBlockNum(account string, blockNum uint32, abi *zsw.ABI)
  • func (c *DefaultCache) SetCursor(cursor string)
• type IsLive
• type Server
  • func NewServer(cache Cache, grpcListenAddr string) *Server
  • func (s *Server) Check(ctx context.Context, in *pbhealth.HealthCheckRequest) (*pbhealth.HealthCheckResponse, error)
  • func (s *Server) Serve()
  • func (s *Server) SetReady()
  • func (s *Server) Stop(err error)

Types

type ABICacheItem

type ABICacheItem struct {
	ABI      *zsw.ABI
	BlockNum uint32
}

type ABISyncer

type ABISyncer struct {
	*shutter.Shutter
	// contains filtered or unexported fields
}

func NewSyncer

func NewSyncer(cache Cache, dbReader trxdb.DBReader, searchAddr string, onLive func()) (*ABISyncer, error)

func (*ABISyncer) Sync

func (s *ABISyncer) Sync()

type Backuper

type Backuper struct {
	*shutter.Shutter

	IsLive bool
	// contains filtered or unexported fields
}

func NewBackuper

func NewBackuper(cache Cache, exportABIsEnabled bool, exportABIsBaseURL, exportABIsFilename string) *Backuper

func (*Backuper) BackupPeriodically

func (b *Backuper) BackupPeriodically(every time.Duration)

type Cache

type Cache interface {
	ABIAtBlockNum(account string, blockNum uint32) *ABICacheItem
	SetABIAtBlockNum(account string, blockNum uint32, abi *zsw.ABI)
	RemoveABIAtBlockNum(account string, blockNum uint32)
	SaveState() error
	SetCursor(cursor string)
	GetCursor() string
	Export(baseURL string, filename string) error
}

type Decoder

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

func NewDecoder

func NewDecoder(cache Cache) *Decoder

func (*Decoder) DecodeAction

func (d *Decoder) DecodeAction(ctx context.Context, req *pbabicodec.DecodeActionRequest) (*pbabicodec.Response, error)

func (*Decoder) DecodeTable

func (d *Decoder) DecodeTable(cxt context.Context, req *pbabicodec.DecodeTableRequest) (*pbabicodec.Response, error)

func (*Decoder) GetAbi

func (d *Decoder) GetAbi(ctx context.Context, req *pbabicodec.GetAbiRequest) (*pbabicodec.Response, error)

type DefaultCache

type DefaultCache struct {
	Abis   map[string][]*ABICacheItem // from account to the ABIs in range
	Cursor string                     `json:"cursor"`
	// contains filtered or unexported fields
}

func NewABICache

func NewABICache(store dstore.Store, cacheName string) (*DefaultCache, error)

func (*DefaultCache) ABIAtBlockNum

func (c *DefaultCache) ABIAtBlockNum(account string, blockNum uint32) *ABICacheItem

func (*DefaultCache) Export

func (c *DefaultCache) Export(baseURL, filename string) error

func (*DefaultCache) GetCursor

func (c *DefaultCache) GetCursor() string

func (*DefaultCache) Load

func (c *DefaultCache) Load(workerID string) (string, error)

func (*DefaultCache) RemoveABIAtBlockNum

func (c *DefaultCache) RemoveABIAtBlockNum(account string, blockNum uint32)

func (*DefaultCache) Save

func (c *DefaultCache) Save(cursor string, workerID string) error

func (*DefaultCache) SaveState

func (c *DefaultCache) SaveState() error

func (*DefaultCache) SetABIAtBlockNum

func (c *DefaultCache) SetABIAtBlockNum(account string, blockNum uint32, abi *zsw.ABI)

func (*DefaultCache) SetCursor

func (c *DefaultCache) SetCursor(cursor string)

type IsLive

type IsLive chan interface{}

type Server

type Server struct {
	*shutter.Shutter
	// contains filtered or unexported fields
}

func NewServer

func NewServer(cache Cache, grpcListenAddr string) *Server

func (*Server) Check

func (s *Server) Check(ctx context.Context, in *pbhealth.HealthCheckRequest) (*pbhealth.HealthCheckResponse, error)

func (*Server) Serve

func (s *Server) Serve()

func (*Server) SetReady

func (s *Server) SetReady()

func (*Server) Stop

func (s *Server) Stop(err error)