chain

package
v0.5.1-rc5 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2022 License: MIT Imports: 35 Imported by: 0

README

Chain Validator Design

Chain validators are organized by transaction type. The executor handles mundane tasks that are common to all chain validators, such as authentication and authorization.

In general, every transaction requires an origin record. Thus, the executor validates and loads the origin before delegating to the chain validator. However, certain transaction types, specifically synthetic transactions that create records, may not need an extant origin. The executor has a specific clause for these special cases.

Chain Validator Implementation

Chain validators must satisfy the TxExecutor interface:

type TxExecutor interface {
	Type() protocol.TransactionType
	Validate(*StateManager, *protocol.Envelope) error
}

All state manipulation (mutating and loading) must go through the state manager. There are three methods that can be used to modify records and/or create synthetic transactions:

  • Implementing a user transaction executor
    • Update(record) - Update one or more existing records. Cannot be used to create records.
    • Create(record) - Create one or more new records. Produces a synthetic chain create transaction.
    • Submit(url, body) - Submit a synthetic transaction.
  • Implementing a synthetic transaction executor
    • Update(record) - Create or update one or more existing records.
    • Create(record) - Cannot be used by synthetic transactions.
    • Submit(url, body) - Cannot be used by synthetic transactions.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddDirectoryEntry 

func AddDirectoryEntry(getIndex func(*url.URL, ...interface{}) Value, directory *url.URL, u ...*url.URL) error

Types

type AcmeFaucet 

type AcmeFaucet struct{}

func (AcmeFaucet) Type 

func (AcmeFaucet) Type() protocol.TransactionType

func (AcmeFaucet) Validate 

func (AcmeFaucet) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type AddCredits 

type AddCredits struct{}

func (AddCredits) Type 

func (AddCredits) Type() protocol.TransactionType

func (AddCredits) Validate 

func (AddCredits) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type AddValidator added in v0.5.1 

type AddValidator struct{}

func (AddValidator) Type added in v0.5.1 

func (AddValidator) Type() protocol.TransactionType

func (AddValidator) Validate added in v0.5.1 

func (AddValidator) Validate(st *StateManager, env *protocol.Envelope) (protocol.TransactionResult, error)

type BlockMeta 

type BlockMeta struct {
	IsLeader bool
	Index    int64
	Time     time.Time
}

BlockMeta is metadata about a block.

type BlockState 

type BlockState struct {
	Delivered         uint64
	SynthSigned       uint64
	SynthSent         uint64
	ValidatorsUpdates []abci.ValidatorUpdate
	ProducedTxns      []*protocol.Transaction
	ChainUpdates      []ChainUpdate
	// contains filtered or unexported fields
}

BlockState tracks various metrics of a block of transactions as they are executed.

func (*BlockState) DidProduceTxn 

func (s *BlockState) DidProduceTxn(url *url.URL, body protocol.TransactionBody)

DidProduceTxn records a produced transaction.

func (*BlockState) DidUpdateChain 

func (s *BlockState) DidUpdateChain(update ChainUpdate)

DidUpdateChain records a chain update.

func (*BlockState) Empty 

func (s *BlockState) Empty() bool

Empty returns true if nothing happened during the block.

func (*BlockState) Merge 

func (s *BlockState) Merge(r *BlockState)

Merge merges pending block changes into the block state.

type BurnTokens 

type BurnTokens struct{}

func (BurnTokens) Type 

func (BurnTokens) Type() protocol.TransactionType

func (BurnTokens) Validate 

func (BurnTokens) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type ChainUpdate added in v0.5.1 

type ChainUpdate struct {
	Account     *url.URL
	Name        string
	Type        protocol.ChainType
	Index       uint64
	SourceIndex uint64
	SourceBlock uint64
	Entry       []byte
}

ChainUpdate records an update to a chain of an account.

type CreateDataAccount 

type CreateDataAccount struct{}

func (CreateDataAccount) Type 

func (CreateDataAccount) Type() protocol.TransactionType

func (CreateDataAccount) Validate 

func (CreateDataAccount) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type CreateIdentity 

type CreateIdentity struct{}

func (CreateIdentity) Type 

func (CreateIdentity) Type() protocol.TransactionType

func (CreateIdentity) Validate 

func (CreateIdentity) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type CreateKeyBook 

type CreateKeyBook struct{}

func (CreateKeyBook) Type 

func (CreateKeyBook) Type() protocol.TransactionType

func (CreateKeyBook) Validate 

func (CreateKeyBook) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type CreateKeyPage 

type CreateKeyPage struct{}

func (CreateKeyPage) Type 

func (CreateKeyPage) Type() protocol.TransactionType

func (CreateKeyPage) Validate 

func (CreateKeyPage) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type CreateToken 

type CreateToken struct{}

func (CreateToken) Type 

func (CreateToken) Type() protocol.TransactionType

func (CreateToken) Validate 

func (CreateToken) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type CreateTokenAccount 

type CreateTokenAccount struct{}

func (CreateTokenAccount) Type 

func (CreateTokenAccount) Type() protocol.TransactionType

func (CreateTokenAccount) Validate 

func (CreateTokenAccount) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type Executor 

type Executor struct {
	ExecutorOptions
	// contains filtered or unexported fields
}

func NewGenesisExecutor 

func NewGenesisExecutor(db *database.Database, logger log.Logger, network config.Network) (*Executor, error)

NewGenesisExecutor creates a transaction executor that can be used to set up the genesis state.

func NewNodeExecutor 

func NewNodeExecutor(opts ExecutorOptions) (*Executor, error)

NewNodeExecutor creates a new Executor for a node.

func (*Executor) BeginBlock 

func (m *Executor) BeginBlock(req abci.BeginBlockRequest) (resp abci.BeginBlockResponse, err error)

BeginBlock implements ./abci.Chain

func (*Executor) CheckTx 

func (m *Executor) CheckTx(env *protocol.Envelope) (protocol.TransactionResult, *protocol.Error)

CheckTx implements ./abci.Chain

func (*Executor) Commit 

func (m *Executor) Commit() ([]byte, error)

Commit implements ./abci.Chain

func (*Executor) DeliverTx 

func (m *Executor) DeliverTx(env *protocol.Envelope) (protocol.TransactionResult, *protocol.Error)

DeliverTx implements ./abci.Chain

func (*Executor) EndBlock 

func (m *Executor) EndBlock(req abci.EndBlockRequest) abci.EndBlockResponse

EndBlock implements ./abci.Chain

func (*Executor) Genesis 

func (m *Executor) Genesis(time time.Time, callback func(st *StateManager) error) ([]byte, error)

func (*Executor) InitChain 

func (m *Executor) InitChain(data []byte, time time.Time) ([]byte, error)

func (*Executor) Query 

func (m *Executor) Query(q *query.Query, _ int64, prove bool) (k, v []byte, err *protocol.Error)

func (*Executor) Start 

func (m *Executor) Start() error

func (*Executor) Stop 

func (m *Executor) Stop() error

type ExecutorOptions 

type ExecutorOptions struct {
	DB      *database.Database
	Logger  log.Logger
	Key     ed25519.PrivateKey
	Router  routing.Router
	Network config.Network
	// contains filtered or unexported fields
}

type InternalSendTransactions 

type InternalSendTransactions struct{}

func (InternalSendTransactions) Type 

func (InternalSendTransactions) Type() protocol.TransactionType

func (InternalSendTransactions) Validate 

func (InternalSendTransactions) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type InternalTransactionsSent 

type InternalTransactionsSent struct{}

func (InternalTransactionsSent) Type 

func (InternalTransactionsSent) Type() protocol.TransactionType

func (InternalTransactionsSent) Validate 

func (InternalTransactionsSent) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type InternalTransactionsSigned 

type InternalTransactionsSigned struct{}

func (InternalTransactionsSigned) Type 

func (InternalTransactionsSigned) Type() protocol.TransactionType

func (InternalTransactionsSigned) Validate 

func (InternalTransactionsSigned) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type IssueTokens 

type IssueTokens struct{}

func (IssueTokens) Type 

func (IssueTokens) Type() protocol.TransactionType

func (IssueTokens) Validate 

func (IssueTokens) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type RemoveManager 

type RemoveManager struct{}

func (RemoveManager) Type 

func (RemoveManager) Type() protocol.TransactionType

func (RemoveManager) Validate 

func (RemoveManager) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type RemoveValidator added in v0.5.1 

type RemoveValidator struct{}

func (RemoveValidator) Type added in v0.5.1 

func (RemoveValidator) Type() protocol.TransactionType

func (RemoveValidator) Validate added in v0.5.1 

func (RemoveValidator) Validate(st *StateManager, env *protocol.Envelope) (protocol.TransactionResult, error)

type SendTokens 

type SendTokens struct{}

func (SendTokens) Type 

func (SendTokens) Type() protocol.TransactionType

func (SendTokens) Validate 

func (SendTokens) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type StateManager 

type StateManager struct {
	Origin    protocol.Account
	OriginUrl *url.URL

	Signator    creditChain
	SignatorUrl *url.URL
	// contains filtered or unexported fields
}

func NewStateManager 

func NewStateManager(batch *database.Batch, nodeUrl *url.URL, env *protocol.Envelope) (*StateManager, error)

NewStateManager creates a new state manager and loads the transaction's origin. If the origin is not found, NewStateManager returns a valid state manager along with a not-found error.

func (*StateManager) AddChainEntry 

func (m *StateManager) AddChainEntry(u *url.URL, name string, typ protocol.ChainType, entry []byte, sourceIndex, sourceBlock uint64) error

func (*StateManager) AddDirectoryEntry 

func (c *StateManager) AddDirectoryEntry(directory *url.URL, u ...*url.URL) error

func (*StateManager) AddSyntheticTxns 

func (m *StateManager) AddSyntheticTxns(txid []byte, synth [][32]byte)

func (*StateManager) AddValidator 

func (m *StateManager) AddValidator(pubKey ed25519.PubKey)

func (*StateManager) Commit 

func (m *StateManager) Commit() error

commit writes pending records to the database.

func (*StateManager) Create 

func (m *StateManager) Create(record ...protocol.Account)

Create queues a record for a synthetic chain create transaction. Will panic if called by a synthetic transaction. Will panic if the record is a transaction.

func (*StateManager) DisableValidator added in v0.5.1 

func (m *StateManager) DisableValidator(pubKey ed25519.PubKey)

func (*StateManager) GetHeight 

func (c *StateManager) GetHeight(u *url.URL) (uint64, error)

GetHeight loads the height of the chain

func (*StateManager) LoadSignatures 

func (c *StateManager) LoadSignatures(txid [32]byte) (*database.SignatureSet, error)

LoadSignatures loads and unmarshals a transaction's signatures

func (*StateManager) LoadTxn 

func (c *StateManager) LoadTxn(txid [32]byte) (*protocol.Transaction, error)

LoadTxn loads and unmarshals a saved transaction

func (*StateManager) LoadUrl 

func (c *StateManager) LoadUrl(u *url.URL) (protocol.Account, error)

LoadUrl loads a chain by URL and unmarshals it.

func (*StateManager) LoadUrlAs 

func (c *StateManager) LoadUrlAs(u *url.URL, v interface{}) error

LoadUrlAs loads a chain by URL and unmarshals it as a specific type.

func (*StateManager) ReadChain 

func (c *StateManager) ReadChain(u *url.URL, name string) (*database.Chain, error)

ReadChain loads an account's chain by URL and name.

func (*StateManager) RecordIndex 

func (c *StateManager) RecordIndex(u *url.URL, key ...interface{}) *writeIndex

func (*StateManager) Reset 

func (m *StateManager) Reset()

func (*StateManager) SignTransaction 

func (m *StateManager) SignTransaction(txid []byte, signatures ...protocol.Signature)

func (*StateManager) Submit 

func (m *StateManager) Submit(url *url.URL, body protocol.TransactionBody)

Submit queues a synthetic transaction for submission.

func (*StateManager) TxnIndex 

func (c *StateManager) TxnIndex(id []byte, key ...interface{}) *writeIndex

func (*StateManager) Update 

func (m *StateManager) Update(record ...protocol.Account)

Update queues a record for storage in the database. The queued update will fail if the record does not already exist, unless it is created by a synthetic transaction, or the record is a transaction.

func (*StateManager) UpdateData 

func (m *StateManager) UpdateData(record protocol.Account, entryHash []byte, dataEntry *protocol.DataEntry)

UpdateData will cache a data associated with a DataAccount chain. the cache data will not be stored directly in the state but can be used upstream for storing a chain in the state database.

func (*StateManager) UpdateSignator 

func (m *StateManager) UpdateSignator(record protocol.Account) error

type SyntheticAnchor 

type SyntheticAnchor struct {
	Network *config.Network
}

func (SyntheticAnchor) Type 

func (SyntheticAnchor) Type() protocol.TransactionType

func (SyntheticAnchor) Validate 

func (x SyntheticAnchor) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type SyntheticBurnTokens 

type SyntheticBurnTokens struct{}

func (SyntheticBurnTokens) Type 

func (SyntheticBurnTokens) Type() protocol.TransactionType

func (SyntheticBurnTokens) Validate 

func (SyntheticBurnTokens) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type SyntheticCreateChain 

type SyntheticCreateChain struct{}

func (SyntheticCreateChain) Type 

func (SyntheticCreateChain) Type() protocol.TransactionType

func (SyntheticCreateChain) Validate 

func (SyntheticCreateChain) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type SyntheticDepositCredits 

type SyntheticDepositCredits struct{}

func (SyntheticDepositCredits) Type 

func (SyntheticDepositCredits) Type() protocol.TransactionType

func (SyntheticDepositCredits) Validate 

func (SyntheticDepositCredits) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type SyntheticDepositTokens 

type SyntheticDepositTokens struct{}

func (SyntheticDepositTokens) Type 

func (SyntheticDepositTokens) Type() protocol.TransactionType

func (SyntheticDepositTokens) Validate 

func (SyntheticDepositTokens) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type SyntheticMirror 

type SyntheticMirror struct{}

func (SyntheticMirror) Type 

func (SyntheticMirror) Type() protocol.TransactionType

func (SyntheticMirror) Validate 

func (SyntheticMirror) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type SyntheticWriteData 

type SyntheticWriteData struct{}

func (SyntheticWriteData) Type 

func (SyntheticWriteData) Type() protocol.TransactionType

func (SyntheticWriteData) Validate 

func (SyntheticWriteData) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type TxExecutor 

type TxExecutor interface {
	// Type is the transaction type the executor can execute.
	Type() protocol.TransactionType

	// Validate fully validates and executes the transaction.
	Validate(*StateManager, *protocol.Envelope) (protocol.TransactionResult, error)
}

TxExecutor executes a specific type of transaction.

type UpdateKeyPage 

type UpdateKeyPage struct{}

func (UpdateKeyPage) Type 

func (UpdateKeyPage) Type() protocol.TransactionType

func (UpdateKeyPage) Validate 

func (UpdateKeyPage) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type UpdateManager 

type UpdateManager struct{}

func (UpdateManager) Type 

func (UpdateManager) Type() protocol.TransactionType

func (UpdateManager) Validate 

func (UpdateManager) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type UpdateValidatorKey added in v0.5.1 

type UpdateValidatorKey struct{}

func (UpdateValidatorKey) Type added in v0.5.1 

func (UpdateValidatorKey) Type() protocol.TransactionType

func (UpdateValidatorKey) Validate added in v0.5.1 

func (UpdateValidatorKey) Validate(st *StateManager, env *protocol.Envelope) (protocol.TransactionResult, error)

type Value 

type Value interface {
	Get() ([]byte, error)
	Put([]byte) error
}

type WriteData 

type WriteData struct{}

func (WriteData) Type 

func (WriteData) Type() protocol.TransactionType

func (WriteData) Validate 

func (WriteData) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

type WriteDataTo 

type WriteDataTo struct{}

func (WriteDataTo) Type 

func (WriteDataTo) Type() protocol.TransactionType

func (WriteDataTo) Validate 

func (WriteDataTo) Validate(st *StateManager, tx *protocol.Envelope) (protocol.TransactionResult, error)

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.