simulator

Documentation

Index

• func CheckTx(t TB, db *database.Database, exec *Executor, delivery *chain.Delivery) (protocol.TransactionResult, error)
• func DeliverTx(t TB, exec *Executor, block *Block, delivery *chain.Delivery) (*protocol.TransactionStatus, error)
• func ExecuteBlock(t TB, db *database.Database, exec *Executor, block *Block, ...) ([]*protocol.TransactionStatus, error)
• func GetAccount[T protocol.Account](sim *Simulator, accountUrl *url.URL) T
• func InitFromGenesis(t TB, db *database.Database, exec *Executor)
• func InitFromSnapshot(t TB, db *database.Database, exec *Executor, filename string)
• func NormalizeEnvelope(t TB, envelope *protocol.Envelope) []*chain.Delivery
• func Query(t TB, db *database.Database, exec *Executor, req query.Request, prove bool) interface{}
• func RequireSuccess(t TB, results ...*protocol.TransactionStatus)
• type ExecEntry
  • func (s *ExecEntry) Submit(envelopes ...*protocol.Envelope)
  • func (s *ExecEntry) TakeSubmitted() []*protocol.Envelope
• type Simulator
  • func New(t TB, bvnCount int) *Simulator
  • func (s *Simulator) CreateAccount(account protocol.Account)
  • func (s *Simulator) CreateIdentity(identityUrl *url.URL, pubKey ...[]byte)
  • func (s *Simulator) CreateKeyBook(bookUrl *url.URL, pubKey ...[]byte)
  • func (s *Simulator) CreateKeyPage(bookUrl *url.URL, pubKey ...[]byte)
  • func (t Simulator) Errorf(format string, args ...interface{})
  • func (s *Simulator) ExecuteBlock(statusChan chan<- *protocol.TransactionStatus)
  • func (s *Simulator) ExecuteBlocks(n int)
  • func (t Simulator) Fatalf(format string, args ...interface{})
  • func (s *Simulator) InitFromGenesis()
  • func (s *Simulator) InitFromSnapshot(filename func(string) string)
  • func (t Simulator) Logf(format string, args ...interface{})
  • func (s *Simulator) MustSubmitAndExecuteBlock(envelopes ...*protocol.Envelope) []*protocol.Envelope
  • func (s *Simulator) Query(url *url.URL, req query.Request, prove bool) interface{}
  • func (s *Simulator) Router() routing.Router
  • func (s *Simulator) SetRouteFor(account *url.URL, subnet string)
  • func (s *Simulator) Submit(envelopes ...*protocol.Envelope) ([]*protocol.Envelope, error)
  • func (s *Simulator) SubmitAndExecuteBlock(envelopes ...*protocol.Envelope) ([]*protocol.TransactionStatus, error)
  • func (s *Simulator) Subnet(id string) *ExecEntry
  • func (s *Simulator) SubnetFor(url *url.URL) *ExecEntry
  • func (s *Simulator) UpdateAccount(accountUrl *url.URL, fn func(account protocol.Account))
  • func (s *Simulator) WaitForTransactionFlow(statusCheck func(*protocol.TransactionStatus) bool, txnHash []byte) ([]*protocol.TransactionStatus, []*protocol.Transaction)
  • func (s *Simulator) WaitForTransactions(status func(*protocol.TransactionStatus) bool, envelopes ...*protocol.Envelope) ([]*protocol.TransactionStatus, []*protocol.Transaction)
• type TB

Functions

func CheckTx

func CheckTx(t TB, db *database.Database, exec *Executor, delivery *chain.Delivery) (protocol.TransactionResult, error)

func DeliverTx

func DeliverTx(t TB, exec *Executor, block *Block, delivery *chain.Delivery) (*protocol.TransactionStatus, error)

func ExecuteBlock

func ExecuteBlock(t TB, db *database.Database, exec *Executor, block *Block, envelopes ...*protocol.Envelope) ([]*protocol.TransactionStatus, error)

func GetAccount

func GetAccount[T protocol.Account](sim *Simulator, accountUrl *url.URL) T

func InitFromGenesis

func InitFromGenesis(t TB, db *database.Database, exec *Executor)

func InitFromSnapshot

func InitFromSnapshot(t TB, db *database.Database, exec *Executor, filename string)

func NormalizeEnvelope

func NormalizeEnvelope(t TB, envelope *protocol.Envelope) []*chain.Delivery

func Query

func Query(t TB, db *database.Database, exec *Executor, req query.Request, prove bool) interface{}

func RequireSuccess

func RequireSuccess(t TB, results ...*protocol.TransactionStatus)

Types

type ExecEntry

type ExecEntry struct {
	Database *database.Database
	Executor *block.Executor
	API      *client.Client

	// SubmitHook can be used to control how envelopes are submitted to the
	// subnet. It is not safe to change SubmitHook concurrently with calls to
	// Submit.
	SubmitHook func([]*protocol.Envelope) []*protocol.Envelope
	// contains filtered or unexported fields
}

func (*ExecEntry) Submit

func (s *ExecEntry) Submit(envelopes ...*protocol.Envelope)

Submit adds the envelopes to the next block's queue.

By adding transactions to the next block and swaping queues when a block is executed, we roughly simulate the process Tendermint uses to build blocks.

func (*ExecEntry) TakeSubmitted

func (s *ExecEntry) TakeSubmitted() []*protocol.Envelope

TakeSubmitted returns the envelopes for the current block.

type Simulator

type Simulator struct {
	Logger    log.Logger
	Subnets   []config.Subnet
	Executors map[string]*ExecEntry
	// contains filtered or unexported fields
}

func New

func New(t TB, bvnCount int) *Simulator

func (*Simulator) CreateAccount

func (s *Simulator) CreateAccount(account protocol.Account)

func (*Simulator) CreateIdentity

func (s *Simulator) CreateIdentity(identityUrl *url.URL, pubKey ...[]byte)

func (*Simulator) CreateKeyBook

func (s *Simulator) CreateKeyBook(bookUrl *url.URL, pubKey ...[]byte)

func (*Simulator) CreateKeyPage

func (s *Simulator) CreateKeyPage(bookUrl *url.URL, pubKey ...[]byte)

func (Simulator) Errorf

func (t Simulator) Errorf(format string, args ...interface{})

func (*Simulator) ExecuteBlock

func (s *Simulator) ExecuteBlock(statusChan chan<- *protocol.TransactionStatus)

ExecuteBlock executes a block after submitting envelopes. If a status channel is provided, statuses will be sent to the channel as transactions are executed. Once the block is complete, the status channel will be closed (if provided).

func (*Simulator) ExecuteBlocks

func (s *Simulator) ExecuteBlocks(n int)

ExecuteBlocks executes a number of blocks. This is useful for things like waiting for a block to be anchored.

func (Simulator) Fatalf

func (t Simulator) Fatalf(format string, args ...interface{})

func (*Simulator) InitFromGenesis

func (s *Simulator) InitFromGenesis()

func (*Simulator) InitFromSnapshot

func (s *Simulator) InitFromSnapshot(filename func(string) string)

func (Simulator) Logf

func (t Simulator) Logf(format string, args ...interface{})

func (*Simulator) MustSubmitAndExecuteBlock

func (s *Simulator) MustSubmitAndExecuteBlock(envelopes ...*protocol.Envelope) []*protocol.Envelope

MustSubmitAndExecuteBlock executes a block with the envelopes and fails the test if any envelope fails.

func (*Simulator) Query

func (s *Simulator) Query(url *url.URL, req query.Request, prove bool) interface{}

func (*Simulator) Router

func (s *Simulator) Router() routing.Router

func (*Simulator) SetRouteFor

func (s *Simulator) SetRouteFor(account *url.URL, subnet string)

func (*Simulator) Submit

func (s *Simulator) Submit(envelopes ...*protocol.Envelope) ([]*protocol.Envelope, error)

func (*Simulator) SubmitAndExecuteBlock

func (s *Simulator) SubmitAndExecuteBlock(envelopes ...*protocol.Envelope) ([]*protocol.TransactionStatus, error)

SubmitAndExecuteBlock executes a block with the envelopes.

func (*Simulator) Subnet

func (s *Simulator) Subnet(id string) *ExecEntry

func (*Simulator) SubnetFor

func (s *Simulator) SubnetFor(url *url.URL) *ExecEntry

func (*Simulator) UpdateAccount

func (s *Simulator) UpdateAccount(accountUrl *url.URL, fn func(account protocol.Account))

func (*Simulator) WaitForTransactionFlow

func (s *Simulator) WaitForTransactionFlow(statusCheck func(*protocol.TransactionStatus) bool, txnHash []byte) ([]*protocol.TransactionStatus, []*protocol.Transaction)

func (*Simulator) WaitForTransactions

func (s *Simulator) WaitForTransactions(status func(*protocol.TransactionStatus) bool, envelopes ...*protocol.Envelope) ([]*protocol.TransactionStatus, []*protocol.Transaction)

type TB

type TB interface {
	Name() string
	Log(...interface{})
	Fail()
	FailNow()
	Helper()
}