fourbyte

Documentation

Overview

Package fourbyte contains the 4byte database.

Index

• func Asset(name string) ([]byte, error)
• func AssetDigest(name string) ([sha256.Size]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func AssetString(name string) (string, error)
• func Digests() (map[string][sha256.Size]byte, error)
• func MustAsset(name string) []byte
• func MustAssetString(name string) string
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type Database
  • func New() (*Database, error)
  • func NewFromFile(path string) (*Database, error)
  • func NewWithFile(path string) (*Database, error)
  • func (db *Database) AddSelector(selector string, data []byte) error
  • func (db *Database) Selector(id []byte) (string, error)
  • func (db *Database) Size() (int, int)
  • func (db *Database) ValidateCallData(selector *string, data []byte, messages *apitypes.ValidationMessages)
  • func (db *Database) ValidateTransaction(selector *string, tx *apitypes.SendTxArgs) (*apitypes.ValidationMessages, error)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDigest

func AssetDigest(name string) ([sha256.Size]byte, error)

AssetDigest returns the digest of the file with the given name. It returns an error if the asset could not be found or the digest could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"}, AssetDir("data/img") would return []string{"a.png", "b.png"}, AssetDir("foo.txt") and AssetDir("notexist") would return an error, and AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func AssetString

func AssetString(name string) (string, error)

AssetString returns the asset contents as a string (instead of a []byte).

func Digests

func Digests() (map[string][sha256.Size]byte, error)

Digests returns a map of all known files and their checksums.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func MustAssetString

func MustAssetString(name string) string

MustAssetString is like AssetString but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory.

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively.

Types

type Database

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

Database is a 4byte database with the possibility of maintaining an immutable set (embedded) into the process and a mutable set (loaded and written to file).

func New

func New() (*Database, error)

New loads the standard signature database embedded in the package.

func NewFromFile

func NewFromFile(path string) (*Database, error)

NewFromFile loads signature database from file, and errors if the file is not valid JSON. The constructor does no other validation of contents. This method does not load the embedded 4byte database.

The provided path will be used to write new values into if they are submitted via the API.

func NewWithFile

func NewWithFile(path string) (*Database, error)

NewWithFile loads both the standard signature database (embedded resource file) as well as a custom database. The latter will be used to write new values into if they are submitted via the API.

func (*Database) AddSelector

func (db *Database) AddSelector(selector string, data []byte) error

AddSelector inserts a new 4byte entry into the database. If custom database saving is enabled, the new dataset is also persisted to disk.

Node, this method does _not_ validate the correctness of the data. It assumes the caller has already done so.

func (*Database) Selector

func (db *Database) Selector(id []byte) (string, error)

Selector checks the given 4byte ID against the known ABI methods.

This method does not validate the match, it's assumed the caller will do.

func (*Database) Size

func (db *Database) Size() (int, int)

Size returns the number of 4byte entries in the embedded and custom datasets.

func (*Database) ValidateCallData

func (db *Database) ValidateCallData(selector *string, data []byte, messages *apitypes.ValidationMessages)

ValidateCallData checks if the ABI call-data + method selector (if given) can be parsed and seems to match.

func (*Database) ValidateTransaction

func (db *Database) ValidateTransaction(selector *string, tx *apitypes.SendTxArgs) (*apitypes.ValidationMessages, error)

ValidateTransaction does a number of checks on the supplied transaction, and returns either a list of warnings, or an error (indicating that the transaction should be immediately rejected).