native

package
v0.96.0 Latest Latest
Warning

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

Go to latest
Published: Jul 21, 2021 License: MIT Imports: 49 Imported by: 6

Documentation

Overview

Package native contains Neo native contracts.

Index

Constants

View Source
const (

	// NEOTotalSupply is the total amount of NEO in the system.
	NEOTotalSupply = 100000000
	// DefaultRegisterPrice is default price for candidate register.
	DefaultRegisterPrice = 1000 * GASFactor
)
View Source
const (

	// DefaultOracleRequestPrice is default amount GAS needed for oracle request.
	DefaultOracleRequestPrice = 5000_0000

	// MinimumResponseGas is the minimum response fee permitted for request.
	MinimumResponseGas = 10_000_000
)
View Source
const (

	// DefaultStoragePrice is the price to pay for 1 byte of storage.
	DefaultStoragePrice = 100000
)
View Source
const (

	// DesignationEventName is the name of a designation event.
	DesignationEventName = "Designation"
)
View Source
const GASFactor = NEOTotalSupply

GASFactor is a divisor for finding GAS integral value.

Variables

View Source
var (
	ErrAlreadyDesignated = errors.New("already designated given role at current block")
	ErrEmptyNodeList     = errors.New("node list is empty")
	ErrInvalidIndex      = errors.New("invalid index")
	ErrInvalidRole       = errors.New("invalid role")
	ErrLargeNodeList     = errors.New("node list is too large")
	ErrNoBlock           = errors.New("no persisting block in the context")
)

Various errors.

View Source
var (
	ErrBigArgument      = errors.New("some of the arguments are invalid")
	ErrInvalidWitness   = errors.New("witness check failed")
	ErrLowResponseGas   = errors.New("not enough gas for response")
	ErrNotEnoughGas     = errors.New("gas limit exceeded")
	ErrRequestNotFound  = errors.New("oracle request not found")
	ErrResponseNotFound = errors.New("oracle response not found")
)

Various validation errors.

View Source
var (
	// ErrInvalidBase is returned when base is invalid.
	ErrInvalidBase = errors.New("invalid base")
	// ErrInvalidFormat is returned when string is not a number.
	ErrInvalidFormat = errors.New("invalid format")
	// ErrTooBigInput is returned when input exceeds size limit.
	ErrTooBigInput = errors.New("input is too big")
)

Functions

func BlockToStackItem added in v0.93.0

func BlockToStackItem(b *block.Block) stackitem.Item

BlockToStackItem converts block.Block to stackitem.Item.

func Call added in v0.91.0

func Call(ic *interop.Context) error

Call calls specified native contract method.

func OnPersist added in v0.92.0

func OnPersist(ic *interop.Context) error

OnPersist calls OnPersist methods for all native contracts.

func PostPersist added in v0.92.0

func PostPersist(ic *interop.Context) error

PostPersist calls PostPersist methods for all native contracts.

func ShouldUpdateCommittee added in v0.92.0

func ShouldUpdateCommittee(h uint32, bc blockchainer.Blockchainer) bool

ShouldUpdateCommittee returns true if committee is updated at block h.

func TransactionToStackItem added in v0.93.0

func TransactionToStackItem(t *transaction.Transaction) stackitem.Item

TransactionToStackItem converts transaction.Transaction to stackitem.Item.

Types

type Contracts

type Contracts struct {
	Management *Management
	Ledger     *Ledger
	NEO        *NEO
	GAS        *GAS
	Policy     *Policy
	Oracle     *Oracle
	Designate  *Designate
	Notary     *Notary
	Crypto     *Crypto
	Std        *Std
	Contracts  []interop.Contract
	// contains filtered or unexported fields
}

Contracts is a set of registered native contracts.

func NewContracts

func NewContracts(cfg config.ProtocolConfiguration) *Contracts

NewContracts returns new set of native contracts with new GAS, NEO, Policy, Oracle, Designate and (optional) Notary contracts.

func (*Contracts) ByHash

func (cs *Contracts) ByHash(h util.Uint160) interop.Contract

ByHash returns native contract with the specified hash.

func (*Contracts) ByName added in v0.92.0

func (cs *Contracts) ByName(name string) interop.Contract

ByName returns native contract with the specified name.

func (*Contracts) GetPersistScript

func (cs *Contracts) GetPersistScript() []byte

GetPersistScript returns VM script calling "onPersist" syscall for native contracts.

func (*Contracts) GetPostPersistScript added in v0.92.0

func (cs *Contracts) GetPostPersistScript() []byte

GetPostPersistScript returns VM script calling "postPersist" syscall for native contracts.

type Crypto added in v0.94.0

type Crypto struct {
	interop.ContractMD
}

Crypto represents CryptoLib contract.

func (*Crypto) Initialize added in v0.94.0

func (c *Crypto) Initialize(ic *interop.Context) error

Initialize implements Contract interface.

func (*Crypto) Metadata added in v0.94.0

func (c *Crypto) Metadata() *interop.ContractMD

Metadata implements Contract interface.

func (*Crypto) OnPersist added in v0.94.0

func (c *Crypto) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*Crypto) PostPersist added in v0.94.0

func (c *Crypto) PostPersist(ic *interop.Context) error

PostPersist implements Contract interface.

type Designate added in v0.92.0

type Designate struct {
	interop.ContractMD
	NEO *NEO

	OracleService atomic.Value
	// NotaryService represents Notary node module.
	NotaryService atomic.Value
	// StateRootService represents StateRoot node module.
	StateRootService blockchainer.StateRoot
	// contains filtered or unexported fields
}

Designate represents designation contract.

func (*Designate) DesignateAsRole added in v0.92.0

func (s *Designate) DesignateAsRole(ic *interop.Context, r noderoles.Role, pubs keys.PublicKeys) error

DesignateAsRole sets nodes for role r.

func (*Designate) GetDesignatedByRole added in v0.92.0

func (s *Designate) GetDesignatedByRole(d dao.DAO, r noderoles.Role, index uint32) (keys.PublicKeys, uint32, error)

GetDesignatedByRole returns nodes for role r.

func (*Designate) GetLastDesignatedHash added in v0.93.0

func (s *Designate) GetLastDesignatedHash(d dao.DAO, r noderoles.Role) (util.Uint160, error)

GetLastDesignatedHash returns last designated hash of a given role.

func (*Designate) Initialize added in v0.92.0

func (s *Designate) Initialize(ic *interop.Context) error

Initialize initializes Oracle contract.

func (*Designate) Metadata added in v0.92.0

func (s *Designate) Metadata() *interop.ContractMD

Metadata returns contract metadata.

func (*Designate) OnPersist added in v0.92.0

func (s *Designate) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*Designate) PostPersist added in v0.92.0

func (s *Designate) PostPersist(ic *interop.Context) error

PostPersist implements Contract interface.

type GAS

type GAS struct {
	NEO *NEO
	// contains filtered or unexported fields
}

GAS represents GAS native contract.

func (*GAS) Decimals

func (c *GAS) Decimals(_ *interop.Context, _ []stackitem.Item) stackitem.Item

func (*GAS) Initialize

func (g *GAS) Initialize(ic *interop.Context) error

Initialize initializes GAS contract.

func (*GAS) Metadata

func (c *GAS) Metadata() *interop.ContractMD

func (*GAS) OnPersist

func (g *GAS) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*GAS) PostPersist added in v0.92.0

func (g *GAS) PostPersist(ic *interop.Context) error

PostPersist implements Contract interface.

func (*GAS) Symbol

func (c *GAS) Symbol(_ *interop.Context, _ []stackitem.Item) stackitem.Item

func (*GAS) TotalSupply

func (c *GAS) TotalSupply(ic *interop.Context, _ []stackitem.Item) stackitem.Item

func (*GAS) Transfer

func (c *GAS) Transfer(ic *interop.Context, args []stackitem.Item) stackitem.Item

func (*GAS) TransferInternal added in v0.91.0

func (c *GAS) TransferInternal(ic *interop.Context, from, to util.Uint160, amount *big.Int, data stackitem.Item) error

TransferInternal transfers NEO between accounts.

type IDList added in v0.92.0

type IDList []uint64

IDList is a list of oracle request IDs.

func (*IDList) FromStackItem added in v0.96.0

func (l *IDList) FromStackItem(it stackitem.Item) error

FromStackItem implements stackitem.Convertible.

func (*IDList) Remove added in v0.92.0

func (l *IDList) Remove(id uint64) bool

Remove removes id from list.

func (IDList) ToStackItem added in v0.96.0

func (l IDList) ToStackItem() (stackitem.Item, error)

ToStackItem implements stackitem.Convertible. It never returns an error.

type Ledger added in v0.93.0

type Ledger struct {
	interop.ContractMD
}

Ledger provides an interface to blocks/transactions storage for smart contracts. It's not a part of the proper chain's state, so it's just a proxy between regular Blockchain/DAO interface and smart contracts.

func (*Ledger) Initialize added in v0.93.0

func (l *Ledger) Initialize(ic *interop.Context) error

Initialize implements Contract interface.

func (*Ledger) Metadata added in v0.93.0

func (l *Ledger) Metadata() *interop.ContractMD

Metadata implements Contract interface.

func (*Ledger) OnPersist added in v0.93.0

func (l *Ledger) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*Ledger) PostPersist added in v0.93.0

func (l *Ledger) PostPersist(ic *interop.Context) error

PostPersist implements Contract interface.

type Management added in v0.92.0

type Management struct {
	interop.ContractMD
	NEO *NEO
	// contains filtered or unexported fields
}

Management is contract-managing native contract.

func (*Management) Deploy added in v0.92.0

func (m *Management) Deploy(d dao.DAO, sender util.Uint160, neff *nef.File, manif *manifest.Manifest) (*state.Contract, error)

Deploy creates contract's hash/ID and saves new contract into the given DAO. It doesn't run _deploy method and doesn't emit notification.

func (*Management) Destroy added in v0.92.0

func (m *Management) Destroy(d dao.DAO, hash util.Uint160) error

Destroy drops given contract from DAO along with its storage. It doesn't emit notification.

func (*Management) GetContract added in v0.92.0

func (m *Management) GetContract(d dao.DAO, hash util.Uint160) (*state.Contract, error)

GetContract returns contract with given hash from given DAO.

func (*Management) GetMinimumDeploymentFee added in v0.92.0

func (m *Management) GetMinimumDeploymentFee(dao dao.DAO) int64

GetMinimumDeploymentFee returns the minimum required fee for contract deploy.

func (*Management) Initialize added in v0.92.0

func (m *Management) Initialize(ic *interop.Context) error

Initialize implements Contract interface.

func (*Management) InitializeCache added in v0.92.0

func (m *Management) InitializeCache(d dao.DAO) error

InitializeCache initializes contract cache with the proper values from storage. Cache initialisation should be done apart from Initialize because Initialize is called only when deploying native contracts.

func (*Management) Metadata added in v0.92.0

func (m *Management) Metadata() *interop.ContractMD

Metadata implements Contract interface.

func (*Management) OnPersist added in v0.92.0

func (m *Management) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*Management) PostPersist added in v0.92.0

func (m *Management) PostPersist(ic *interop.Context) error

PostPersist implements Contract interface.

func (*Management) PutContractState added in v0.92.0

func (m *Management) PutContractState(d dao.DAO, cs *state.Contract) error

PutContractState saves given contract state into given DAO.

func (*Management) Update added in v0.92.0

func (m *Management) Update(d dao.DAO, hash util.Uint160, neff *nef.File, manif *manifest.Manifest) (*state.Contract, error)

Update updates contract's script and/or manifest in the given DAO. It doesn't run _deploy method and doesn't emit notification.

type NEO

type NEO struct {
	GAS *GAS
	// contains filtered or unexported fields
}

NEO represents NEO native contract.

func (*NEO) CalculateBonus added in v0.92.0

func (n *NEO) CalculateBonus(d dao.DAO, acc util.Uint160, end uint32) (*big.Int, error)

CalculateBonus calculates amount of gas generated for holding value NEO from start to end block and having voted for active committee member.

func (*NEO) CalculateNEOHolderReward added in v0.92.0

func (n *NEO) CalculateNEOHolderReward(d dao.DAO, value *big.Int, start, end uint32) (*big.Int, error)

CalculateNEOHolderReward return GAS reward for holding `value` of NEO from start to end block.

func (*NEO) ComputeNextBlockValidators added in v0.92.0

func (n *NEO) ComputeNextBlockValidators(bc blockchainer.Blockchainer, d dao.DAO) (keys.PublicKeys, error)

ComputeNextBlockValidators returns an actual list of current validators.

func (*NEO) Decimals

func (c *NEO) Decimals(_ *interop.Context, _ []stackitem.Item) stackitem.Item

func (*NEO) GetCandidates added in v0.91.0

func (n *NEO) GetCandidates(d dao.DAO) ([]state.Validator, error)

GetCandidates returns current registered validators list with keys and votes.

func (*NEO) GetCommitteeAddress added in v0.92.0

func (n *NEO) GetCommitteeAddress() util.Uint160

GetCommitteeAddress returns address of the committee.

func (*NEO) GetCommitteeMembers added in v0.92.0

func (n *NEO) GetCommitteeMembers() keys.PublicKeys

GetCommitteeMembers returns public keys of nodes in committee using cached value.

func (*NEO) GetGASPerBlock added in v0.92.0

func (n *NEO) GetGASPerBlock(d dao.DAO, index uint32) *big.Int

GetGASPerBlock returns gas generated for block with provided index.

func (*NEO) GetNextBlockValidatorsInternal

func (n *NEO) GetNextBlockValidatorsInternal() keys.PublicKeys

GetNextBlockValidatorsInternal returns next block validators.

func (*NEO) Initialize

func (n *NEO) Initialize(ic *interop.Context) error

Initialize initializes NEO contract.

func (*NEO) InitializeCache added in v0.92.0

func (n *NEO) InitializeCache(bc blockchainer.Blockchainer, d dao.DAO) error

InitializeCache initializes all NEO cache with the proper values from storage. Cache initialisation should be done apart from Initialize because Initialize is called only when deploying native contracts.

func (*NEO) Metadata

func (c *NEO) Metadata() *interop.ContractMD

func (*NEO) ModifyAccountVotes

func (n *NEO) ModifyAccountVotes(acc *state.NEOBalance, d dao.DAO, value *big.Int, isNewVote bool) error

ModifyAccountVotes modifies votes of the specified account by value (can be negative). typ specifies if this modify is occurring during transfer or vote (with old or new validator).

func (*NEO) OnPersist

func (n *NEO) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*NEO) PostPersist added in v0.92.0

func (n *NEO) PostPersist(ic *interop.Context) error

PostPersist implements Contract interface.

func (*NEO) RegisterCandidateInternal added in v0.91.0

func (n *NEO) RegisterCandidateInternal(ic *interop.Context, pub *keys.PublicKey) error

RegisterCandidateInternal registers pub as a new candidate.

func (*NEO) SetGASPerBlock added in v0.92.0

func (n *NEO) SetGASPerBlock(ic *interop.Context, index uint32, gas *big.Int) error

SetGASPerBlock sets gas generated for blocks after index.

func (*NEO) Symbol

func (c *NEO) Symbol(_ *interop.Context, _ []stackitem.Item) stackitem.Item

func (*NEO) TotalSupply

func (c *NEO) TotalSupply(ic *interop.Context, _ []stackitem.Item) stackitem.Item

func (*NEO) Transfer

func (c *NEO) Transfer(ic *interop.Context, args []stackitem.Item) stackitem.Item

func (*NEO) TransferInternal added in v0.91.0

func (c *NEO) TransferInternal(ic *interop.Context, from, to util.Uint160, amount *big.Int, data stackitem.Item) error

TransferInternal transfers NEO between accounts.

func (*NEO) UnregisterCandidateInternal added in v0.91.0

func (n *NEO) UnregisterCandidateInternal(ic *interop.Context, pub *keys.PublicKey) error

UnregisterCandidateInternal unregisters pub as a candidate.

func (*NEO) VoteInternal

func (n *NEO) VoteInternal(ic *interop.Context, h util.Uint160, pub *keys.PublicKey) error

VoteInternal votes from account h for validarors specified in pubs.

type NamedCurve added in v0.94.0

type NamedCurve byte

NamedCurve identifies named elliptic curves.

const (
	Secp256k1 NamedCurve = 22
	Secp256r1 NamedCurve = 23
)

Various named elliptic curves.

type NodeList added in v0.92.0

type NodeList keys.PublicKeys

NodeList represents list or oracle nodes.

func (*NodeList) FromStackItem added in v0.96.0

func (l *NodeList) FromStackItem(it stackitem.Item) error

FromStackItem implements stackitem.Convertible.

func (NodeList) ToStackItem added in v0.96.0

func (l NodeList) ToStackItem() (stackitem.Item, error)

ToStackItem implements stackitem.Convertible. It never returns an error.

type Notary added in v0.92.0

type Notary struct {
	interop.ContractMD
	GAS   *GAS
	NEO   *NEO
	Desig *Designate
	// contains filtered or unexported fields
}

Notary represents Notary native contract.

func (*Notary) BalanceOf added in v0.92.0

func (n *Notary) BalanceOf(dao dao.DAO, acc util.Uint160) *big.Int

BalanceOf is an internal representation of `balanceOf` Notary method.

func (*Notary) ExpirationOf added in v0.92.0

func (n *Notary) ExpirationOf(dao dao.DAO, acc util.Uint160) uint32

ExpirationOf is an internal representation of `expirationOf` Notary method.

func (*Notary) GetDepositFor added in v0.92.0

func (n *Notary) GetDepositFor(dao dao.DAO, acc util.Uint160) *state.Deposit

GetDepositFor returns state.Deposit for the account specified. It returns nil in case if deposit is not found in storage and panics in case of any other error.

func (*Notary) GetMaxNotValidBeforeDelta added in v0.92.0

func (n *Notary) GetMaxNotValidBeforeDelta(dao dao.DAO) uint32

GetMaxNotValidBeforeDelta is an internal representation of Notary getMaxNotValidBeforeDelta method.

func (*Notary) GetNotaryNodes added in v0.92.0

func (n *Notary) GetNotaryNodes(d dao.DAO) (keys.PublicKeys, error)

GetNotaryNodes returns public keys of notary nodes.

func (*Notary) Initialize added in v0.92.0

func (n *Notary) Initialize(ic *interop.Context) error

Initialize initializes Notary native contract and implements Contract interface.

func (*Notary) Metadata added in v0.92.0

func (n *Notary) Metadata() *interop.ContractMD

Metadata implements Contract interface.

func (*Notary) OnPersist added in v0.92.0

func (n *Notary) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*Notary) PostPersist added in v0.92.0

func (n *Notary) PostPersist(ic *interop.Context) error

PostPersist implements Contract interface.

type Oracle added in v0.92.0

type Oracle struct {
	interop.ContractMD
	GAS *GAS
	NEO *NEO

	Desig *Designate

	// Module is an oracle module capable of talking with the external world.
	Module atomic.Value
	// contains filtered or unexported fields
}

Oracle represents Oracle native contract.

func (*Oracle) FinishInternal added in v0.92.0

func (o *Oracle) FinishInternal(ic *interop.Context) error

FinishInternal processes oracle response.

func (*Oracle) GetIDListInternal added in v0.92.0

func (o *Oracle) GetIDListInternal(d dao.DAO, url string) (*IDList, error)

GetIDListInternal returns request by ID and key under which it is stored.

func (*Oracle) GetOracleNodes added in v0.92.0

func (o *Oracle) GetOracleNodes(d dao.DAO) (keys.PublicKeys, error)

GetOracleNodes returns public keys of oracle nodes.

func (*Oracle) GetOracleResponseScript added in v0.93.0

func (o *Oracle) GetOracleResponseScript() []byte

GetOracleResponseScript returns script for transaction with oracle response.

func (*Oracle) GetRequestInternal added in v0.92.0

func (o *Oracle) GetRequestInternal(d dao.DAO, id uint64) (*state.OracleRequest, error)

GetRequestInternal returns request by ID and key under which it is stored.

func (*Oracle) GetScriptHash added in v0.92.0

func (o *Oracle) GetScriptHash(d dao.DAO) (util.Uint160, error)

GetScriptHash returns script hash or oracle nodes.

func (*Oracle) Initialize added in v0.92.0

func (o *Oracle) Initialize(ic *interop.Context) error

Initialize initializes Oracle contract.

func (*Oracle) Metadata added in v0.92.0

func (o *Oracle) Metadata() *interop.ContractMD

Metadata returns contract metadata.

func (*Oracle) OnPersist added in v0.92.0

func (o *Oracle) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*Oracle) PostPersist added in v0.92.0

func (o *Oracle) PostPersist(ic *interop.Context) error

PostPersist represents `postPersist` method.

func (*Oracle) PutRequestInternal added in v0.92.0

func (o *Oracle) PutRequestInternal(id uint64, req *state.OracleRequest, d dao.DAO) error

PutRequestInternal puts oracle request with the specified id to d.

func (*Oracle) RequestInternal added in v0.92.0

func (o *Oracle) RequestInternal(ic *interop.Context, url string, filter *string, cb string, userData stackitem.Item, gas *big.Int) error

RequestInternal processes oracle request.

type Policy

type Policy struct {
	interop.ContractMD
	NEO *NEO
	// contains filtered or unexported fields
}

Policy represents Policy native contract.

func (*Policy) CheckPolicy

func (p *Policy) CheckPolicy(d dao.DAO, tx *transaction.Transaction) error

CheckPolicy checks whether transaction conforms to current policy restrictions like not being signed by blocked account or not exceeding block-level system fee limit.

func (*Policy) GetExecFeeFactorInternal added in v0.92.0

func (p *Policy) GetExecFeeFactorInternal(d dao.DAO) int64

GetExecFeeFactorInternal returns current execution fee factor.

func (*Policy) GetFeePerByteInternal

func (p *Policy) GetFeePerByteInternal(dao dao.DAO) int64

GetFeePerByteInternal returns required transaction's fee per byte.

func (*Policy) GetMaxVerificationGas added in v0.91.0

func (p *Policy) GetMaxVerificationGas(_ dao.DAO) int64

GetMaxVerificationGas returns maximum gas allowed to be burned during verificaion.

func (*Policy) GetStoragePriceInternal added in v0.92.0

func (p *Policy) GetStoragePriceInternal(d dao.DAO) int64

GetStoragePriceInternal returns current execution fee factor.

func (*Policy) Initialize

func (p *Policy) Initialize(ic *interop.Context) error

Initialize initializes Policy native contract and implements Contract interface.

func (*Policy) IsBlockedInternal added in v0.92.0

func (p *Policy) IsBlockedInternal(dao dao.DAO, hash util.Uint160) bool

IsBlockedInternal checks whether provided account is blocked.

func (*Policy) Metadata

func (p *Policy) Metadata() *interop.ContractMD

Metadata implements Contract interface.

func (*Policy) OnPersist

func (p *Policy) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*Policy) PostPersist added in v0.92.0

func (p *Policy) PostPersist(ic *interop.Context) error

PostPersist implements Contract interface.

type Std added in v0.94.0

type Std struct {
	interop.ContractMD
}

Std represents StdLib contract.

func (*Std) Initialize added in v0.94.0

func (s *Std) Initialize(ic *interop.Context) error

Initialize implements Contract interface.

func (*Std) Metadata added in v0.94.0

func (s *Std) Metadata() *interop.ContractMD

Metadata implements Contract interface.

func (*Std) OnPersist added in v0.94.0

func (s *Std) OnPersist(ic *interop.Context) error

OnPersist implements Contract interface.

func (*Std) PostPersist added in v0.94.0

func (s *Std) PostPersist(ic *interop.Context) error

PostPersist implements Contract interface.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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