account

package

v0.0.0-...-8b8382b Latest Latest Go to latest Published: Oct 22, 2019 License: AGPL-3.0 Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/asmblock/blockchain

Links

Open Source Insights

Documentation ¶

Overview ¶

Package account stores and tracks accounts within a Chain Core.

Index ¶

Constants
Variables
func Annotated(a *Account) (*query.AnnotatedAccount, error)
type Account
type Manager
- func NewManager(db pg.DB, chain *protocol.Chain, pinStore *pin.Store) *Manager
type Saver

Constants ¶

View Source

const (
	// PinName is used to identify the pin associated with
	// the account indexer block processor.
	PinName = "account"
	// ExpirePinName is used to identify the pin associated
	// with the account control program expiration processor.
	ExpirePinName = "expire-control-programs"
	// DeleteSpentsPinName is used to identify the pin associated
	// with the processor that deletes spent account UTXOs.
	DeleteSpentsPinName = "delete-account-spents"
)

Variables ¶

View Source

var (
	ErrDuplicateAlias = errors.New("duplicate account alias")
	ErrBadIdentifier  = errors.New("either ID or alias must be specified, and not both")
)

View Source

var (
	// ErrInsufficient indicates the account doesn't contain enough
	// units of the requested asset to satisfy the reservation.
	// New units must be deposited into the account in order to
	// satisfy the request; change will not be sufficient.
	ErrInsufficient = errors.New("reservation found insufficient funds")

	// ErrReserved indicates that a reservation could not be
	// satisfied because some of the outputs were already reserved.
	// When those reservations are finalized into a transaction
	// (and no other transaction spends funds from the account),
	// new change outputs will be created
	// in sufficient amounts to satisfy the request.
	ErrReserved = errors.New("reservation found outputs already reserved")
)

Functions ¶

func Annotated ¶

func Annotated(a *Account) (*query.AnnotatedAccount, error)

Types ¶

type Account ¶

type Account struct {
	*signers.Signer
	Alias string
	Tags  map[string]interface{}
}

type Manager ¶

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

Manager stores accounts and their associated control programs.

func NewManager ¶

func NewManager(db pg.DB, chain *protocol.Chain, pinStore *pin.Store) *Manager

func (*Manager) AnnotateTxs ¶

func (m *Manager) AnnotateTxs(ctx context.Context, txs []*query.AnnotatedTx) error

AnnotateTxs adds account data to transactions

func (*Manager) Create ¶

func (m *Manager) Create(ctx context.Context, xpubs []chainkd.XPub, quorum int, alias string, tags map[string]interface{}, clientToken string) (*Account, error)

Create creates a new Account.

func (*Manager) CreateControlProgram ¶

func (m *Manager) CreateControlProgram(ctx context.Context, accountID string, change bool, expiresAt time.Time) ([]byte, error)

CreateControlProgram creates a control program that is tied to the Account and stores it in the database.

func (*Manager) CreateReceiver ¶

func (m *Manager) CreateReceiver(ctx context.Context, accID, accAlias string, expiresAt time.Time) (*txbuilder.Receiver, error)

CreateReceiver creates a new account receiver for an account with the provided expiry. If a zero time is provided for the expiry, a default expiry of 30 days from the current time is used.

func (*Manager) DecodeControlAction ¶

func (m *Manager) DecodeControlAction(data []byte) (txbuilder.Action, error)

func (*Manager) DecodeSpendAction ¶

func (m *Manager) DecodeSpendAction(data []byte) (txbuilder.Action, error)

func (*Manager) DecodeSpendUTXOAction ¶

func (m *Manager) DecodeSpendUTXOAction(data []byte) (txbuilder.Action, error)

func (*Manager) ExpireReservations ¶

func (m *Manager) ExpireReservations(ctx context.Context, period time.Duration)

ExpireReservations removes reservations that have expired periodically. It blocks until the context is canceled.

func (*Manager) FindByAlias ¶

func (m *Manager) FindByAlias(ctx context.Context, alias string) (*signers.Signer, error)

FindByAlias retrieves an account's Signer record by its alias

func (*Manager) IndexAccounts ¶

func (m *Manager) IndexAccounts(indexer Saver)

func (*Manager) NewControlAction ¶

func (m *Manager) NewControlAction(amt bc.AssetAmount, accountID string, refData chainjson.Map) txbuilder.Action

func (*Manager) NewSpendAction ¶

func (m *Manager) NewSpendAction(amt bc.AssetAmount, accountID string, refData chainjson.Map, clientToken *string) txbuilder.Action

func (*Manager) NewSpendUTXOAction ¶

func (m *Manager) NewSpendUTXOAction(outputID bc.Hash) txbuilder.Action

func (*Manager) ProcessBlocks ¶

func (m *Manager) ProcessBlocks(ctx context.Context)

func (*Manager) UpdateTags ¶

func (m *Manager) UpdateTags(ctx context.Context, id, alias *string, tags map[string]interface{}) error

UpdateTags modifies the tags of the specified account. The account may be identified either by ID or Alias, but not both.

type Saver ¶

type Saver interface {
	SaveAnnotatedAccount(context.Context, *query.AnnotatedAccount) error
}

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL