evm

package
v0.6.0 Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2021 License: LGPL-3.0 Imports: 65 Imported by: 32

Documentation

Overview

(c) 2019-2020, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

(c) 2019-2020, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Index

Constants

View Source 
const (
	GenesisTestAddr = "0x751a0b96e1042bee789452ecb20253fba40dbe85"
	GenesisTestKey  = "0xabd71b35d559563fea757f0f5edbde286fb8c043105b15abb7cd57189306d7d1"
)

test constants

Variables

View Source 
var (
	TxBytesGas   uint64 = 1
	EVMOutputGas uint64 = (common.AddressLength + wrappers.LongLen + hashing.HashLen) * TxBytesGas
	EVMInputGas  uint64 = (common.AddressLength+wrappers.LongLen+hashing.HashLen+wrappers.LongLen)*TxBytesGas + secp256k1fx.CostPerSignature
)

Constants for calculating the gas consumed by atomic transactions

View Source 
var (

	// GitCommit is set by the build script
	GitCommit string
	// Version is the version of Coreth
	Version string
)
View Source 
var Codec codec.Manager

Codec does serialization and deserialization

View Source 
var (
	// ID this VM should be referenced by
	ID = ids.ID{'e', 'v', 'm'}
)

Functions

func FormatEthAddress added in v0.3.5 

func FormatEthAddress(addr common.Address) string

FormatEthAddress formats [addr] into a string

func GetEthAddress added in v0.2.12 

func GetEthAddress(privKey *crypto.PrivateKeySECP256K1R) common.Address

GetEthAddress returns the ethereum address derived from [privKey]

func IsSortedAndUniqueEVMInputs added in v0.3.5 

func IsSortedAndUniqueEVMInputs(inputs []EVMInput) bool

IsSortedAndUniqueEVMInputs returns true if the EVM Inputs are sorted and unique based on the account addresses

func IsSortedAndUniqueEVMOutputs added in v0.3.5 

func IsSortedAndUniqueEVMOutputs(outputs []EVMOutput) bool

IsSortedAndUniqueEVMOutputs returns true if the EVMOutputs are sorted and unique based on the account addresses and assetIDs

func IsSortedEVMOutputs added in v0.4.0 

func IsSortedEVMOutputs(outputs []EVMOutput) bool

IsSortedEVMOutputs returns true if the EVMOutputs are sorted based on the account addresses and assetIDs

func ParseEthAddress added in v0.3.5 

func ParseEthAddress(addrStr string) (common.Address, error)

ParseEthAddress parses [addrStr] and returns an Ethereum address

func PublicKeyToEthAddress added in v0.2.12 

func PublicKeyToEthAddress(pubKey *crypto.PublicKeySECP256K1R) common.Address

PublicKeyToEthAddress returns the ethereum address derived from [pubKey]

func SortEVMInputsAndSigners added in v0.3.5 

func SortEVMInputsAndSigners(inputs []EVMInput, signers [][]*crypto.PrivateKeySECP256K1R)

SortEVMInputsAndSigners sorts the list of EVMInputs based on the addresses and assetIDs

func SortEVMOutputs added in v0.3.5 

func SortEVMOutputs(outputs []EVMOutput)

SortEVMOutputs sorts the list of EVMOutputs based on the addresses and assetIDs of the outputs

Types

type AvaxAPI added in v0.2.15 

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

AvaxAPI offers Avalanche network related API methods

func (*AvaxAPI) Export added in v0.3.1 

func (service *AvaxAPI) Export(_ *http.Request, args *ExportArgs, response *api.JSONTxID) error

Export exports an asset from the C-Chain to the X-Chain It must be imported on the X-Chain to complete the transfer

func (*AvaxAPI) ExportAVAX added in v0.2.15 

func (service *AvaxAPI) ExportAVAX(_ *http.Request, args *ExportAVAXArgs, response *api.JSONTxID) error

ExportAVAX exports AVAX from the C-Chain to the X-Chain It must be imported on the X-Chain to complete the transfer

func (*AvaxAPI) ExportKey added in v0.2.15 

func (service *AvaxAPI) ExportKey(r *http.Request, args *ExportKeyArgs, reply *ExportKeyReply) error

ExportKey returns a private key from the provided user

func (*AvaxAPI) GetAtomicTx added in v0.5.2 

func (service *AvaxAPI) GetAtomicTx(r *http.Request, args *api.GetTxArgs, reply *FormattedTx) error

GetAtomicTx returns the specified transaction

func (*AvaxAPI) GetAtomicTxStatus added in v0.5.2 

func (service *AvaxAPI) GetAtomicTxStatus(r *http.Request, args *api.JSONTxID, reply *GetAtomicTxStatusReply) error

GetAtomicTxStatus returns the status of the specified transaction

func (*AvaxAPI) GetUTXOs added in v0.3.14 

func (service *AvaxAPI) GetUTXOs(r *http.Request, args *api.GetUTXOsArgs, reply *api.GetUTXOsReply) error

GetUTXOs gets all utxos for passed in addresses

func (*AvaxAPI) Import added in v0.3.1 

func (service *AvaxAPI) Import(_ *http.Request, args *ImportArgs, response *api.JSONTxID) error

Import issues a transaction to import AVAX from the X-chain. The AVAX must have already been exported from the X-Chain.

func (*AvaxAPI) ImportAVAX added in v0.2.15 

func (service *AvaxAPI) ImportAVAX(_ *http.Request, args *ImportArgs, response *api.JSONTxID) error

ImportAVAX is a deprecated name for Import.

func (*AvaxAPI) ImportKey added in v0.2.15 

func (service *AvaxAPI) ImportKey(r *http.Request, args *ImportKeyArgs, reply *api.JSONAddress) error

ImportKey adds a private key to the provided user

func (*AvaxAPI) IssueTx added in v0.3.14 

func (service *AvaxAPI) IssueTx(r *http.Request, args *api.FormattedTx, response *api.JSONTxID) error

IssueTx ...

func (*AvaxAPI) Version added in v0.5.4 

func (service *AvaxAPI) Version(r *http.Request, args *struct{}, reply *VersionReply) error

ClientVersion returns the version of the VM running

type Batch 

type Batch struct{ database.Batch }

Batch implements ethdb.Batch

func (Batch) Replay 

func (batch Batch) Replay(w ethdb.KeyValueWriter) error

Replay implements ethdb.Batch

func (Batch) ValueSize added in v0.4.0 

func (batch Batch) ValueSize() int

ValueSize implements ethdb.Batch

type Block 

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

Block implements the snowman.Block interface

func (*Block) Accept 

func (b *Block) Accept() error

Accept implements the snowman.Block interface

func (*Block) Bytes 

func (b *Block) Bytes() []byte

Bytes implements the snowman.Block interface

func (*Block) Height added in v0.3.17 

func (b *Block) Height() uint64

Height implements the snowman.Block interface

func (*Block) ID 

func (b *Block) ID() ids.ID

ID implements the snowman.Block interface

func (*Block) Parent 

func (b *Block) Parent() ids.ID

Parent implements the snowman.Block interface

func (*Block) Reject 

func (b *Block) Reject() error

Reject implements the snowman.Block interface If [b] contains an atomic transaction, attempt to re-issue it

func (*Block) SetStatus added in v0.5.2 

func (b *Block) SetStatus(status choices.Status)

SetStatus implements the InternalBlock interface allowing ChainState to set the status on an existing block

func (*Block) Status 

func (b *Block) Status() choices.Status

Status implements the snowman.Block interface

func (*Block) String 

func (b *Block) String() string

func (*Block) Timestamp added in v0.5.4 

func (b *Block) Timestamp() time.Time

Timestamp implements the snowman.Block interface

func (*Block) Verify 

func (b *Block) Verify() error

Verify implements the snowman.Block interface

type BlockValidator added in v0.4.0 

type BlockValidator interface {
	SyntacticVerify(b *Block) error
}

type BuildGenesisReply added in v0.3.15 

type BuildGenesisReply struct {
	Bytes    string              `json:"bytes"`
	Encoding formatting.Encoding `json:"encoding"`
}

BuildGenesisReply is the reply from BuildGenesis

type Client added in v0.3.15 

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

Client ...

func NewCChainClient added in v0.3.15 

func NewCChainClient(uri string, requestTimeout time.Duration) *Client

NewCChainClient returns a Client for interacting with the C Chain

func NewClient added in v0.3.15 

func NewClient(uri, chain string, requestTimeout time.Duration) *Client

NewClient returns a Client for interacting with EVM chain

func (*Client) Export added in v0.3.15 

func (c *Client) Export(
	user api.UserPass,
	amount uint64,
	to string,
	assetID string,
) (ids.ID, error)

Export sends an asset from this chain to the P/C-Chain. After this tx is accepted, the AVAX must be imported to the P/C-chain with an importTx. Returns the ID of the newly created atomic transaction

func (*Client) ExportAVAX added in v0.3.15 

func (c *Client) ExportAVAX(
	user api.UserPass,
	amount uint64,
	to string,
) (ids.ID, error)

ExportAVAX sends AVAX from this chain to the address specified by [to]. Returns the ID of the newly created atomic transaction

func (*Client) ExportKey added in v0.3.15 

func (c *Client) ExportKey(user api.UserPass, addr string) (string, string, error)

ExportKey returns the private key corresponding to [addr] controlled by [user] in both Avalanche standard format and hex format

func (*Client) GetAtomicTx added in v0.5.2 

func (c *Client) GetAtomicTx(txID ids.ID) ([]byte, error)

GetAtomicTx returns the byte representation of [txID]

func (*Client) GetAtomicTxStatus added in v0.5.2 

func (c *Client) GetAtomicTxStatus(txID ids.ID) (Status, error)

GetAtomicTxStatus returns the status of [txID]

func (*Client) GetAtomicUTXOs added in v0.5.2 

func (c *Client) GetAtomicUTXOs(addrs []string, sourceChain string, limit uint32, startAddress, startUTXOID string) ([][]byte, api.Index, error)

GetAtomicUTXOs returns the byte representation of the atomic UTXOs controlled by [addresses] from [sourceChain]

func (*Client) Import added in v0.3.15 

func (c *Client) Import(user api.UserPass, to, sourceChain string) (ids.ID, error)

Import sends an import transaction to import funds from [sourceChain] and returns the ID of the newly created transaction

func (*Client) ImportKey added in v0.3.15 

func (c *Client) ImportKey(user api.UserPass, privateKey string) (string, error)

ImportKey imports [privateKey] to [user]

func (*Client) IssueTx added in v0.3.15 

func (c *Client) IssueTx(txBytes []byte) (ids.ID, error)

IssueTx issues a transaction to a node and returns the TxID

func (*Client) ListAddresses added in v0.3.15 

func (c *Client) ListAddresses(user api.UserPass) ([]string, error)

ListAddresses returns all addresses on this chain controlled by [user]

type Config added in v0.5.4 

type Config struct {
	// Coreth APIs
	SnowmanAPIEnabled     bool `json:"snowman-api-enabled"`
	CorethAdminAPIEnabled bool `json:"coreth-admin-api-enabled"`
	NetAPIEnabled         bool `json:"net-api-enabled"`

	// Continuous Profiler
	ContinuousProfilerDir       string   `json:"continuous-profiler-dir"`       // If set to non-empty string creates a continuous profiler
	ContinuousProfilerFrequency Duration `json:"continuous-profiler-frequency"` // Frequency to run continuous profiler if enabled
	ContinuousProfilerMaxFiles  int      `json:"continuous-profiler-max-files"` // Maximum number of files to maintain

	// Coreth API Gas/Price Caps
	RPCGasCap   uint64  `json:"rpc-gas-cap"`
	RPCTxFeeCap float64 `json:"rpc-tx-fee-cap"`

	// Eth APIs
	EthAPIEnabled      bool `json:"eth-api-enabled"`
	PersonalAPIEnabled bool `json:"personal-api-enabled"`
	TxPoolAPIEnabled   bool `json:"tx-pool-api-enabled"`
	DebugAPIEnabled    bool `json:"debug-api-enabled"`
	Web3APIEnabled     bool `json:"web3-api-enabled"`

	// Eth Settings
	Pruning        bool `json:"pruning-enabled"`
	SnapshotAsync  bool `json:"snapshot-async"`
	SnapshotVerify bool `json:"snapshot-verification-enabled"`

	LocalTxsEnabled         bool     `json:"local-txs-enabled"`
	APIMaxDuration          Duration `json:"api-max-duration"`
	MaxBlocksPerRequest     int64    `json:"api-max-blocks-per-request"`
	AllowUnfinalizedQueries bool     `json:"allow-unfinalized-queries"`

	// Keystore Settings
	KeystoreDirectory             string `json:"keystore-directory"` // both absolute and relative supported
	KeystoreExternalSigner        string `json:"keystore-external-signer"`
	KeystoreInsecureUnlockAllowed bool   `json:"keystore-insecure-unlock-allowed"`
}

Config ...

func (Config) EthAPIs added in v0.5.4 

func (c Config) EthAPIs() []string

EthAPIs returns an array of strings representing the Eth APIs that should be enabled

func (Config) EthBackendSettings added in v0.5.4 

func (c Config) EthBackendSettings() eth.Settings

func (*Config) SetDefaults added in v0.5.4 

func (c *Config) SetDefaults()

type Database 

type Database struct{ database.Database }

Database implements ethdb.Database

func (Database) Ancient 

func (db Database) Ancient(kind string, number uint64) ([]byte, error)

Ancient returns an error as we don't have a backing chain freezer.

func (Database) AncientSize 

func (db Database) AncientSize(kind string) (uint64, error)

AncientSize returns an error as we don't have a backing chain freezer.

func (Database) Ancients 

func (db Database) Ancients() (uint64, error)

Ancients returns an error as we don't have a backing chain freezer.

func (Database) AppendAncient 

func (db Database) AppendAncient(number uint64, hash, header, body, receipts, td []byte) error

AppendAncient returns an error as we don't have a backing chain freezer.

func (Database) HasAncient 

func (db Database) HasAncient(kind string, number uint64) (bool, error)

HasAncient returns an error as we don't have a backing chain freezer.

func (Database) NewBatch 

func (db Database) NewBatch() ethdb.Batch

NewBatch implements ethdb.Database

func (Database) NewIterator 

func (db Database) NewIterator(prefix []byte, start []byte) ethdb.Iterator

NewIterator implements ethdb.Database

Note: This method assumes that the prefix is NOT part of the start, so there's no need for the caller to prepend the prefix to the start.

func (Database) NewIteratorWithStart 

func (db Database) NewIteratorWithStart(start []byte) ethdb.Iterator

NewIteratorWithStart implements ethdb.Database

func (Database) Sync 

func (db Database) Sync() error

Sync returns an error as we don't have a backing chain freezer.

func (Database) TruncateAncients 

func (db Database) TruncateAncients(items uint64) error

TruncateAncients returns an error as we don't have a backing chain freezer.

type Duration added in v0.5.4 

type Duration struct {
	time.Duration
}

func (*Duration) UnmarshalJSON added in v0.5.4 

func (d *Duration) UnmarshalJSON(data []byte) (err error)

type EVMInput added in v0.2.12 

type EVMInput struct {
	Address common.Address `serialize:"true" json:"address"`
	Amount  uint64         `serialize:"true" json:"amount"`
	AssetID ids.ID         `serialize:"true" json:"assetID"`
	Nonce   uint64         `serialize:"true" json:"nonce"`
}

EVMInput defines an input created from the EVM state to fund export transactions

func (*EVMInput) Verify added in v0.2.12 

func (in *EVMInput) Verify() error

Verify ...

type EVMOutput added in v0.2.12 

type EVMOutput struct {
	Address common.Address `serialize:"true" json:"address"`
	Amount  uint64         `serialize:"true" json:"amount"`
	AssetID ids.ID         `serialize:"true" json:"assetID"`
}

EVMOutput defines an output that is added to the EVM state created by import transactions

func (*EVMOutput) Verify added in v0.2.12 

func (out *EVMOutput) Verify() error

Verify ...

type ExportAVAXArgs added in v0.2.12 

type ExportAVAXArgs struct {
	api.UserPass

	// Fee that should be used when creating the tx
	BaseFee *hexutil.Big `json:"baseFee"`

	// Amount of asset to send
	Amount json.Uint64 `json:"amount"`

	// ID of the address that will receive the AVAX. This address includes the
	// chainID, which is used to determine what the destination chain is.
	To string `json:"to"`
}

ExportAVAXArgs are the arguments to ExportAVAX

type ExportArgs added in v0.3.1 

type ExportArgs struct {
	ExportAVAXArgs
	// AssetID of the tokens
	AssetID string `json:"assetID"`
}

ExportArgs are the arguments to Export

type ExportKeyArgs added in v0.2.12 

type ExportKeyArgs struct {
	api.UserPass
	Address string `json:"address"`
}

ExportKeyArgs are arguments for ExportKey

type ExportKeyReply added in v0.2.12 

type ExportKeyReply struct {
	// The decrypted PrivateKey for the Address provided in the arguments
	PrivateKey    string `json:"privateKey"`
	PrivateKeyHex string `json:"privateKeyHex"`
}

ExportKeyReply is the response for ExportKey

type Factory 

type Factory struct{}

func (*Factory) New 

func (f *Factory) New(*snow.Context) (interface{}, error)

type FormattedTx added in v0.5.2 

type FormattedTx struct {
	api.FormattedTx
	BlockHeight *json.Uint64 `json:"blockHeight,omitempty"`
}

type GetAcceptedFrontReply 

type GetAcceptedFrontReply struct {
	Hash   common.Hash `json:"hash"`
	Number *big.Int    `json:"number"`
}

GetAcceptedFrontReply defines the reply that will be sent from the GetAcceptedFront API call

type GetAtomicTxStatusReply added in v0.5.2 

type GetAtomicTxStatusReply struct {
	Status      Status       `json:"status"`
	BlockHeight *json.Uint64 `json:"blockHeight,omitempty"`
}

GetAtomicTxStatusReply defines the GetAtomicTxStatus replies returned from the API

type ImportArgs added in v0.3.1 

type ImportArgs struct {
	api.UserPass

	// Fee that should be used when creating the tx
	BaseFee *hexutil.Big `json:"baseFee"`

	// Chain the funds are coming from
	SourceChain string `json:"sourceChain"`

	// The address that will receive the imported funds
	To string `json:"to"`
}

ImportArgs are arguments for passing into Import requests

type ImportKeyArgs added in v0.2.12 

type ImportKeyArgs struct {
	api.UserPass
	PrivateKey string `json:"privateKey"`
}

ImportKeyArgs are arguments for ImportKey

type Mempool added in v0.5.2 

type Mempool struct {

	// Pending is a channel of length one, which the mempool ensures has an item on
	// it as long as there is an unissued transaction remaining in [txs]
	Pending chan struct{}
	// contains filtered or unexported fields
}

Mempool is a simple mempool for atomic transactions

func NewMempool added in v0.5.2 

func NewMempool(maxSize int) *Mempool

NewMempool returns a Mempool with [maxSize]

func (*Mempool) AddTx added in v0.5.2 

func (m *Mempool) AddTx(tx *Tx) error

Add attempts to add [tx] to the mempool and returns an error if it could not be addeed to the mempool.

func (*Mempool) CancelCurrentTx added in v0.5.2 

func (m *Mempool) CancelCurrentTx()

CancelCurrentTx marks the attempt to issue [currentTx] as being aborted. If this is called after a buildBlock error caused by the atomic transaction, then DiscardCurrentTx should have been called such that this call will have no effect and should not re-issue the invalid tx.

func (*Mempool) DiscardCurrentTx added in v0.5.2 

func (m *Mempool) DiscardCurrentTx()

DiscardCurrentTx marks [currentTx] as invalid and aborts the attempt to issue it since it failed verification. Adding to Pending should be handled by CancelCurrentTx in this case.

func (*Mempool) GetTx added in v0.5.2 

func (m *Mempool) GetTx(txID ids.ID) (*Tx, bool, bool)

GetTx returns the transaction [txID] if it was issued by this node and returns whether it was dropped and whether it exists.

func (*Mempool) IssueCurrentTx added in v0.5.2 

func (m *Mempool) IssueCurrentTx()

IssueCurrentTx marks [currentTx] as issued if there is one

func (*Mempool) Len added in v0.5.2 

func (m *Mempool) Len() int

Len returns the number of transactions in the mempool

func (*Mempool) NextTx added in v0.5.2 

func (m *Mempool) NextTx() (*Tx, bool)

NextTx returns a transaction to be issued from the mempool.

func (*Mempool) RejectTx added in v0.5.2 

func (m *Mempool) RejectTx(txID ids.ID)

RejectTx marks [txID] as being rejected and attempts to re-issue it if it was previously in the mempool.

func (*Mempool) RemoveTx added in v0.5.2 

func (m *Mempool) RemoveTx(txID ids.ID)

RemoveTx removes [txID] from the mempool completely.

type NetAPI 

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

NetAPI offers network related API methods

func (*NetAPI) Listening 

func (s *NetAPI) Listening() bool

Listening returns an indication if the node is listening for network connections.

func (*NetAPI) PeerCount 

func (s *NetAPI) PeerCount() hexutil.Uint

PeerCount returns the number of connected peers

func (*NetAPI) Version 

func (s *NetAPI) Version() string

Version returns the current ethereum protocol version.

type Performance added in v0.3.25 

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

Performance is the API service for coreth performance

func NewPerformanceService added in v0.3.25 

func NewPerformanceService(dir string) *Performance

func (*Performance) LockProfile added in v0.3.25 

func (p *Performance) LockProfile(ctx context.Context) (bool, error)

LockProfile runs a mutex profile writing to the specified file

func (*Performance) MemoryProfile added in v0.3.25 

func (p *Performance) MemoryProfile(ctx context.Context) (bool, error)

MemoryProfile runs a memory profile writing to the specified file

func (*Performance) StartCPUProfiler added in v0.3.25 

func (p *Performance) StartCPUProfiler(ctx context.Context) (bool, error)

StartCPUProfiler starts a cpu profile writing to the specified file

func (*Performance) StopCPUProfiler added in v0.3.25 

func (p *Performance) StopCPUProfiler(ctx context.Context) (bool, error)

StopCPUProfiler stops the cpu profile

type SnowmanAPI 

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

SnowmanAPI introduces snowman specific functionality to the evm

func (*SnowmanAPI) GetAcceptedFront 

func (api *SnowmanAPI) GetAcceptedFront(ctx context.Context) (*GetAcceptedFrontReply, error)

GetAcceptedFront returns the last accepted block's hash and height

func (*SnowmanAPI) IssueBlock added in v0.3.7 

func (api *SnowmanAPI) IssueBlock(ctx context.Context) error

IssueBlock to the chain

type StaticService 

type StaticService struct{}

StaticService defines the static API services exposed by the evm

func (*StaticService) BuildGenesis 

func (*StaticService) BuildGenesis(_ context.Context, args *core.Genesis) (*BuildGenesisReply, error)

BuildGenesis returns the UTXOs such that at least one address in [args.Addresses] is referenced in the UTXO.

type Status added in v0.5.2 

type Status uint32

Status ... 

const (
	Unknown Status = iota
	Dropped
	Processing
	Accepted
)

List of possible status values Unknown Zero value, means the status is not known Dropped means the transaction was in the mempool, but was dropped because it failed verification Processing means the transaction is in the mempool Accepted means the transaction was accepted

func (Status) MarshalJSON added in v0.5.2 

func (s Status) MarshalJSON() ([]byte, error)

MarshalJSON ...

func (Status) String added in v0.5.2 

func (s Status) String() string

func (*Status) UnmarshalJSON added in v0.5.2 

func (s *Status) UnmarshalJSON(b []byte) error

UnmarshalJSON ...

func (Status) Valid added in v0.5.2 

func (s Status) Valid() error

Valid returns nil if the status is a valid status.

type Tx added in v0.2.12 

type Tx struct {
	// The body of this transaction
	UnsignedAtomicTx `serialize:"true" json:"unsignedTx"`

	// The credentials of this transaction
	Creds []verify.Verifiable `serialize:"true" json:"credentials"`
}

Tx is a signed transaction

func (*Tx) Sign added in v0.2.12 

func (tx *Tx) Sign(c codec.Manager, signers [][]*crypto.PrivateKeySECP256K1R) error

Sign this transaction with the provided signers

type UnsignedAtomicTx added in v0.2.12 

type UnsignedAtomicTx interface {
	UnsignedTx

	// UTXOs this tx consumes
	InputUTXOs() ids.Set
	// Attempts to verify this transaction with the provided state.
	SemanticVerify(vm *VM, stx *Tx, parent *Block, baseFee *big.Int, rules params.Rules) error

	// Accept this transaction with the additionally provided state transitions.
	Accept(ctx *snow.Context, batch database.Batch) error

	EVMStateTransfer(ctx *snow.Context, state *state.StateDB) error
}

UnsignedAtomicTx is an unsigned operation that can be atomically accepted

type UnsignedExportTx added in v0.2.12 

type UnsignedExportTx struct {
	avax.Metadata
	// ID of the network on which this tx was issued
	NetworkID uint32 `serialize:"true" json:"networkID"`
	// ID of this blockchain.
	BlockchainID ids.ID `serialize:"true" json:"blockchainID"`
	// Which chain to send the funds to
	DestinationChain ids.ID `serialize:"true" json:"destinationChain"`
	// Inputs
	Ins []EVMInput `serialize:"true" json:"inputs"`
	// Outputs that are exported to the chain
	ExportedOutputs []*avax.TransferableOutput `serialize:"true" json:"exportedOutputs"`
}

UnsignedExportTx is an unsigned ExportTx

func (*UnsignedExportTx) Accept added in v0.2.12 

func (tx *UnsignedExportTx) Accept(ctx *snow.Context, batch database.Batch) error

Accept this transaction.

func (*UnsignedExportTx) Burned added in v0.6.0 

func (tx *UnsignedExportTx) Burned(assetID ids.ID) (uint64, error)

Amount of [assetID] burned by this transaction

func (*UnsignedExportTx) Cost added in v0.6.0 

func (tx *UnsignedExportTx) Cost() (uint64, error)

func (*UnsignedExportTx) EVMStateTransfer added in v0.2.12 

func (tx *UnsignedExportTx) EVMStateTransfer(ctx *snow.Context, state *state.StateDB) error

EVMStateTransfer executes the state update from the atomic export transaction

func (*UnsignedExportTx) InputUTXOs added in v0.2.12 

func (tx *UnsignedExportTx) InputUTXOs() ids.Set

InputUTXOs returns an empty set

func (*UnsignedExportTx) SemanticVerify added in v0.2.12 

func (tx *UnsignedExportTx) SemanticVerify(
	vm *VM,
	stx *Tx,
	_ *Block,
	baseFee *big.Int,
	rules params.Rules,
) error

SemanticVerify this transaction is valid.

func (*UnsignedExportTx) Verify added in v0.2.12 

func (tx *UnsignedExportTx) Verify(
	avmID ids.ID,
	ctx *snow.Context,
	rules params.Rules,
) error

Verify this transaction is well-formed

type UnsignedImportTx added in v0.2.12 

type UnsignedImportTx struct {
	avax.Metadata
	// ID of the network on which this tx was issued
	NetworkID uint32 `serialize:"true" json:"networkID"`
	// ID of this blockchain.
	BlockchainID ids.ID `serialize:"true" json:"blockchainID"`
	// Which chain to consume the funds from
	SourceChain ids.ID `serialize:"true" json:"sourceChain"`
	// Inputs that consume UTXOs produced on the chain
	ImportedInputs []*avax.TransferableInput `serialize:"true" json:"importedInputs"`
	// Outputs
	Outs []EVMOutput `serialize:"true" json:"outputs"`
}

UnsignedImportTx is an unsigned ImportTx

func (*UnsignedImportTx) Accept added in v0.2.12 

func (tx *UnsignedImportTx) Accept(ctx *snow.Context, batch database.Batch) error

Accept this transaction and spend imported inputs We spend imported UTXOs here rather than in semanticVerify because we don't want to remove an imported UTXO in semanticVerify only to have the transaction not be Accepted. This would be inconsistent. Recall that imported UTXOs are not kept in a versionDB.

func (*UnsignedImportTx) Burned added in v0.6.0 

func (tx *UnsignedImportTx) Burned(assetID ids.ID) (uint64, error)

Amount of [assetID] burned by this transaction

func (*UnsignedImportTx) Cost added in v0.6.0 

func (tx *UnsignedImportTx) Cost() (uint64, error)

func (*UnsignedImportTx) EVMStateTransfer added in v0.2.12 

func (tx *UnsignedImportTx) EVMStateTransfer(ctx *snow.Context, state *state.StateDB) error

EVMStateTransfer performs the state transfer to increase the balances of accounts accordingly with the imported EVMOutputs

func (*UnsignedImportTx) InputUTXOs added in v0.2.12 

func (tx *UnsignedImportTx) InputUTXOs() ids.Set

InputUTXOs returns the UTXOIDs of the imported funds

func (*UnsignedImportTx) SemanticVerify added in v0.2.12 

func (tx *UnsignedImportTx) SemanticVerify(
	vm *VM,
	stx *Tx,
	parent *Block,
	baseFee *big.Int,
	rules params.Rules,
) error

SemanticVerify this transaction is valid.

func (*UnsignedImportTx) Verify added in v0.2.12 

func (tx *UnsignedImportTx) Verify(
	avmID ids.ID,
	ctx *snow.Context,
	rules params.Rules,
) error

Verify this transaction is well-formed

type UnsignedTx added in v0.2.12 

type UnsignedTx interface {
	Initialize(unsignedBytes, signedBytes []byte)
	ID() ids.ID
	Cost() (uint64, error)
	UnsignedBytes() []byte
	Bytes() []byte
}

UnsignedTx is an unsigned transaction

type VM 

type VM struct {

	// *chain.State helps to implement the VM interface by wrapping blocks
	// with an efficient caching layer.
	*chain.State
	// contains filtered or unexported fields
}

VM implements the snowman.ChainVM interface

func (*VM) Bootstrapped added in v0.2.4 

func (vm *VM) Bootstrapped() error

Bootstrapped notifies this VM that the consensus engine has finished bootstrapping

func (*VM) Bootstrapping added in v0.2.4 

func (vm *VM) Bootstrapping() error

Bootstrapping notifies this VM that the consensus engine is performing bootstrapping

func (*VM) Clock added in v0.2.12 

func (vm *VM) Clock() *timer.Clock

Clock implements the secp256k1fx interface

func (*VM) Codec added in v0.2.12 

func (vm *VM) Codec() codec.Manager

Codec implements the secp256k1fx interface

func (*VM) CodecRegistry added in v0.3.15 

func (vm *VM) CodecRegistry() codec.Registry

CodecRegistry implements the secp256k1fx interface

func (*VM) Connected added in v0.5.4 

func (vm *VM) Connected(id ids.ShortID) error

func (*VM) CreateHandlers 

func (vm *VM) CreateHandlers() (map[string]*commonEng.HTTPHandler, error)

CreateHandlers makes new http handlers that can handle API calls

func (*VM) CreateStaticHandlers 

func (vm *VM) CreateStaticHandlers() (map[string]*commonEng.HTTPHandler, error)

CreateStaticHandlers makes new http handlers that can handle API calls

func (*VM) Disconnected added in v0.5.4 

func (vm *VM) Disconnected(id ids.ShortID) error

func (*VM) FormatAddress added in v0.3.14 

func (vm *VM) FormatAddress(chainID ids.ID, addr ids.ShortID) (string, error)

FormatAddress takes in a chainID and a raw address and produces the formatted address

func (*VM) FormatLocalAddress added in v0.3.14 

func (vm *VM) FormatLocalAddress(addr ids.ShortID) (string, error)

FormatLocalAddress takes in a raw address and produces the formatted address

func (*VM) GetAtomicUTXOs added in v0.2.12 

func (vm *VM) GetAtomicUTXOs(
	chainID ids.ID,
	addrs ids.ShortSet,
	startAddr ids.ShortID,
	startUTXOID ids.ID,
	limit int,
) ([]*avax.UTXO, ids.ShortID, ids.ID, error)

GetAtomicUTXOs returns the utxos that at least one of the provided addresses is referenced in.

func (*VM) GetCurrentNonce added in v0.4.2 

func (vm *VM) GetCurrentNonce(address common.Address) (uint64, error)

GetCurrentNonce returns the nonce associated with the address at the preferred block

func (*VM) GetSpendableAVAXWithFee added in v0.6.0 

func (vm *VM) GetSpendableAVAXWithFee(
	keys []*crypto.PrivateKeySECP256K1R,
	amount uint64,
	cost uint64,
	baseFee *big.Int,
) ([]EVMInput, [][]*crypto.PrivateKeySECP256K1R, error)

GetSpendableAVAXWithFee returns a list of EVMInputs and keys (in corresponding order) to total [amount] + [fee] of [AVAX] owned by [keys]. This function accounts for the added cost of the additional inputs needed to create the transaction and makes sure to skip any keys with a balance that is insufficient to cover the additional fee. Note: we return [][]*crypto.PrivateKeySECP256K1R even though each input corresponds to a single key, so that the signers can be passed in to [tx.Sign] which supports multiple keys on a single input.

func (*VM) GetSpendableFunds added in v0.3.5 

func (vm *VM) GetSpendableFunds(
	keys []*crypto.PrivateKeySECP256K1R,
	assetID ids.ID,
	amount uint64,
) ([]EVMInput, [][]*crypto.PrivateKeySECP256K1R, error)

GetSpendableFunds returns a list of EVMInputs and keys (in corresponding order) to total [amount] of [assetID] owned by [keys]. Note: we return [][]*crypto.PrivateKeySECP256K1R even though each input corresponds to a single key, so that the signers can be passed in to [tx.Sign] which supports multiple keys on a single input.

func (*VM) HealthCheck added in v0.3.25 

func (vm *VM) HealthCheck() (interface{}, error)

Health returns nil if this chain is healthy. Also returns details, which should be one of: string, []byte, map[string]string

func (*VM) Initialize 

func (vm *VM) Initialize(
	ctx *snow.Context,
	dbManager manager.Manager,
	genesisBytes []byte,
	upgradeBytes []byte,
	configBytes []byte,
	toEngine chan<- commonEng.Message,
	fxs []*commonEng.Fx,
) error

Initialize implements the snowman.ChainVM interface

func (*VM) Logger added in v0.2.12 

func (vm *VM) Logger() logging.Logger

Logger implements the secp256k1fx interface

func (*VM) ParseAddress added in v0.2.12 

func (vm *VM) ParseAddress(addrStr string) (ids.ID, ids.ShortID, error)

ParseAddress takes in an address and produces the ID of the chain it's for the ID of the address

func (*VM) ParseLocalAddress added in v0.3.14 

func (vm *VM) ParseLocalAddress(addrStr string) (ids.ShortID, error)

ParseLocalAddress takes in an address for this chain and produces the ID

func (*VM) SetPreference 

func (vm *VM) SetPreference(blkID ids.ID) error

SetPreference sets what the current tail of the chain is

func (*VM) Shutdown 

func (vm *VM) Shutdown() error

Shutdown implements the snowman.ChainVM interface

func (*VM) Version added in v0.5.4 

func (vm *VM) Version() (string, error)

type VersionReply added in v0.5.4 

type VersionReply struct {
	Version string `json:"version"`
}

type Web3API 

type Web3API struct{}

Web3API offers helper API methods

func (*Web3API) ClientVersion 

func (s *Web3API) ClientVersion() string

ClientVersion returns the version of the vm running

func (*Web3API) Sha3 

func (s *Web3API) Sha3(input hexutil.Bytes) hexutil.Bytes

Sha3 returns the bytes returned by hashing [input] with Keccak256

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.