asset

Documentation

Overview

Package asset maintains a registry of all assets on a blockchain.

Index

• Constants
• Variables
• type Asset
  • func (asset *Asset) SerializedDefinition() ([]byte, error)
• type Registry
  • func NewRegistry(db pg.DB, chain *protocol.Chain, pinStore *pin.Store) *Registry
  • func (reg *Registry) AnnotateTxs(ctx context.Context, txs []map[string]interface{}) error
  • func (reg *Registry) DecodeIssueAction(data []byte) (txbuilder.Action, error)
  • func (reg *Registry) Define(ctx context.Context, xpubs []string, quorum int, ...) (*Asset, error)
  • func (reg *Registry) FindByAlias(ctx context.Context, alias string) (*Asset, error)
  • func (reg *Registry) IndexAssets(indexer Saver)
  • func (reg *Registry) NewIssueAction(assetAmount bc.AssetAmount, referenceData chainjson.Map) txbuilder.Action
  • func (reg *Registry) ProcessBlocks(ctx context.Context)
• type Saver

Constants

const PinName = "asset"

PinName is used to identify the pin associated with the asset block processor.

Variables

var ErrDuplicateAlias = errors.New("duplicate asset alias")

Types

type Asset

type Asset struct {
	AssetID          bc.AssetID
	Alias            *string
	Definition       map[string]interface{}
	IssuanceProgram  []byte
	InitialBlockHash bc.Hash
	Signer           *signers.Signer
	Tags             map[string]interface{}
	// contains filtered or unexported fields
}

func (*Asset) SerializedDefinition

func (asset *Asset) SerializedDefinition() ([]byte, error)

type Registry

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

Registry tracks and stores all known assets on a blockchain.

func NewRegistry

func NewRegistry(db pg.DB, chain *protocol.Chain, pinStore *pin.Store) *Registry

func (*Registry) AnnotateTxs

func (reg *Registry) AnnotateTxs(ctx context.Context, txs []map[string]interface{}) error

func (*Registry) DecodeIssueAction

func (reg *Registry) DecodeIssueAction(data []byte) (txbuilder.Action, error)

func (*Registry) Define

func (reg *Registry) Define(ctx context.Context, xpubs []string, quorum int, definition map[string]interface{}, alias string, tags map[string]interface{}, clientToken string) (*Asset, error)

Define defines a new Asset.

func (*Registry) FindByAlias

func (reg *Registry) FindByAlias(ctx context.Context, alias string) (*Asset, error)

FindByAlias retrieves an Asset record along with its signer, given an asset alias.

func (*Registry) IndexAssets

func (reg *Registry) IndexAssets(indexer Saver)

func (*Registry) NewIssueAction

func (reg *Registry) NewIssueAction(assetAmount bc.AssetAmount, referenceData chainjson.Map) txbuilder.Action

func (*Registry) ProcessBlocks

func (reg *Registry) ProcessBlocks(ctx context.Context)

type Saver

type Saver interface {
	SaveAnnotatedAsset(context.Context, bc.AssetID, map[string]interface{}, string) error
}

A Saver is responsible for saving an annotated asset object for indexing and retrieval. If the Core is configured not to provide search services, SaveAnnotatedAsset can be a no-op.