sdk

package module
v2.0.0-...-4767086 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 21, 2024 License: GPL-3.0 Imports: 15 Imported by: 0

README

TrueBlocks SDKs

IMPORTANT NOTE

While we fully intend to support this portion of our repo in the future, we are currently focused on the core TrueBlocks code. We are not currently accepting PR's or issues on this repo. We will be back to this repo soon. Use at your own risk.

Table of Contents

Introduction

This repo holds auto-generated SDKs based on the TrueBlocks API. This SDK is intended for use by the core developers of TrueBlocks as we develop our own applications, and is therefore purposefully not well documented. This is so we do not create an unwanted support burden for our team. You are welcome to use the SDK, but we will do not provide technical support.

However, we do welcome issues and PR's (particularly documentation) from the community.

The SDKs

There are two SDKs so far:

Docker version

These SDKs are easiest to use with our docker version which is in a separate repo. Please see that repo for information on running with Docker.

Documentation

The TrueBlocks documentation repo builds the TrueBlocks website. See our website for the best available documentation.

Contributing

We love contributors. Please see information about our work flow before proceeding.

  1. Fork this repository into your own repo.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make changes to your local branch and commit them to your forked repo: git commit -m '<commit_message>'
  4. Push back to the original branch: git push origin TrueBlocks/trueblocks-core
  5. Create the pull request.

Contact

If you have questions, comments, or complaints, please join the discussion on our discord server which is linked from our website.

List of Contributors

Thanks to the following people who have contributed to this project:

Documentation

Index

Constants

View Source 
const (
	NoBF   BlocksFlow = 0
	BFFrom            = 1 << iota
	BFTo
	BFReward
)
View Source 
const (
	NoCHM      ChunksMode = 0
	CMManifest            = 1 << iota
	CMIndex
	CMBlooms
	CMPins
	CMAddresses
	CMAppearances
	CMStats
)
View Source 
const (
	NoCOM  ConfigMode = 0
	CMShow            = 1 << iota
	CMEdit
)
View Source 
const (
	NoDA  DaemonApi = 0
	DAOff           = 1 << iota
	DAOn
)
View Source 
const (
	NoDS  DaemonScrape = 0
	DSOff              = 1 << iota
	DSBlooms
	DSIndex
)
View Source 
const (
	NoEF ExportFlow = 0
	EFIn            = 1 << iota
	EFOut
	EFZero
)
View Source 
const (
	NoST  SlurpTypes = 0
	STExt            = 1 << iota
	STInt
	STToken
	STNfts
	ST1155
	STMiner
	STUncles
	STWithdrawals
	STSome = STExt | STInt | STToken | STNfts
	STAll  = STExt | STInt | STToken | STNfts | ST1155 | STMiner | STUncles | STWithdrawals
)
View Source 
const (
	NoSS        SlurpSource = 0
	SSEtherscan             = 1 << iota
	SSKey
)
View Source 
const (
	NoSP      StateParts = 0
	SPBalance            = 1 << iota
	SPNonce
	SPCode
	SPProxy
	SPDeployed
	SPAccttype
	SPSome = SPBalance | SPProxy | SPDeployed | SPAccttype
	SPAll  = SPBalance | SPNonce | SPCode | SPProxy | SPDeployed | SPAccttype
)
View Source 
const (
	NoSM    StatusModes = 0
	SMIndex             = 1 << iota
	SMBlooms
	SMBlocks
	SMTransactions
	SMTraces
	SMLogs
	SMStatements
	SMResults
	SMState
	SMTokens
	SMMonitors
	SMNames
	SMAbis
	SMSlurps
	SMStaging
	SMUnripe
	SMMaps
	SMSome = SMIndex | SMBlooms | SMBlocks | SMTransactions
	SMAll  = SMIndex | SMBlooms | SMBlocks | SMTransactions | SMTraces | SMLogs | SMStatements | SMResults | SMState | SMTokens | SMMonitors | SMNames | SMAbis | SMSlurps | SMStaging | SMUnripe | SMMaps
)
View Source 
const (
	NoTP   TokensParts = 0
	TPName             = 1 << iota
	TPSymbol
	TPDecimals
	TPTotalSupply
	TPVersion
	TPSome = TPName | TPSymbol | TPDecimals | TPTotalSupply
	TPAll  = TPName | TPSymbol | TPDecimals | TPTotalSupply | TPVersion
)
View Source 
const (
	NoTF   TransactionsFlow = 0
	TFFrom                  = 1 << iota
	TFTo
)

Variables

This section is empty.

Functions

func GetMetaData 

func GetMetaData() (*types.MetaData, error)

Types

type AbisOptions 

type AbisOptions struct {
	Addrs    []string     `json:"addrs,omitempty"`
	Known    bool         `json:"known,omitempty"`
	ProxyFor base.Address `json:"proxyFor,omitempty"`
	Find     []string     `json:"find,omitempty"`
	Hint     []string     `json:"hint,omitempty"`
	Encode   string       `json:"encode,omitempty"`
	Globals
}

func GetAbisOptions 

func GetAbisOptions(args []string) (*AbisOptions, error)

GetAbisOptions returns a filled-in options instance given a string array of arguments.

func (*AbisOptions) Abis 

func (opts *AbisOptions) Abis() ([]types.Function, *types.MetaData, error)

Abis implements the chifra abis command.

func (*AbisOptions) AbisBytes 

func (opts *AbisOptions) AbisBytes(w io.Writer) error

AbisBytes implements the chifra abis command for the SDK.

func (*AbisOptions) String 

func (opts *AbisOptions) String() string

String implements the stringer interface

type BlocksFlow 

type BlocksFlow int

func (BlocksFlow) String 

func (v BlocksFlow) String() string

type BlocksOptions 

type BlocksOptions struct {
	BlockIds    []string    `json:"blocks,omitempty"`
	Hashes      bool        `json:"hashes,omitempty"`
	Uncles      bool        `json:"uncles,omitempty"`
	Traces      bool        `json:"traces,omitempty"`
	Uniq        bool        `json:"uniq,omitempty"`
	Flow        BlocksFlow  `json:"flow,omitempty"`
	Logs        bool        `json:"logs,omitempty"`
	Emitter     []string    `json:"emitter,omitempty"`
	Topic       []string    `json:"topic,omitempty"`
	Withdrawals bool        `json:"withdrawals,omitempty"`
	Articulate  bool        `json:"articulate,omitempty"`
	BigRange    uint64      `json:"bigRange,omitempty"`
	Count       bool        `json:"count,omitempty"`
	CacheTxs    bool        `json:"cacheTxs,omitempty"`
	CacheTraces bool        `json:"cacheTraces,omitempty"`
	List        base.Blknum `json:"list,omitempty"`
	ListCount   base.Blknum `json:"listCount,omitempty"`
	Globals
}

func GetBlocksOptions 

func GetBlocksOptions(args []string) (*BlocksOptions, error)

GetBlocksOptions returns a filled-in options instance given a string array of arguments.

func (*BlocksOptions) Blocks 

func (opts *BlocksOptions) Blocks() ([]types.Block[types.Transaction], *types.MetaData, error)

Blocks implements the chifra blocks command.

func (*BlocksOptions) BlocksBytes 

func (opts *BlocksOptions) BlocksBytes(w io.Writer) error

BlocksBytes implements the chifra blocks command for the SDK.

func (*BlocksOptions) BlocksCount 

func (opts *BlocksOptions) BlocksCount() ([]types.BlockCount, *types.MetaData, error)

BlocksCount implements the chifra blocks --count command.

func (*BlocksOptions) BlocksHashes 

func (opts *BlocksOptions) BlocksHashes() ([]types.Block[string], *types.MetaData, error)

BlocksHashes implements the chifra blocks --hashes command.

func (*BlocksOptions) BlocksLogs 

func (opts *BlocksOptions) BlocksLogs() ([]types.Log, *types.MetaData, error)

BlocksLogs implements the chifra blocks --logs command.

func (*BlocksOptions) BlocksTraces 

func (opts *BlocksOptions) BlocksTraces() ([]types.Trace, *types.MetaData, error)

BlocksTraces implements the chifra blocks --traces command.

func (*BlocksOptions) BlocksUniq 

func (opts *BlocksOptions) BlocksUniq() ([]types.Appearance, *types.MetaData, error)

BlocksUniq implements the chifra blocks --uniq command.

func (*BlocksOptions) BlocksWithdrawals 

func (opts *BlocksOptions) BlocksWithdrawals() ([]types.Withdrawal, *types.MetaData, error)

BlocksWithdrawals implements the chifra blocks --withdrawals command.

func (*BlocksOptions) String 

func (opts *BlocksOptions) String() string

String implements the stringer interface

type ChunksMode 

type ChunksMode int

func (ChunksMode) String 

func (v ChunksMode) String() string

type ChunksOptions 

type ChunksOptions struct {
	Mode       ChunksMode   `json:"mode,omitempty"`
	BlockIds   []string     `json:"blocks,omitempty"`
	Check      bool         `json:"check,omitempty"`
	Pin        bool         `json:"pin,omitempty"`
	Publish    bool         `json:"publish,omitempty"`
	Publisher  base.Address `json:"publisher,omitempty"`
	Truncate   base.Blknum  `json:"truncate,omitempty"`
	Remote     bool         `json:"remote,omitempty"`
	Belongs    []string     `json:"belongs,omitempty"`
	Diff       bool         `json:"diff,omitempty"`
	FirstBlock base.Blknum  `json:"firstBlock,omitempty"`
	LastBlock  base.Blknum  `json:"lastBlock,omitempty"`
	MaxAddrs   base.Blknum  `json:"maxAddrs,omitempty"`
	Deep       bool         `json:"deep,omitempty"`
	Rewrite    bool         `json:"rewrite,omitempty"`
	List       bool         `json:"list,omitempty"`
	Unpin      bool         `json:"unpin,omitempty"`
	Count      bool         `json:"count,omitempty"`
	Tag        string       `json:"tag,omitempty"`
	Sleep      float64      `json:"sleep,omitempty"`
	Globals
}

func GetChunksOptions 

func GetChunksOptions(args []string) (*ChunksOptions, error)

GetChunksOptions returns a filled-in options instance given a string array of arguments.

func (*ChunksOptions) ChunkStats 

func (opts *ChunksOptions) ChunkStats() ([]types.ChunkStats, *types.MetaData, error)

ChunkStats implements the chifra chunks stats command.

func (*ChunksOptions) ChunksAddresses 

func (opts *ChunksOptions) ChunksAddresses() ([]types.ChunkAddress, *types.MetaData, error)

ChunksAddresses implements the chifra chunks addresses command.

func (*ChunksOptions) ChunksBlooms 

func (opts *ChunksOptions) ChunksBlooms() ([]types.ChunkBloom, *types.MetaData, error)

ChunksBlooms implements the chifra chunks blooms command.

func (*ChunksOptions) ChunksBytes 

func (opts *ChunksOptions) ChunksBytes(w io.Writer) error

ChunksBytes implements the chifra chunks command for the SDK.

func (*ChunksOptions) ChunksIndex 

func (opts *ChunksOptions) ChunksIndex() ([]types.ChunkIndex, *types.MetaData, error)

ChunksIndex implements the chifra chunks index command.

func (*ChunksOptions) ChunksManifest 

func (opts *ChunksOptions) ChunksManifest() ([]types.ChunkRecord, *types.MetaData, error)

EXISTING_CODE ChunksManifest implements the chifra chunks manifest command.

func (*ChunksOptions) ChunksPins 

func (opts *ChunksOptions) ChunksPins() ([]types.ChunkPinReport, *types.MetaData, error)

ChunksPins implements the chifra chunks pins command.

func (*ChunksOptions) String 

func (opts *ChunksOptions) String() string

String implements the stringer interface

type ConfigMode 

type ConfigMode int

func (ConfigMode) String 

func (v ConfigMode) String() string

type ConfigOptions 

type ConfigOptions struct {
	Mode  ConfigMode `json:"mode,omitempty"`
	Paths bool       `json:"paths,omitempty"`
	Globals
}

func GetConfigOptions 

func GetConfigOptions(args []string) (*ConfigOptions, error)

GetConfigOptions returns a filled-in options instance given a string array of arguments.

func (*ConfigOptions) ConfigBytes 

func (opts *ConfigOptions) ConfigBytes(w io.Writer) error

ConfigBytes implements the chifra config command for the SDK.

func (*ConfigOptions) String 

func (opts *ConfigOptions) String() string

String implements the stringer interface

type DaemonApi 

type DaemonApi int

func (DaemonApi) String 

func (v DaemonApi) String() string

type DaemonOptions 

type DaemonOptions struct {
	Url     string       `json:"url,omitempty"`
	Api     DaemonApi    `json:"api,omitempty"`
	Scrape  DaemonScrape `json:"scrape,omitempty"`
	Monitor bool         `json:"monitor,omitempty"`
	Grpc    bool         `json:"grpc,omitempty"`
	Port    string       `json:"port,omitempty"`
	Silent  bool         `json:"silent,omitempty"`
	Globals
}

func GetDaemonOptions 

func GetDaemonOptions(args []string) (*DaemonOptions, error)

GetDaemonOptions returns a filled-in options instance given a string array of arguments.

func NewDaemon 

func NewDaemon(url string) *DaemonOptions

func (*DaemonOptions) DaemonBytes 

func (opts *DaemonOptions) DaemonBytes(w io.Writer) error

DaemonBytes implements the chifra daemon command for the SDK.

func (*DaemonOptions) Start 

func (opts *DaemonOptions) Start(ready chan<- bool)

EXISTING_CODE

func (*DaemonOptions) String 

func (opts *DaemonOptions) String() string

String implements the stringer interface

type DaemonScrape 

type DaemonScrape int

func (DaemonScrape) String 

func (v DaemonScrape) String() string

type ExportFlow 

type ExportFlow int

func (ExportFlow) String 

func (v ExportFlow) String() string

type ExportOptions 

type ExportOptions struct {
	Addrs       []string    `json:"addrs,omitempty"`
	Topics      []string    `json:"topics,omitempty"`
	Fourbytes   []string    `json:"fourbytes,omitempty"`
	Appearances bool        `json:"appearances,omitempty"`
	Receipts    bool        `json:"receipts,omitempty"`
	Logs        bool        `json:"logs,omitempty"`
	Traces      bool        `json:"traces,omitempty"`
	Neighbors   bool        `json:"neighbors,omitempty"`
	Accounting  bool        `json:"accounting,omitempty"`
	Statements  bool        `json:"statements,omitempty"`
	Balances    bool        `json:"balances,omitempty"`
	Withdrawals bool        `json:"withdrawals,omitempty"`
	Articulate  bool        `json:"articulate,omitempty"`
	CacheTraces bool        `json:"cacheTraces,omitempty"`
	Count       bool        `json:"count,omitempty"`
	FirstRecord uint64      `json:"firstRecord,omitempty"`
	MaxRecords  uint64      `json:"maxRecords,omitempty"`
	Relevant    bool        `json:"relevant,omitempty"`
	Emitter     []string    `json:"emitter,omitempty"`
	Topic       []string    `json:"topic,omitempty"`
	Reverted    bool        `json:"reverted,omitempty"`
	Asset       []string    `json:"asset,omitempty"`
	Flow        ExportFlow  `json:"flow,omitempty"`
	Factory     bool        `json:"factory,omitempty"`
	Unripe      bool        `json:"unripe,omitempty"`
	Load        string      `json:"load,omitempty"`
	Reversed    bool        `json:"reversed,omitempty"`
	NoZero      bool        `json:"noZero,omitempty"`
	FirstBlock  base.Blknum `json:"firstBlock,omitempty"`
	LastBlock   base.Blknum `json:"lastBlock,omitempty"`
	Globals
}

func GetExportOptions 

func GetExportOptions(args []string) (*ExportOptions, error)

GetExportOptions returns a filled-in options instance given a string array of arguments.

func (*ExportOptions) Export 

func (opts *ExportOptions) Export() ([]types.Transaction, *types.MetaData, error)

Export implements the chifra export command.

func (*ExportOptions) ExportAppearances 

func (opts *ExportOptions) ExportAppearances() ([]types.Appearance, *types.MetaData, error)

ExportAppearances implements the chifra export --appearances command.

func (*ExportOptions) ExportBalances 

func (opts *ExportOptions) ExportBalances() ([]types.State, *types.MetaData, error)

ExportBalances implements the chifra export --balances command.

func (*ExportOptions) ExportBytes 

func (opts *ExportOptions) ExportBytes(w io.Writer) error

ExportBytes implements the chifra export command for the SDK.

func (*ExportOptions) ExportCount 

func (opts *ExportOptions) ExportCount() ([]types.AppearanceCount, *types.MetaData, error)

ExportCount implements the chifra export --count command.

func (*ExportOptions) ExportLogs 

func (opts *ExportOptions) ExportLogs() ([]types.Log, *types.MetaData, error)

ExportLogs implements the chifra export --logs command.

func (*ExportOptions) ExportReceipts 

func (opts *ExportOptions) ExportReceipts() ([]types.Receipt, *types.MetaData, error)

ExportReceipts implements the chifra export --receipts command.

func (*ExportOptions) ExportStatements 

func (opts *ExportOptions) ExportStatements() ([]types.Statement, *types.MetaData, error)

ExportStatements implements the chifra export --statements command.

func (*ExportOptions) ExportTraces 

func (opts *ExportOptions) ExportTraces() ([]types.Trace, *types.MetaData, error)

ExportTraces implements the chifra export --traces command.

func (*ExportOptions) ExportWithdrawals 

func (opts *ExportOptions) ExportWithdrawals() ([]types.Withdrawal, *types.MetaData, error)

ExportWithdrawals implements the chifra export --withdrawals command.

func (*ExportOptions) String 

func (opts *ExportOptions) String() string

String implements the stringer interface

type Globals 

type Globals struct {
	Ether   bool   `json:"ether,omitempty"`
	Raw     bool   `json:"raw,omitempty"`
	Cache   bool   `json:"cache,omitempty"`
	Decache bool   `json:"decache,omitempty"`
	Verbose bool   `json:"verbose,omitempty"`
	Chain   string `json:"chain,omitempty"`
	Output  string `json:"output,omitempty"`
	Append  bool   `json:"append,omitempty"`
}

Globals is a subset of globally available options from the command line that make sense in the SDK context

func (*Globals) String 

func (g *Globals) String() string

type InitOptions 

type InitOptions struct {
	All        bool         `json:"all,omitempty"`
	DryRun     bool         `json:"dryRun,omitempty"`
	Publisher  base.Address `json:"publisher,omitempty"`
	FirstBlock base.Blknum  `json:"firstBlock,omitempty"`
	Sleep      float64      `json:"sleep,omitempty"`
	Globals
}

func GetInitOptions 

func GetInitOptions(args []string) (*InitOptions, error)

GetInitOptions returns a filled-in options instance given a string array of arguments.

func (*InitOptions) InitAll 

func (opts *InitOptions) InitAll() ([]bool, *types.MetaData, error)

InitAll implements the chifra init --all command.

func (*InitOptions) InitBytes 

func (opts *InitOptions) InitBytes(w io.Writer) error

InitBytes implements the chifra init command for the SDK.

func (*InitOptions) String 

func (opts *InitOptions) String() string

String implements the stringer interface

type ListOptions 

type ListOptions struct {
	Addrs       []string     `json:"addrs,omitempty"`
	Count       bool         `json:"count,omitempty"`
	NoZero      bool         `json:"noZero,omitempty"`
	Bounds      bool         `json:"bounds,omitempty"`
	Unripe      bool         `json:"unripe,omitempty"`
	Silent      bool         `json:"silent,omitempty"`
	FirstRecord uint64       `json:"firstRecord,omitempty"`
	MaxRecords  uint64       `json:"maxRecords,omitempty"`
	Reversed    bool         `json:"reversed,omitempty"`
	Publisher   base.Address `json:"publisher,omitempty"`
	FirstBlock  base.Blknum  `json:"firstBlock,omitempty"`
	LastBlock   base.Blknum  `json:"lastBlock,omitempty"`
	Globals
}

func GetListOptions 

func GetListOptions(args []string) (*ListOptions, error)

GetListOptions returns a filled-in options instance given a string array of arguments.

func (*ListOptions) List 

func (opts *ListOptions) List() ([]types.Appearance, *types.MetaData, error)

List implements the chifra list command.

func (*ListOptions) ListBounds 

func (opts *ListOptions) ListBounds() ([]types.Bounds, *types.MetaData, error)

ListBounds implements the chifra list --bounds command.

func (*ListOptions) ListBytes 

func (opts *ListOptions) ListBytes(w io.Writer) error

ListBytes implements the chifra list command for the SDK.

func (*ListOptions) ListCount 

func (opts *ListOptions) ListCount() ([]types.AppearanceCount, *types.MetaData, error)

ListCount implements the chifra list --count command.

func (*ListOptions) String 

func (opts *ListOptions) String() string

String implements the stringer interface

type LogsOptions 

type LogsOptions struct {
	TransactionIds []string `json:"transactions,omitempty"`
	Emitter        []string `json:"emitter,omitempty"`
	Topic          []string `json:"topic,omitempty"`
	Articulate     bool     `json:"articulate,omitempty"`
	Globals
}

func GetLogsOptions 

func GetLogsOptions(args []string) (*LogsOptions, error)

GetLogsOptions returns a filled-in options instance given a string array of arguments.

func (*LogsOptions) Logs 

func (opts *LogsOptions) Logs() ([]types.Log, *types.MetaData, error)

Logs implements the chifra logs command.

func (*LogsOptions) LogsBytes 

func (opts *LogsOptions) LogsBytes(w io.Writer) error

LogsBytes implements the chifra logs command for the SDK.

func (*LogsOptions) String 

func (opts *LogsOptions) String() string

String implements the stringer interface

type MonitorsOptions 

type MonitorsOptions struct {
	Addrs     []string `json:"addrs,omitempty"`
	Delete    bool     `json:"delete,omitempty"`
	Undelete  bool     `json:"undelete,omitempty"`
	Remove    bool     `json:"remove,omitempty"`
	Clean     bool     `json:"clean,omitempty"`
	List      bool     `json:"list,omitempty"`
	Watch     bool     `json:"watch,omitempty"`
	Watchlist string   `json:"watchlist,omitempty"`
	Commands  string   `json:"commands,omitempty"`
	BatchSize uint64   `json:"batchSize,omitempty"`
	RunCount  uint64   `json:"runCount,omitempty"`
	Sleep     float64  `json:"sleep,omitempty"`
	Globals
}

func GetMonitorsOptions 

func GetMonitorsOptions(args []string) (*MonitorsOptions, error)

GetMonitorsOptions returns a filled-in options instance given a string array of arguments.

func (*MonitorsOptions) Monitors 

func (opts *MonitorsOptions) Monitors() ([]bool, *types.MetaData, error)

Monitors implements the chifra monitors command.

func (*MonitorsOptions) MonitorsBytes 

func (opts *MonitorsOptions) MonitorsBytes(w io.Writer) error

MonitorsBytes implements the chifra monitors command for the SDK.

func (*MonitorsOptions) MonitorsClean 

func (opts *MonitorsOptions) MonitorsClean() ([]types.MonitorClean, *types.MetaData, error)

MonitorsClean implements the chifra monitors --clean command.

func (*MonitorsOptions) MonitorsList 

func (opts *MonitorsOptions) MonitorsList() ([]types.Monitor, *types.MetaData, error)

MonitorsList implements the chifra monitors --list command.

func (*MonitorsOptions) String 

func (opts *MonitorsOptions) String() string

String implements the stringer interface

type NamesOptions 

type NamesOptions struct {
	Terms     []string     `json:"terms,omitempty"`
	Expand    bool         `json:"expand,omitempty"`
	MatchCase bool         `json:"matchCase,omitempty"`
	All       bool         `json:"all,omitempty"`
	Custom    bool         `json:"custom,omitempty"`
	Prefund   bool         `json:"prefund,omitempty"`
	Addr      bool         `json:"addr,omitempty"`
	Tags      bool         `json:"tags,omitempty"`
	Clean     bool         `json:"clean,omitempty"`
	Regular   bool         `json:"regular,omitempty"`
	DryRun    bool         `json:"dryRun,omitempty"`
	Autoname  base.Address `json:"autoname,omitempty"`
	Create    bool         `json:"create,omitempty"`
	Update    bool         `json:"update,omitempty"`
	Delete    bool         `json:"delete,omitempty"`
	Undelete  bool         `json:"undelete,omitempty"`
	Remove    bool         `json:"remove,omitempty"`
	Globals
}

func GetNamesOptions 

func GetNamesOptions(args []string) (*NamesOptions, error)

GetNamesOptions returns a filled-in options instance given a string array of arguments.

func (*NamesOptions) Names 

func (opts *NamesOptions) Names() ([]types.Name, *types.MetaData, error)

Names implements the chifra names command.

func (*NamesOptions) NamesAddr 

func (opts *NamesOptions) NamesAddr() ([]base.Address, *types.MetaData, error)

NamesAddr implements the chifra names --addr command.

func (*NamesOptions) NamesBytes 

func (opts *NamesOptions) NamesBytes(w io.Writer) error

NamesBytes implements the chifra names command for the SDK.

func (*NamesOptions) NamesTags 

func (opts *NamesOptions) NamesTags() ([]string, *types.MetaData, error)

NamesTags implements the chifra names --tags command.

func (*NamesOptions) String 

func (opts *NamesOptions) String() string

String implements the stringer interface

type ParseFunc 

type ParseFunc func(target interface{}, key, value string) (bool, error)

ParseFunc is a function that takes a key/value pair and returns `true,nil` if the key/value pair was parsed and the value is valid. If the key is found, but the value is invalid, it returns `false, error` with a non-nil error. If it doesn't recognize the key, it returns `false, nil`.

type ReceiptsOptions 

type ReceiptsOptions struct {
	TransactionIds []string `json:"transactions,omitempty"`
	Articulate     bool     `json:"articulate,omitempty"`
	Globals
}

func GetReceiptsOptions 

func GetReceiptsOptions(args []string) (*ReceiptsOptions, error)

GetReceiptsOptions returns a filled-in options instance given a string array of arguments.

func (*ReceiptsOptions) Receipts 

func (opts *ReceiptsOptions) Receipts() ([]types.Receipt, *types.MetaData, error)

Receipts implements the chifra receipts command.

func (*ReceiptsOptions) ReceiptsBytes 

func (opts *ReceiptsOptions) ReceiptsBytes(w io.Writer) error

ReceiptsBytes implements the chifra receipts command for the SDK.

func (*ReceiptsOptions) String 

func (opts *ReceiptsOptions) String() string

String implements the stringer interface

type Result 

type Result[T any] struct {
	Data []T            `json:"data"`
	Meta types.MetaData `json:"meta"`
}

type SlurpOptions 

type SlurpOptions struct {
	Addrs       []string    `json:"addrs,omitempty"`
	BlockIds    []string    `json:"blocks,omitempty"`
	Types       SlurpTypes  `json:"types,omitempty"`
	Appearances bool        `json:"appearances,omitempty"`
	Articulate  bool        `json:"articulate,omitempty"`
	Source      SlurpSource `json:"source,omitempty"`
	Count       bool        `json:"count,omitempty"`
	Page        uint64      `json:"page,omitempty"`
	PerPage     uint64      `json:"perPage,omitempty"`
	Sleep       float64     `json:"sleep,omitempty"`
	Globals
}

func GetSlurpOptions 

func GetSlurpOptions(args []string) (*SlurpOptions, error)

GetSlurpOptions returns a filled-in options instance given a string array of arguments.

func (*SlurpOptions) Slurp 

func (opts *SlurpOptions) Slurp() ([]types.Slurp, *types.MetaData, error)

Slurp implements the chifra slurp command.

func (*SlurpOptions) SlurpAppearances 

func (opts *SlurpOptions) SlurpAppearances() ([]types.Appearance, *types.MetaData, error)

SlurpAppearances implements the chifra slurp --appearances command.

func (*SlurpOptions) SlurpBytes 

func (opts *SlurpOptions) SlurpBytes(w io.Writer) error

SlurpBytes implements the chifra slurp command for the SDK.

func (*SlurpOptions) SlurpCount 

func (opts *SlurpOptions) SlurpCount() ([]types.SlurpCount, *types.MetaData, error)

SlurpCount implements the chifra slurp --count command.

func (*SlurpOptions) String 

func (opts *SlurpOptions) String() string

String implements the stringer interface

type SlurpSource 

type SlurpSource int

func (SlurpSource) String 

func (v SlurpSource) String() string

type SlurpTypes 

type SlurpTypes int

func (SlurpTypes) String 

func (v SlurpTypes) String() string

type StateOptions 

type StateOptions struct {
	Addrs      []string     `json:"addrs,omitempty"`
	BlockIds   []string     `json:"blocks,omitempty"`
	Parts      StateParts   `json:"parts,omitempty"`
	Changes    bool         `json:"changes,omitempty"`
	NoZero     bool         `json:"noZero,omitempty"`
	Call       string       `json:"call,omitempty"`
	Articulate bool         `json:"articulate,omitempty"`
	ProxyFor   base.Address `json:"proxyFor,omitempty"`
	Globals
}

func GetStateOptions 

func GetStateOptions(args []string) (*StateOptions, error)

GetStateOptions returns a filled-in options instance given a string array of arguments.

func (*StateOptions) State 

func (opts *StateOptions) State() ([]types.State, *types.MetaData, error)

State implements the chifra state command.

func (*StateOptions) StateBytes 

func (opts *StateOptions) StateBytes(w io.Writer) error

StateBytes implements the chifra state command for the SDK.

func (*StateOptions) StateCall 

func (opts *StateOptions) StateCall() ([]types.Result, *types.MetaData, error)

StateCall implements the chifra state --call command.

func (*StateOptions) String 

func (opts *StateOptions) String() string

String implements the stringer interface

type StateParts 

type StateParts int

func (StateParts) String 

func (v StateParts) String() string

type StatusModes 

type StatusModes int

func (StatusModes) String 

func (v StatusModes) String() string

type StatusOptions 

type StatusOptions struct {
	Modes       StatusModes `json:"modes,omitempty"`
	Diagnose    bool        `json:"diagnose,omitempty"`
	FirstRecord uint64      `json:"firstRecord,omitempty"`
	MaxRecords  uint64      `json:"maxRecords,omitempty"`
	Chains      bool        `json:"chains,omitempty"`
	Globals
}

func GetStatusOptions 

func GetStatusOptions(args []string) (*StatusOptions, error)

GetStatusOptions returns a filled-in options instance given a string array of arguments.

func (*StatusOptions) StatusBytes 

func (opts *StatusOptions) StatusBytes(w io.Writer) error

StatusBytes implements the chifra status command for the SDK.

func (*StatusOptions) String 

func (opts *StatusOptions) String() string

String implements the stringer interface

type TokensOptions 

type TokensOptions struct {
	Addrs    []string    `json:"addrs,omitempty"`
	BlockIds []string    `json:"blocks,omitempty"`
	Parts    TokensParts `json:"parts,omitempty"`
	ByAcct   bool        `json:"byAcct,omitempty"`
	Changes  bool        `json:"changes,omitempty"`
	NoZero   bool        `json:"noZero,omitempty"`
	Globals
}

func GetTokensOptions 

func GetTokensOptions(args []string) (*TokensOptions, error)

GetTokensOptions returns a filled-in options instance given a string array of arguments.

func (*TokensOptions) String 

func (opts *TokensOptions) String() string

String implements the stringer interface

func (*TokensOptions) Tokens 

func (opts *TokensOptions) Tokens() ([]types.Token, *types.MetaData, error)

Tokens implements the chifra tokens command.

func (*TokensOptions) TokensBytes 

func (opts *TokensOptions) TokensBytes(w io.Writer) error

TokensBytes implements the chifra tokens command for the SDK.

type TokensParts 

type TokensParts int

func (TokensParts) String 

func (v TokensParts) String() string

type TracesOptions 

type TracesOptions struct {
	TransactionIds []string `json:"transactions,omitempty"`
	Articulate     bool     `json:"articulate,omitempty"`
	Filter         string   `json:"filter,omitempty"`
	Count          bool     `json:"count,omitempty"`
	Globals
}

func GetTracesOptions 

func GetTracesOptions(args []string) (*TracesOptions, error)

GetTracesOptions returns a filled-in options instance given a string array of arguments.

func (*TracesOptions) String 

func (opts *TracesOptions) String() string

String implements the stringer interface

func (*TracesOptions) Traces 

func (opts *TracesOptions) Traces() ([]types.Trace, *types.MetaData, error)

Traces implements the chifra traces command.

func (*TracesOptions) TracesBytes 

func (opts *TracesOptions) TracesBytes(w io.Writer) error

TracesBytes implements the chifra traces command for the SDK.

func (*TracesOptions) TracesCount 

func (opts *TracesOptions) TracesCount() ([]types.TraceCount, *types.MetaData, error)

TracesCount implements the chifra traces --count command.

type TransactionsFlow 

type TransactionsFlow int

func (TransactionsFlow) String 

func (v TransactionsFlow) String() string

type TransactionsOptions 

type TransactionsOptions struct {
	TransactionIds []string         `json:"transactions,omitempty"`
	Articulate     bool             `json:"articulate,omitempty"`
	Traces         bool             `json:"traces,omitempty"`
	Uniq           bool             `json:"uniq,omitempty"`
	Flow           TransactionsFlow `json:"flow,omitempty"`
	Logs           bool             `json:"logs,omitempty"`
	Emitter        []string         `json:"emitter,omitempty"`
	Topic          []string         `json:"topic,omitempty"`
	CacheTraces    bool             `json:"cacheTraces,omitempty"`
	Seed           bool             `json:"seed,omitempty"`
	Globals
}

func GetTransactionsOptions 

func GetTransactionsOptions(args []string) (*TransactionsOptions, error)

GetTransactionsOptions returns a filled-in options instance given a string array of arguments.

func (*TransactionsOptions) String 

func (opts *TransactionsOptions) String() string

String implements the stringer interface

func (*TransactionsOptions) Transactions 

func (opts *TransactionsOptions) Transactions() ([]types.Transaction, *types.MetaData, error)

Transactions implements the chifra transactions command.

func (*TransactionsOptions) TransactionsBytes 

func (opts *TransactionsOptions) TransactionsBytes(w io.Writer) error

TransactionsBytes implements the chifra transactions command for the SDK.

func (*TransactionsOptions) TransactionsLogs 

func (opts *TransactionsOptions) TransactionsLogs() ([]types.Log, *types.MetaData, error)

TransactionsLogs implements the chifra transactions --logs command.

func (*TransactionsOptions) TransactionsTraces 

func (opts *TransactionsOptions) TransactionsTraces() ([]types.Trace, *types.MetaData, error)

TransactionsTraces implements the chifra transactions --traces command.

func (*TransactionsOptions) TransactionsUniq 

func (opts *TransactionsOptions) TransactionsUniq() ([]types.Appearance, *types.MetaData, error)

TransactionsUniq implements the chifra transactions --uniq command.

type WhenOptions 

type WhenOptions struct {
	BlockIds   []string    `json:"blocks,omitempty"`
	List       bool        `json:"list,omitempty"`
	Timestamps bool        `json:"timestamps,omitempty"`
	Count      bool        `json:"count,omitempty"`
	Truncate   base.Blknum `json:"truncate,omitempty"`
	Repair     bool        `json:"repair,omitempty"`
	Check      bool        `json:"check,omitempty"`
	Update     bool        `json:"update,omitempty"`
	Deep       bool        `json:"deep,omitempty"`
	Globals
}

func GetWhenOptions 

func GetWhenOptions(args []string) (*WhenOptions, error)

GetWhenOptions returns a filled-in options instance given a string array of arguments.

func (*WhenOptions) String 

func (opts *WhenOptions) String() string

String implements the stringer interface

func (*WhenOptions) When 

func (opts *WhenOptions) When() ([]types.NamedBlock, *types.MetaData, error)

When implements the chifra when command.

func (*WhenOptions) WhenBytes 

func (opts *WhenOptions) WhenBytes(w io.Writer) error

WhenBytes implements the chifra when command for the SDK.

func (*WhenOptions) WhenCount 

func (opts *WhenOptions) WhenCount() ([]types.TimestampCount, *types.MetaData, error)

WhenCount implements the chifra when --count command.

func (*WhenOptions) WhenTimestamps 

func (opts *WhenOptions) WhenTimestamps() ([]types.Timestamp, *types.MetaData, error)

WhenTimestamps implements the chifra when --timestamps command.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.