types

package
v0.0.3-unstable Latest Latest
Warning

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

Go to latest
Published: Feb 15, 2019 License: GPL-3.0 Imports: 14 Imported by: 0

Documentation

Overview

Package types contains data types related to Fractal.

Index

Constants

View Source
const (
	// BloomByteLength represents the number of bytes used in a header log bloom.
	BloomByteLength = 256

	// BloomBitLength represents the number of bits used in a header log bloom.
	BloomBitLength = 8 * BloomByteLength
)
View Source
const (
	// ReceiptStatusFailed is the status code of a action if execution failed.
	ReceiptStatusFailed = uint64(0)

	// ReceiptStatusSuccessful is the status code of a action if execution succeeded.
	ReceiptStatusSuccessful = uint64(1)
)

Variables

View Source
var (
	//ErrInvalidchainID invalid chain id for signer
	ErrInvalidchainID = errors.New("invalid chain id for signer")
	//ErrSigUnprotected signature is considered unprotected
	ErrSigUnprotected = errors.New("signature is considered unprotected")
)
View Source
var Bloom9 = bloom9

Bloom9 export func

View Source
var ErrInvalidSig = errors.New("invalid action v, r, s values")

ErrInvalidSig invalid signature.

Functions

func BloomLookup

func BloomLookup(bin Bloom, topic bytesBacked) bool

BloomLookup look up .

func DeriveReceiptsMerkleRoot

func DeriveReceiptsMerkleRoot(receipts []*Receipt) common.Hash

DeriveReceiptsMerkleRoot returns receiptes merkle tree root hash.

func DeriveTxsMerkleRoot

func DeriveTxsMerkleRoot(txs []*Transaction) common.Hash

DeriveTxsMerkleRoot returns txs merkle tree root hash.

func LogsBloom

func LogsBloom(logs []*Log) *big.Int

LogsBloom create bloom by logs.

func Number

func Number(b1, b2 *Block) bool

Number represents block sort by number.

func Recover

func Recover(signer Signer, a *Action, tx *Transaction) (common.PubKey, error)

Recover returns the pubkey derived from the signature (V, R, S) using secp256k1 elliptic curve and an error if it failed deriving or upon an incorrect signature.

func SignAction

func SignAction(a *Action, tx *Transaction, s Signer, prv *ecdsa.PrivateKey) error

SignAction signs the action using the given signer and private key

Types

type Action

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

Action represents an entire action in the transaction.

func NewAction

func NewAction(actionType ActionType, from, to common.Name, nonce, assetID, gasLimit uint64, amount *big.Int, payload []byte) *Action

NewAction initialize transaction's action.

func (*Action) AssetID

func (a *Action) AssetID() uint64

AssetID returns action's assetID.

func (*Action) ChainID

func (a *Action) ChainID() *big.Int

ChainID returns which chain id this action was signed for (if at all)

func (*Action) Data

func (a *Action) Data() []byte

Data returns action's Data.

func (*Action) DecodeRLP

func (a *Action) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder

func (*Action) EncodeRLP

func (a *Action) EncodeRLP(w io.Writer) error

EncodeRLP implements rlp.Encoder

func (*Action) Gas

func (a *Action) Gas() uint64

Gas returns action's Gas.

func (*Action) Hash

func (a *Action) Hash() common.Hash

Hash hashes the RLP encoding of action.

func (*Action) NewRPCAction

func (a *Action) NewRPCAction(index uint64) *RPCAction

NewRPCAction returns a action that will serialize to the RPC.

func (*Action) Nonce

func (a *Action) Nonce() uint64

Nonce returns action's nonce.

func (*Action) RawSignatureValues

func (a *Action) RawSignatureValues() (*big.Int, *big.Int, *big.Int)

RawSignatureValues return raw signature values.

func (*Action) Recipient

func (a *Action) Recipient() common.Name

Recipient returns action's Recipient.

func (*Action) Sender

func (a *Action) Sender() common.Name

Sender returns action's Sender.

func (*Action) Type

func (a *Action) Type() ActionType

Type returns action's type.

func (*Action) Value

func (a *Action) Value() *big.Int

Value returns action's Value.

func (*Action) WithSignature

func (a *Action) WithSignature(signer Signer, sig []byte) error

WithSignature returns a new transaction with the given signature.

type ActionResult

type ActionResult struct {
	Status  uint64
	Index   uint64
	GasUsed uint64
	Error   string
}

ActionResult represents the results the transaction action.

func (*ActionResult) NewRPCActionResult

func (a *ActionResult) NewRPCActionResult(aType ActionType) *RPCActionResult

NewRPCActionResult returns a ActionResult that will serialize to the RPC.

type ActionType

type ActionType uint64

ActionType type of Action.

const (
	// Transfer represents the ordinary and contract transfer action.
	Transfer ActionType = iota
	// CreateContract repesents the create contract action.
	CreateContract
)
const (
	// CreateAccount repesents the create account.
	CreateAccount ActionType = 0x100 + iota
	// UpdateAccount repesents the update account action.
	UpdateAccount
	// DeleteAccount repesents the delete account action.
	DeleteAccount
)
const (
	// IncreaseAsset Asset operation
	IncreaseAsset ActionType = 0x200 + iota
	// IssueAsset repesents Issue asset action.
	IssueAsset
	// SetAssetOwner repesents set asset new owner action.
	SetAssetOwner
)
const (
	// RegProducer repesents register producer action.
	RegProducer ActionType = 0x300 + iota
	// UpdateProducer repesents update producer action.
	UpdateProducer
	// UnregProducer repesents unregister producer action.
	UnregProducer
	// RemoveVoter repesents producer remove voter action.
	RemoveVoter
	// VoteProducer repesents voter vote producer action.
	VoteProducer
	// ChangeProducer repesents voter change producer action.
	ChangeProducer
	// UnvoteProducer repesents voter cancel vote some producer action.
	UnvoteProducer
)

type Block

type Block struct {
	Head *Header
	Txs  []*Transaction
	// contains filtered or unexported fields
}

Block represents an entire block in the blockchain.

func NewBlock

func NewBlock(header *Header, txs []*Transaction, receipts []*Receipt) *Block

NewBlock creates a new block. The input data is copied, changes to header and to the field values will not affect the block.

func NewBlockWithHeader

func NewBlockWithHeader(header *Header) *Block

NewBlockWithHeader creates a block with the given header data. The header data is copied, changes to header and to the field values will not affect the block.

func (*Block) Body

func (b *Block) Body() *Body

Body returns the block's Body.

func (*Block) Coinbase

func (b *Block) Coinbase() common.Name

Coinbase returns the block's Coinbase.

func (*Block) DecodeRLP

func (b *Block) DecodeRLP(input []byte) error

DecodeRLP decodes the block

func (*Block) Difficulty

func (b *Block) Difficulty() *big.Int

Difficulty returns the block's Difficulty.

func (*Block) EncodeRLP

func (b *Block) EncodeRLP() ([]byte, error)

EncodeRLP serializes b into the RLP block format.

func (*Block) Extra

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

Extra returns the block's Extra.

func (*Block) GasLimit

func (b *Block) GasLimit() uint64

GasLimit returns the block's GasLimit.

func (*Block) GasUsed

func (b *Block) GasUsed() uint64

GasUsed returns the block's GasUsed.

func (*Block) Hash

func (b *Block) Hash() common.Hash

Hash returns the keccak256 hash of b's header. The hash is computed on the first call and cached thereafter.

func (*Block) Header

func (b *Block) Header() *Header

Header returns the block's Header.

func (*Block) Number

func (b *Block) Number() *big.Int

Number returns the block's Number.

func (*Block) NumberU64

func (b *Block) NumberU64() uint64

NumberU64 returns the block's NumberU64.

func (*Block) ParentHash

func (b *Block) ParentHash() common.Hash

ParentHash returns the block's ParentHash.

func (*Block) ReceiptHash

func (b *Block) ReceiptHash() common.Hash

ReceiptHash returns the block's ReceiptHash.

func (*Block) Root

func (b *Block) Root() common.Hash

Root returns the block's Root.

func (*Block) Size

func (b *Block) Size() common.StorageSize

Size returns the true RLP encoded storage size of the block, either by encoding and returning it, or returning a previsouly cached value.

func (*Block) Time

func (b *Block) Time() *big.Int

Time returns the block's Time.

func (*Block) Transactions

func (b *Block) Transactions() []*Transaction

Transactions returns the block's txs.

func (*Block) TxHash

func (b *Block) TxHash() common.Hash

TxHash returns the block's TxHash.

func (*Block) WithBody

func (b *Block) WithBody(transactions []*Transaction) *Block

WithBody returns a new block with the given transaction .

func (*Block) WithSeal

func (b *Block) WithSeal(header *Header) *Block

WithSeal returns a new block with the data from b but the header replaced with the sealed one.

type BlockBy

type BlockBy func(b1, b2 *Block) bool

BlockBy represents the block sort by rule type.

func (BlockBy) Sort

func (bb BlockBy) Sort(blocks Blocks)

Sort sort blocks by BlockBy.

type Blocks

type Blocks []*Block

Blocks represents the blocks.

type Bloom

type Bloom [BloomByteLength]byte

Bloom represents a 2048 bit bloom filter.

func BytesToBloom

func BytesToBloom(b []byte) Bloom

BytesToBloom converts a byte slice to a bloom filter. It panics if b is not of suitable size.

func CreateBloom

func CreateBloom(receipts []*Receipt) Bloom

CreateBloom create bloom by receiptes.

func (*Bloom) Add

func (b *Bloom) Add(d *big.Int)

Add adds d to the filter. Future calls of Test(d) will return true.

func (Bloom) Big

func (b Bloom) Big() *big.Int

Big converts b to a big integer.

func (Bloom) Bytes

func (b Bloom) Bytes() []byte

Bytes converts b to bytes.

func (Bloom) MarshalText

func (b Bloom) MarshalText() ([]byte, error)

MarshalText encodes b as a hex string with 0x prefix.

func (*Bloom) SetBytes

func (b *Bloom) SetBytes(d []byte)

SetBytes sets the content of b to the given bytes. It panics if d is not of suitable size.

func (Bloom) Test

func (b Bloom) Test(test *big.Int) bool

Test use for bloom test .

func (Bloom) TestBytes

func (b Bloom) TestBytes(test []byte) bool

TestBytes use for bloom test .

func (*Bloom) UnmarshalText

func (b *Bloom) UnmarshalText(input []byte) error

UnmarshalText b as a hex string with 0x prefix.

type Body

type Body struct {
	Transactions []*Transaction
}

Body represents an entire body of the block transactions.

type Header struct {
	ParentHash   common.Hash `json:"parentHash"`
	Coinbase     common.Name `json:"miner"`
	Root         common.Hash `json:"stateRoot"`
	TxsRoot      common.Hash `json:"transactionsRoot"`
	ReceiptsRoot common.Hash `json:"receiptsRoot"`
	Bloom        Bloom       `json:"logsBloom"`
	Difficulty   *big.Int    `json:"difficulty"`
	Number       *big.Int    `json:"number"`
	GasLimit     uint64      `json:"gasLimit"`
	GasUsed      uint64      `json:"gasUsed"`
	Time         *big.Int    `json:"timestamp"`
	Extra        []byte      `json:"extraData"`
}

Header represents a block header in the blockchain.

func CopyHeader

func CopyHeader(h *Header) *Header

CopyHeader creates a deep copy of a block header to prevent side effects from modifying a header variable.

func (*Header) Hash

func (h *Header) Hash() common.Hash

Hash returns the block hash of the header, which is simply the keccak256 hash of its RLP encoding.

type KvNode

type KvNode struct {
	Key   string
	Value []byte
}

KvNode represents a status data.

type Log

type Log struct {
	Name        common.Name   // address of the contract that generated the event
	Topics      []common.Hash // list of topics provided by the contract.
	Data        []byte        // supplied by the contract, usually ABI-encoded
	BlockNumber uint64        // block in which the transaction was included
	BlockHash   common.Hash   // hash of the block in which the transaction was included
	TxHash      common.Hash   // hash of the transaction
	Index       uint          // index of the log in the receipt
	ActionIndex uint          // index of the input and output in the transaction
	TxIndex     uint          // index of the transaction in the block

}

Log represents a contract log event. These events are generated by the LOG opcode and stored/indexed by the node.

func (*Log) NewRPCLog

func (l *Log) NewRPCLog() *RPCLog

NewRPCLog returns a log that will serialize to the RPC.

type OptInfo

type OptInfo struct {
	Key   string
	Value []byte
	Opt   uint // record modification status : add/delete/update
}

OptInfo status option info.

type RPCAction

type RPCAction struct {
	Type       uint64        `json:"type"`
	Nonce      uint64        `json:"nonce"`
	From       common.Name   `json:"from"`
	To         common.Name   `json:"to"`
	AssetID    uint64        `json:"assetID"`
	GasLimit   uint64        `json:"gas"`
	Amount     *big.Int      `json:"value"`
	Payload    hexutil.Bytes `json:"payload"`
	V          *hexutil.Big  `json:"v"`
	R          *hexutil.Big  `json:"r"`
	S          *hexutil.Big  `json:"s"`
	Hash       common.Hash   `json:"actionHash"`
	ActionIdex uint64        `json:"actionIndex"`
}

RPCAction represents a action that will serialize to the RPC representation of a action.

type RPCActionResult

type RPCActionResult struct {
	ActionType uint64 `json:"actionType"`
	Status     uint64 `json:"status"`
	Index      uint64 `json:"index"`
	GasUsed    uint64 `json:"gasUsed"`
	Error      string `json:"error"`
}

RPCActionResult that will serialize to the RPC representation of a ActionResult.

type RPCLog

type RPCLog struct {
	Name        common.Name   `json:"name"`
	Topics      []common.Hash `json:"topics"`
	Data        hexutil.Bytes `json:"data" validate:"nonzero"`
	BlockNumber uint64        `json:"blockNumber"`
	BlockHash   common.Hash   `json:"blockHash"`
	TxHash      common.Hash   `json:"transactionHash"`
	Index       uint          `json:"logIndex"`
	ActionIndex uint          `json:"actionIndex"`
	TxIndex     uint          `json:"transactionIndex"`
}

RPCLog that will serialize to the RPC representation of a log.

type RPCReceipt

type RPCReceipt struct {
	BlockHash         common.Hash        `json:"blockHash"`
	BlockNumber       uint64             `json:"blockNumber"`
	Hash              common.Hash        `json:"txHash"`
	TransactionIndex  uint64             `json:"transactionIndex"`
	PostState         hexutil.Bytes      `json:"postState"`
	ActionResults     []*RPCActionResult `json:"actionResults"`
	CumulativeGasUsed uint64             `json:"cumulativeGasUsed"`
	TotalGasUsed      uint64             `json:"totalGasUsed"`
	Bloom             Bloom              `json:"logsBloom"`
	Logs              []*RPCLog          `json:"logs"`
}

RPCReceipt that will serialize to the RPC representation of a Receipt.

type RPCTransaction

type RPCTransaction struct {
	BlockHash        common.Hash  `json:"blockHash"`
	BlockNumber      uint64       `json:"blockNumber"`
	Hash             common.Hash  `json:"txHash"`
	TransactionIndex uint64       `json:"transactionIndex"`
	RPCActions       []*RPCAction `json:"actions"`
	GasAssetID       uint64       `json:"gasAssetID"`
	GasPrice         *big.Int     `json:"gasPrice"`
	GasCost          *big.Int     `json:"gasCost"`
}

RPCTransaction that will serialize to the RPC representation of a transaction.

type Receipt

type Receipt struct {
	PostState         []byte
	ActionResults     []*ActionResult
	CumulativeGasUsed uint64
	Bloom             Bloom
	Logs              []*Log
	TxHash            common.Hash
	TotalGasUsed      uint64
}

Receipt represents the results of a transaction.

func NewReceipt

func NewReceipt(root []byte, cumulativeGasUsed, totalGasUsed uint64) *Receipt

NewReceipt creates a barebone transaction receipt, copying the init fields.

func (*Receipt) Hash

func (r *Receipt) Hash() common.Hash

Hash hashes the RLP encoding of Receipt.

func (*Receipt) NewRPCReceipt

func (r *Receipt) NewRPCReceipt(blockHash common.Hash, blockNumber uint64, index uint64, tx *Transaction) *RPCReceipt

NewRPCReceipt returns a Receipt that will serialize to the RPC.

func (*Receipt) Size

func (r *Receipt) Size() common.StorageSize

Size returns the approximate memory used by all internal contents

type Signer

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

Signer implements Signer .

func MakeSigner

func MakeSigner(chainID *big.Int) Signer

MakeSigner returns a Signer based on the given chainID .

func NewSigner

func NewSigner(chainID *big.Int) Signer

NewSigner initialize signer

func (Signer) Equal

func (s Signer) Equal(s2 Signer) bool

Equal judging the same chainID

func (Signer) Hash

func (s Signer) Hash(tx *Transaction) common.Hash

Hash returns the hash to be signed by the sender.

func (Signer) PubKey

func (s Signer) PubKey(a *Action, tx *Transaction) ([]byte, error)

PubKey return Action sender

func (Signer) SignatureValues

func (s Signer) SignatureValues(sig []byte) (R, S, V *big.Int, err error)

SignatureValues returns a new transaction with the given signature. This signature needs to be in the [R || S || V] format where V is 0 or 1.

type StateOut

type StateOut struct {
	ReadSet    []*KvNode   // replay
	Reverts    []*OptInfo  // rollback previous block
	Changes    []*OptInfo  // forward next block
	ParentHash common.Hash // block parent hash
	Number     uint64      // block num
	Hash       common.Hash // current block hash
}

StateOut represents a block exec status data.

type Transaction

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

Transaction represents an entire transaction in the block.

func NewTransaction

func NewTransaction(assetID uint64, price *big.Int, actions ...*Action) *Transaction

NewTransaction initialize a transaction.

func TxDifference

func TxDifference(a, b []*Transaction) []*Transaction

TxDifference returns a new set which is the difference between a and b.

func (*Transaction) Cost

func (tx *Transaction) Cost() *big.Int

Cost returns all actions gasprice * gaslimit.

func (*Transaction) DecodeRLP

func (tx *Transaction) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder

func (*Transaction) EncodeRLP

func (tx *Transaction) EncodeRLP(w io.Writer) error

EncodeRLP implements rlp.Encoder

func (*Transaction) GasAssetID

func (tx *Transaction) GasAssetID() uint64

GasAssetID returns transaction gas asset id.

func (*Transaction) GasPrice

func (tx *Transaction) GasPrice() *big.Int

GasPrice returns transaction gas price.

func (*Transaction) GetActions

func (tx *Transaction) GetActions() []*Action

GetActions return transaction actons.

func (*Transaction) Hash

func (tx *Transaction) Hash() common.Hash

Hash hashes the RLP encoding of tx.

func (*Transaction) NewRPCTransaction

func (tx *Transaction) NewRPCTransaction(blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction

NewRPCTransaction returns a transaction that will serialize to the RPC.

func (*Transaction) Size

func (tx *Transaction) Size() common.StorageSize

Size returns the true RLP encoded storage size of the transaction,

type TransactionsByPriceAndNonce

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

TransactionsByPriceAndNonce represents a set of transactions that can return transactions in a profit-maximizing sorted order, while supporting removing entire batches of transactions for non-executable accounts.

func NewTransactionsByPriceAndNonce

func NewTransactionsByPriceAndNonce(txs map[common.Name][]*Transaction) *TransactionsByPriceAndNonce

NewTransactionsByPriceAndNonce creates a transaction set that can retrieve price sorted transactions in a nonce-honouring way.

Note, the input map is reowned so the caller should not interact any more with if after providing it to the constructor.

func (*TransactionsByPriceAndNonce) Peek

Peek returns the next transaction by price.

func (*TransactionsByPriceAndNonce) Pop

func (t *TransactionsByPriceAndNonce) Pop()

Pop removes the best transaction, *not* replacing it with the next one from the same account. This should be used when a transaction cannot be executed and hence all subsequent ones should be discarded from the same account.

func (*TransactionsByPriceAndNonce) Shift

func (t *TransactionsByPriceAndNonce) Shift()

Shift replaces the current best head with the next one from the same account.

type TxByNonce

type TxByNonce []*Transaction

TxByNonce sort by transaction first action nonce

func (TxByNonce) Len

func (s TxByNonce) Len() int

func (TxByNonce) Less

func (s TxByNonce) Less(i, j int) bool

func (TxByNonce) Swap

func (s TxByNonce) Swap(i, j int)

type TxByPrice

type TxByPrice []*Transaction

TxByPrice implements both the sort and the heap interface,

func (TxByPrice) Len

func (s TxByPrice) Len() int

func (TxByPrice) Less

func (s TxByPrice) Less(i, j int) bool

func (*TxByPrice) Pop

func (s *TxByPrice) Pop() interface{}

Pop implements heap pop.

func (*TxByPrice) Push

func (s *TxByPrice) Push(x interface{})

Push implements heap push.

func (TxByPrice) Swap

func (s TxByPrice) Swap(i, j int)

Jump to

Keyboard shortcuts

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