emulator

Documentation

Overview

Package emulator provides helpful wrappers around flow-cli packages and types, providing a high-level interface for common flow development tasks such as running an emulator with non-default configuration settings, creating accounts, deploying contracts, replacing import statements in cadence files, and sending transactions and script executions to the emulator.

Index

• Variables
• func GetProjectAccount(proj *flowkit.State, name string) (*flowkit.Account, error)
• func NewServer(cfg *Config) *server.EmulatorServer
• func NewServerWithOpts(opts *Opts) (*server.EmulatorServer, error)
• func ServerConf(cfg *Config) *server.Config
• type Account
• type Client
  • func NewClient(cfg *Config) (*Client, error)
  • func (client *Client) AccountCfg(name string) (*flowkit.Account, error)
  • func (client *Client) CreateAccount(name string) (*Account, error)
  • func (client *Client) CreateAccounts(names ...string) (map[string]*Account, error)
  • func (client *Client) DeployProject(update bool) ([]*contracts.Contract, error)
  • func (client *Client) EventsWatch(ctx context.Context, req EventsWatchReq) <-chan []TxResult
  • func (client *Client) FetchEvents(ctx context.Context, req flowClient.EventRangeQuery) ([]TxResult, error)
  • func (client *Client) GetAccount(name string) (*Account, error)
  • func (client *Client) ResolveCode(code string, codepath string) ([]byte, error)
  • func (client *Client) ResolveImports(code []byte, codepath string) ([]byte, error)
  • func (client *Client) ScriptExec(req ScriptExecReq) (cadence.Value, error)
  • func (client *Client) TxBuild(req TxBuildReq) (*flowkit.Transaction, error)
  • func (client *Client) TxSend(req TxSendReq) (*flow.Transaction, *flow.TransactionResult, error)
  • func (client *Client) TxSetCode(req TxSetCodeReq, tx *flowkit.Transaction) error
  • func (client *Client) TxSign(tx *flowkit.Transaction, req TxSignReq) error
• type Config
  • func LoadConfig(opts *Opts) (*Config, error)
• type Emu
  • func NewEmu(opts *Opts) (*Emu, error)
• type EventsFetchReq
• type EventsWatchReq
• type Opts
• type ScriptExecReq
• type TxBuildReq
• type TxResult
• type TxSendReq
• type TxSetCodeReq
• type TxSignReq

Variables

var OptsDefault = Opts{
	Name:                `default`,
	NetName:             `emulator`,
	ConfigPaths:         []string{`flow.json`},
	LogLevel:            logrus.InfoLevel,
	LogLevelClient:      output.InfoLog,
	StorageLimitEnabled: true,
	ClientOnly:          false,
	RESTPort:            38555,
	AdminPort:           38556,
}

Functions

func GetProjectAccount

func GetProjectAccount(proj *flowkit.State, name string) (*flowkit.Account, error)

func NewServer

func NewServer(cfg *Config) *server.EmulatorServer

func NewServerWithOpts

func NewServerWithOpts(opts *Opts) (*server.EmulatorServer, error)

func ServerConf

func ServerConf(cfg *Config) *server.Config

Types

type Account

type Account struct {
	Name    string
	Key     crypto.PrivateKey
	Account *flow.Account
}

type Client

type Client struct {
	Net      *config.Network
	Gateway  *gateway.GrpcGateway
	Services *services.Services
	Logger   output.Logger
	Config   *Config
	Flow     *flowClient.Client
}

func NewClient

func NewClient(cfg *Config) (*Client, error)

func (*Client) AccountCfg

func (client *Client) AccountCfg(name string) (*flowkit.Account, error)

func (*Client) CreateAccount

func (client *Client) CreateAccount(name string) (*Account, error)

func (*Client) CreateAccounts

func (client *Client) CreateAccounts(names ...string) (map[string]*Account, error)

func (*Client) DeployProject

func (client *Client) DeployProject(update bool) ([]*contracts.Contract, error)

func (*Client) EventsWatch

func (client *Client) EventsWatch(ctx context.Context, req EventsWatchReq) <-chan []TxResult

func (*Client) FetchEvents

func (client *Client) FetchEvents(ctx context.Context, req flowClient.EventRangeQuery) ([]TxResult, error)

func (*Client) GetAccount

func (client *Client) GetAccount(name string) (*Account, error)

func (*Client) ResolveCode

func (client *Client) ResolveCode(code string, codepath string) ([]byte, error)

func (*Client) ResolveImports

func (client *Client) ResolveImports(code []byte, codepath string) ([]byte, error)

func (*Client) ScriptExec

func (client *Client) ScriptExec(req ScriptExecReq) (cadence.Value, error)

func (*Client) TxBuild

func (client *Client) TxBuild(req TxBuildReq) (*flowkit.Transaction, error)

func (*Client) TxSend

func (client *Client) TxSend(req TxSendReq) (*flow.Transaction, *flow.TransactionResult, error)

func (*Client) TxSetCode

func (client *Client) TxSetCode(req TxSetCodeReq, tx *flowkit.Transaction) error

func (*Client) TxSign

func (client *Client) TxSign(tx *flowkit.Transaction, req TxSignReq) error

type Config

type Config struct {
	Opts           *Opts
	Proj           *flowkit.State
	Emulator       *config.Emulator
	ServiceAccount *flowkit.Account
	PrivateKey     crypto.PrivateKey
	SigAlgo        crypto.SignatureAlgorithm
	HashAlgo       crypto.HashAlgorithm
}

func LoadConfig

func LoadConfig(opts *Opts) (*Config, error)

type Emu

type Emu struct {
	Config *Config
	Server *server.EmulatorServer
	Client *Client
}

func NewEmu

func NewEmu(opts *Opts) (*Emu, error)

type EventsFetchReq

type EventsFetchReq struct {
	Type        string
	StartHeight uint64
	EndHeight   uint64
}

type EventsWatchReq

type EventsWatchReq struct {
	Type        string
	StartHeight uint64
}

type Opts

type Opts struct {
	Name                string
	NetName             string
	ConfigPaths         []string
	LogLevel            logrus.Level
	LogLevelClient      int
	StorageLimitEnabled bool
	ClientOnly          bool
	RESTPort            int
	AdminPort           int
}

type ScriptExecReq

type ScriptExecReq struct {
	Code     string
	Codepath string
	Args     []string
	ArgsJSON string
}

type TxBuildReq

type TxBuildReq struct {
	Account  string // Config account name, overridden by Payer, Proposer, and Authorizers
	GasLimit uint64
	Payer    string // Config account name, overrides Account
	Proposer string // Config account name, overrides Account

}

type TxResult

type TxResult struct {
	BlockID flow.Identifier
	Height  uint64
	TxID    flow.Identifier
	Events  []flow.Event
	Err     error
}

type TxSendReq

type TxSendReq struct {
	Account     string // Config account name, overridden by Payer, Proposer, and Authorizers
	GasLimit    uint64
	Code        string
	Codepath    string
	Args        []string
	ArgsJSON    string
	Payer       string   // Config account name, overrides Account
	Proposer    string   // Config account name, overrides Account
	Authorizers []string // Config account names, overrides Account
	Signer      string   // Config account name, overrides Account
}

type TxSetCodeReq

type TxSetCodeReq struct {
	Code     string
	Codepath string
	Args     []string
	ArgsJSON string
}

type TxSignReq

type TxSignReq struct {
	Account     string   // Config account name, overridden by Payer, Proposer, and Authorizers
	Authorizers []string // Config account names, overrides Account
	Signer      string   // Config account name, overrides Account
}