types

type AccountInfo struct {
	Address Address `json:"address"`

	Balance *hexutil.Big `json:"balance"`
	// : U256,
	Nonce *hexutil.Big `json:"nonce"`
	// : U256,
	CodeHash Hash `json:"codeHash"`
	//  : H256,
	StakingBalance *hexutil.Big `json:"stakingBalance"`
	// : U256,
	CollateralForStorage *hexutil.Big `json:"collateralForStorage"`
	// : U256,
	AccumulatedInterestReturn *hexutil.Big `json:"accumulatedInterestReturn"`
	// : U256,
	Admin Address `json:"admin"`
}

type AccountPendingInfo struct {
	LocalNonce    *hexutil.Big `json:"localNonce"`
	PendingCount  *hexutil.Big `json:"pendingCount"`
	PendingNonce  *hexutil.Big `json:"pendingNonce"`
	NextPendingTx Hash         `json:"nextPendingTx"`
}

type AccountPendingTransactions struct {
	PendingTransactions []Transaction `json:"pendingTransactions"`
	// type maybe string/Pending
	FirstTxStatus *TransactionStatus `json:"firstTxStatus"`
	PendingCount  hexutil.Uint64     `json:"pendingCount"`
}

type ActionType string

type Address = address.Address

type Block struct {
	BlockHeader
	Transactions []Transaction `json:"transactions"`
}

type BlockHeader struct {
	Hash                  Hash             `json:"hash"`
	ParentHash            Hash             `json:"parentHash"`
	Height                *hexutil.Big     `json:"height"`
	Miner                 Address          `json:"miner"`
	DeferredStateRoot     Hash             `json:"deferredStateRoot"`
	DeferredReceiptsRoot  Hash             `json:"deferredReceiptsRoot"`
	DeferredLogsBloomHash Hash             `json:"deferredLogsBloomHash"`
	Blame                 hexutil.Uint64   `json:"blame"`
	TransactionsRoot      Hash             `json:"transactionsRoot"`
	EpochNumber           *hexutil.Big     `json:"epochNumber"`
	BlockNumber           *hexutil.Big     `json:"blockNumber"`
	GasLimit              *hexutil.Big     `json:"gasLimit"`
	GasUsed               *hexutil.Big     `json:"gasUsed"`
	Timestamp             *hexutil.Big     `json:"timestamp"`
	Difficulty            *hexutil.Big     `json:"difficulty"`
	PowQuality            *hexutil.Big     `json:"powQuality"`
	RefereeHashes         []Hash           `json:"refereeHashes"`
	Adaptive              bool             `json:"adaptive"`
	Nonce                 *hexutil.Big     `json:"nonce"`
	Size                  *hexutil.Big     `json:"size"`
	Custom                []cmptutil.Bytes `json:"custom"`
	PosReference          *Hash            `json:"posReference"`
}

type BlockSummary struct {
	BlockHeader
	Transactions []Hash `json:"transactions"`
}

type Bloom string

type Call struct {
	Space    SpaceType     `json:"space"`
	From     Address       `json:"from"`
	To       Address       `json:"to"`
	Value    hexutil.Big   `json:"value"`
	Gas      hexutil.Big   `json:"gas"`
	Input    hexutil.Bytes `json:"input"`
	CallType CallType      `json:"callType"`
}

type CallRequest struct {
	From     *Address     `json:"from,omitempty"`
	To       *Address     `json:"to,omitempty"`
	GasPrice *hexutil.Big `json:"gasPrice,omitempty"`
	Gas      *hexutil.Big `json:"gas,omitempty"`
	Value    *hexutil.Big `json:"value,omitempty"`
	// NOTE, cannot use *hexutil.Bytes or hexutil.Bytes here.
	// Otherwise, hexutil.Bytes.UnmarshalJSON will called to
	// unmarshal from nil and cause to errNonString error.
	Data         *string         `json:"data,omitempty"`
	Nonce        *hexutil.Big    `json:"nonce,omitempty"`
	StorageLimit *hexutil.Uint64 `json:"storageLimit,omitempty"`
}

type CallResult struct {
	Outcome    OutcomeType   `json:"outcome"`
	GasLeft    hexutil.Big   `json:"gasLeft"`
	ReturnData hexutil.Bytes `json:"returnData"`
}

type CallType string

type CfxFilterChanges struct {
	Type   string
	Logs   []*SubscriptionLog
	Hashes []Hash
}

type ChainReorg struct {
	RevertTo *hexutil.Big `json:"revertTo"`
}

type CheckBalanceAgainstTransactionResponse struct {
	/// Whether the account should pay transaction fee by self.
	WillPayTxFee bool `json:"willPayTxFee"`
	/// Whether the account should pay collateral by self.
	WillPayCollateral bool `json:"willPayCollateral"`
	/// Whether the account balance is enough for this transaction.
	IsBalanceEnough bool `json:"isBalanceEnough"`
}

type ContractDeployOption struct {
	UnsignedTransactionBase
	// TimeoutInSecond represents the timeout of deploy contract,
	// default value is 0 which means never timeout
	Timeout time.Duration
}

type ContractMethodCallOption struct {
	From         *Address
	Nonce        *hexutil.Big
	GasPrice     *hexutil.Big
	Gas          *hexutil.Big
	Value        *hexutil.Big
	StorageLimit *hexutil.Uint64
	ChainID      *hexutil.Big
	Epoch        *Epoch
}

type ContractMethodSendOption UnsignedTransactionBase

type Create struct {
	Space      SpaceType     `json:"space"`
	From       Address       `json:"from"`
	Value      hexutil.Big   `json:"value"`
	Gas        hexutil.Big   `json:"gas"`
	Init       hexutil.Bytes `json:"init"`
	CreateType CreateType    `json:"createType"`
}

type CreateResult struct {
	Outcome    OutcomeType   `json:"outcome"`
	Addr       Address       `json:"addr"`
	GasLeft    hexutil.Big   `json:"gasLeft"`
	ReturnData hexutil.Bytes `json:"returnData"`
}

type CreateType string

type DepositInfo struct {
	AccumulatedInterestRate *hexutil.Big `json:"accumulatedInterestRate"`
	Amount                  *hexutil.Big `json:"amount"`
	DepositTime             *hexutil.Big `json:"depositTime"`
}

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

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

type EpochReceiptProof struct {
	BlockIndexProof   TrieProof `json:"block_index_proof"`
	BlockReceiptProof TrieProof `json:"block_receipt_proof"`
}

type EpochTrace struct {
	CfxTraces        []*LocalizedTrace                     `json:"cfxTraces"`
	EthTraces        []*web3gotypes.LocalizedTrace         `json:"ethTraces"`
	MirrorAddressMap map[common.Address]cfxaddress.Address `json:"mirrorAddressMap"`
}

type Estimate struct {
	GasLimit              *hexutil.Big `json:"gasLimit"`
	GasUsed               *hexutil.Big `json:"gasUsed"`
	StorageCollateralized *hexutil.Big `json:"storageCollateralized"`
}

type H128 [H128Length]byte

type Hash string

type InternalTransferAction struct {
	From       Address     `json:"from"`
	FromPocket PocketType  `json:"fromPocket"`
	FromSpace  SpaceType   `json:"fromSpace"`
	To         Address     `json:"to"`
	ToPocket   PocketType  `json:"toPocket"`
	ToSpace    SpaceType   `json:"toSpace"`
	Value      hexutil.Big `json:"value"`
}

type LocalizedBlockTrace struct {
	TransactionTraces []LocalizedTransactionTrace `json:"transactionTraces"`
	EpochHash         Hash                        `json:"epochHash"`
	EpochNumber       hexutil.Big                 `json:"epochNumber"`
	BlockHash         Hash                        `json:"blockHash"`
}

type LocalizedTrace struct {
	Action              interface{}     `json:"action"`
	Valid               bool            `json:"valid"`
	Type                TraceType       `json:"type"`
	EpochHash           *Hash           `json:"epochHash,omitempty"`
	EpochNumber         *hexutil.Big    `json:"epochNumber,omitempty"`
	BlockHash           *Hash           `json:"blockHash,omitempty"`
	TransactionPosition *hexutil.Uint64 `json:"transactionPosition,omitempty"`
	TransactionHash     *Hash           `json:"transactionHash,omitempty"`
}

type LocalizedTraceNode struct {
	Type                TraceType       `json:"type"`
	Valid               bool            `json:"valid"`
	EpochHash           *Hash           `json:"epochHash,omitempty"`
	EpochNumber         *hexutil.Big    `json:"epochNumber,omitempty"`
	BlockHash           *Hash           `json:"blockHash,omitempty"`
	TransactionPosition *hexutil.Uint64 `json:"transactionPosition,omitempty"`
	TransactionHash     *Hash           `json:"transactionHash,omitempty"`

	CallWithResult         *TraceCallWithResult    `json:"callWithResult,omitempty"`
	CreateWithResult       *TraceCreateWithResult  `json:"createWithResult,omitempty"`
	InternalTransferAction *InternalTransferAction `json:"internalTransferAction,omitempty"`

	Childs []*LocalizedTraceNode `json:"childs"`
}

type LocalizedTraceTire []*LocalizedTraceNode

type LocalizedTransactionTrace struct {
	Traces              []LocalizedTrace `json:"traces"`
	TransactionPosition hexutil.Uint64   `json:"transactionPosition"`
	TransactionHash     Hash             `json:"transactionHash"`
}

type Log struct {
	Address             Address       `json:"address"`
	Topics              []Hash        `json:"topics"`
	Data                hexutil.Bytes `json:"data"`
	BlockHash           *Hash         `json:"blockHash,omitempty"`
	EpochNumber         *hexutil.Big  `json:"epochNumber,omitempty"`
	TransactionHash     *Hash         `json:"transactionHash,omitempty"`
	TransactionIndex    *hexutil.Big  `json:"transactionIndex,omitempty"`
	LogIndex            *hexutil.Big  `json:"logIndex,omitempty"`
	TransactionLogIndex *hexutil.Big  `json:"transactionLogIndex,omitempty"`
	Space               *SpaceType    `json:"space,omitempty"`
}

type LogFilter struct {
	FromEpoch   *Epoch       `json:"fromEpoch,omitempty"`
	ToEpoch     *Epoch       `json:"toEpoch,omitempty"`
	FromBlock   *hexutil.Big `json:"fromBlock,omitempty"`
	ToBlock     *hexutil.Big `json:"toBlock,omitempty"`
	BlockHashes []Hash       `json:"blockHashes,omitempty"`
	Address     []Address    `json:"address,omitempty"`
	Topics      [][]Hash     `json:"topics,omitempty"`
}

type NonceType int

type OutcomeType string

type PendingReason string

type PoSEconomics struct {
	TotalPosStakingTokens    *hexutil.Big   `json:"totalPosStakingTokens"`
	DistributablePosInterest *hexutil.Big   `json:"distributablePosInterest"`
	LastDistributeBlock      hexutil.Uint64 `json:"lastDistributeBlock"`
}

type PocketType string

type RewardInfo struct {
	BlockHash Hash `json:"blockHash"`
	// H256,
	Author Address `json:"author"`
	// H160,
	TotalReward *hexutil.Big `json:"totalReward"`
	// U256,
	BaseReward *hexutil.Big `json:"baseReward"`
	// U256,
	TxFee *hexutil.Big `json:"txFee"`
}

type SignedTransaction struct {
	UnsignedTransaction UnsignedTransaction
	V                   byte
	R                   hexutil.Bytes
	S                   hexutil.Bytes
}

type SpaceType string

type SponsorInfo struct {
	SponsorForGas               Address      `json:"sponsorForGas"`
	SponsorForCollateral        Address      `json:"sponsorForCollateral"`
	SponsorGasBound             *hexutil.Big `json:"sponsorGasBound"`
	SponsorBalanceForGas        *hexutil.Big `json:"sponsorBalanceForGas"`
	SponsorBalanceForCollateral *hexutil.Big `json:"sponsorBalanceForCollateral"`
	AvailableStoragePoints      *hexutil.Big `json:"availableStoragePoints"`
	UsedStoragePoints           *hexutil.Big `json:"usedStoragePoints"`
}

type Status struct {
	BestHash             Hash           `json:"bestHash"`
	ChainID              hexutil.Uint64 `json:"chainId"`
	EthereumSpaceChainId hexutil.Uint64 `json:"ethereumSpaceChainId"`
	NetworkID            hexutil.Uint64 `json:"networkId"`
	EpochNumber          hexutil.Uint64 `json:"epochNumber"`
	BlockNumber          hexutil.Uint64 `json:"blockNumber"`
	PendingTxNumber      hexutil.Uint64 `json:"pendingTxNumber"`
	LatestCheckpoint     hexutil.Uint64 `json:"latestCheckpoint"`
	LatestConfirmed      hexutil.Uint64 `json:"latestConfirmed"`
	LatestState          hexutil.Uint64 `json:"latestState"`
	LatestFinalized      hexutil.Uint64 `json:"latestFinalized"`
}

type StorageChange struct {
	Address Address `json:"address"`
	/// Number of storage collateral units to deposit / refund (absolute value).
	Collaterals hexutil.Uint64 `json:"collaterals"`
}

type StorageCollateralInfo struct {
	TotalStorageTokens     *hexutil.Big `json:"totalStorageTokens"`
	ConvertedStoragePoints *hexutil.Big `json:"convertedStoragePoints"`
	UsedStoragePoints      *hexutil.Big `json:"usedStoragePoints"`
}

type StorageRoot struct {
	Delta        *Hash `json:"delta"`        //delta: H256,
	Intermediate *Hash `json:"intermediate"` //intermediate: H256,
	Snapshot     *Hash `json:"snapshot"`     //snapshot: H256,
}

type SubscriptionLog struct {
	*Log
	*ChainReorg
}

type TokenSupplyInfo struct {
	TotalCirculating  *hexutil.Big `json:"totalCirculating"`
	TotalIssued       *hexutil.Big `json:"totalIssued"`
	TotalStaking      *hexutil.Big `json:"totalStaking"`
	TotalCollateral   *hexutil.Big `json:"totalCollateral"`
	TotalEspaceTokens *hexutil.Big `json:"totalEspaceTokens"`
}

type TraceCallWithResult struct {
	*Call       `json:"call"`
	*CallResult `json:"callResult"`
}

type TraceCreateWithResult struct {
	*Create       `json:"create"`
	*CreateResult `json:"createResult"`
}

type TraceFilter struct {
	FromEpoch   *Epoch    `json:"fromEpoch"`
	ToEpoch     *Epoch    `json:"toEpoch"`
	FromAddress []Address `json:"fromAddress"`
	ToAddress   []Address `json:"toAddress"`
	BlockHashes []Hash    `json:"blockHashes"`
	// action types could be "call","create","callResult","createResult","internalTransferAction"
	ActionTypes []TraceType     `json:"actionTypes"`
	After       *hexutil.Uint64 `json:"after"`
	Count       *hexutil.Uint64 `json:"count"`
}

type TraceType string

type Transaction struct {
	// Space            *string          `json:"space,omitempty"` //currently it is always "nil", so comment it now and uncomment it if need later
	Hash             Hash            `json:"hash"`
	Nonce            *hexutil.Big    `json:"nonce"`
	BlockHash        *Hash           `json:"blockHash"`
	TransactionIndex *hexutil.Uint64 `json:"transactionIndex"`
	From             Address         `json:"from"`
	To               *Address        `json:"to"`
	Value            *hexutil.Big    `json:"value"`
	GasPrice         *hexutil.Big    `json:"gasPrice"`
	Gas              *hexutil.Big    `json:"gas"`
	ContractCreated  *Address        `json:"contractCreated"`
	Data             string          `json:"data"`
	StorageLimit     *hexutil.Big    `json:"storageLimit"`
	EpochHeight      *hexutil.Big    `json:"epochHeight"`
	ChainID          *hexutil.Big    `json:"chainId"`
	Status           *hexutil.Uint64 `json:"status"`

	//signature
	V *hexutil.Big `json:"v"`
	R *hexutil.Big `json:"r"`
	S *hexutil.Big `json:"s"`
}

type TransactionReceipt struct {
	TransactionHash    Hash            `json:"transactionHash"`
	Index              hexutil.Uint64  `json:"index"`
	BlockHash          Hash            `json:"blockHash"`
	EpochNumber        *hexutil.Uint64 `json:"epochNumber"`
	From               Address         `json:"from"`
	To                 *Address        `json:"to"`
	GasUsed            *hexutil.Big    `json:"gasUsed"`
	AccumulatedGasUsed *hexutil.Big    `json:"accumulatedGasUsed,omitempty"`
	GasFee             *hexutil.Big    `json:"gasFee"`
	ContractCreated    *Address        `json:"contractCreated"`
	Logs               []Log           `json:"logs"`
	LogsBloom          Bloom           `json:"logsBloom"`
	StateRoot          Hash            `json:"stateRoot"`
	OutcomeStatus      hexutil.Uint64  `json:"outcomeStatus"`
	TxExecErrorMsg     *string         `json:"txExecErrorMsg"`
	// Whether gas costs were covered by the sponsor.
	GasCoveredBySponsor bool `json:"gasCoveredBySponsor"`
	// Whether storage costs were covered by the sponsor.
	StorageCoveredBySponsor bool `json:"storageCoveredBySponsor"`
	// The amount of storage collateralized by the sender.
	StorageCollateralized hexutil.Uint64 `json:"storageCollateralized"`
	// Storage collaterals released during the execution of the transaction.
	StorageReleased []StorageChange `json:"storageReleased"`
	Space           *SpaceType      `json:"space,omitempty"`
}

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

type TrieProof []VanillaTrieNode

type TxPoolPendingNonceRange struct {
	MinNonce *hexutil.Big `json:"minNonce"`
	MaxNonce *hexutil.Big `json:"maxNonce"`
}

type TxPoolStatus struct {
	Deferred   hexutil.Uint64 `json:"deferred"`
	Ready      hexutil.Uint64 `json:"ready"`
	Received   hexutil.Uint64 `json:"received"`
	Unexecuted hexutil.Uint64 `json:"unexecuted"`
}

type TxWithPoolInfo struct {
	Exist              bool         `json:"exist"`
	Packed             bool         `json:"packed"`
	LocalNonce         *hexutil.Big `json:"localNonce"`
	LocalBalance       *hexutil.Big `json:"localBalance"`
	StateNonce         *hexutil.Big `json:"stateNonce"`
	StateBalance       *hexutil.Big `json:"stateBalance"`
	LocalBalanceEnough bool         `json:"localBalanceEnough"`
	StateBalanceEnough bool         `json:"stateBalanceEnough"`
}

type UnsignedTransaction struct {
	UnsignedTransactionBase
	To   *Address
	Data hexutil.Bytes
}

type UnsignedTransactionBase struct {
	From         *Address
	Nonce        *hexutil.Big
	GasPrice     *hexutil.Big
	Gas          *hexutil.Big
	Value        *hexutil.Big
	StorageLimit *hexutil.Uint64
	EpochHeight  *hexutil.Uint64
	ChainID      *hexutil.Uint
}

type VanillaTrieNode struct {
	ChildrenTable  []common.Hash `json:"childrenTable"`
	CompressedPath struct {
		PathMask  hexutil.Uint  `json:"pathMask"`
		PathSlice hexutil.Bytes `json:"pathSlice"`
	} `json:"compressedPath"`
	MerkleHash common.Hash    `json:"merkleHash"`
	MptValue   *hexutil.Bytes `json:"mptValue"`
}

type VoteStakeInfo struct {
	/// This is the number of tokens should be locked before
	/// `unlock_block_number`.
	Amount *hexutil.Big `json:"amount"`
	/// This is the timestamp when the vote right will be invalid, measured in
	/// the number of past blocks.
	UnlockBlockNumber uint64 `json:"unlockBlockNumber"`
}

type WebsocketEpochResponse struct {
	EpochHashesOrdered []Hash       `json:"epochHashesOrdered"`
	EpochNumber        *hexutil.Big `json:"epochNumber"`
}

type WrapTransaction struct {
	NativeTransaction *Transaction       `json:"nativeTransaction"`
	EthTransaction    *types.Transaction `json:"ethTransaction"`
}