ethereum

README

Plasma EVM Implementation

Implementation of Plasma EVM. You can check smart contracts here. For more information, see documentations.

• Plasma EVM Implementation
  • Development Status
  • Ethereum client
  • Public Testnet
  • Build
  • Run
  • Test
  • Command-line Options
  • Additional Commands
    • account
    • deploy
    • manage-staking
    • Staking

Development Status

• Make enter / exit requests
• Submit NRBs / ORBs
• Finalize block and requests
• Challenge on Null Address Transaction in NRBs
• Continuous Rebase
• Integration Computation Challenge using solevm.

Ethereum client

For the simple start of both clients(ethereum, plasma-evm), you can run run.rootchain.sh in Onther-Tech/go-ethereum and run.pls.sh in Onther-Tech/plasma-evm (this is recommended way to setup develop and test environment).

Public Testnet

Faraday testnet is running based on Rinkeby network as root chain.

See Onther-Tech/plasma-evm-networks

Build

$ make geth

Run

Before running plasma-evm client, you MUST run another geth client as root chain client.

$ git clone https://github.com/Onther-Tech/go-ethereum.git root-chain-geth && cd root-chain-geth
$ bash run.rootchain.sh

Then you can run or test plasma-evm client.

$ git clone https://github.com/Onther-Tech/plasma-evm.git && cd plasma-evm
$ bash run.pls.sh

Test

Some original go-ethereum tests may fail.

To test plasam-evm related features,

$ go test github.com/Onther-Tech/plasma-evm/pls
$ go test github.com/Onther-Tech/plasma-evm/tx

Command-line Options

build/bin/geth help returns available flags. Belows are plasma-evm-specific flags.

PLASMA EVM - DEVELOPMENT MODE OPTIONS:
  --dev                               Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled
  --dev.period value                  Block period to use in developer mode (0 = mine only if transaction pending) (default: 0)
  --dev.key value                     Comma seperated developer account key as hex(for dev)

PLASMA EVM - OPERATOR OPTIONS:
  --operator value                    Plasma operator address as hex.
  --operator.key value                Plasma operator key as hex(for dev)
  --operator.password value           Operator password file to use for non-interactive password input
  --operator.minether value           Plasma operator minimum balance (default = 0.5 ether) (default: "0.5")
  --miner.recommit value              Time interval to recreate the block being mined (default: 3s)

PLASMA EVM - ROOTCHAIN TRANSACTION MANAGER OPTIONS:
  --tx.gasprice value                 Gas price for transaction (default = 10 Gwei) (default: 0)
  --tx.mingasprice value              Minimum gas price for submitting a block (default = 1 Gwei) (default: 1000000000)
  --tx.maxgasprice value              Maximum gas price for submitting a block (default = 100 Gwei) (default: 100000000000)
  --tx.interval value                 Pending interval time after submitting a block (default = 10s). If block submit transaction is not mined in 2 intervals, gas price will be adjusted. See https://golang.org/pkg/time/#ParseDuration (default: 10s)

PLASMA EVM - STAMINA OPTIONS:
  --stamina.operatoramount value      Operator stamina amount at genesis block in ETH (default: 1)
  --stamina.mindeposit value          Minimum deposit amount in ETH (default: 0.5)
  --stamina.recoverepochlength value  The length of recovery epoch in block (default: 120960)
  --stamina.withdrawaldelay value     Withdrawal delay in block (default: 362880)

PLASMA EVM - CHALLENGER OPTIONS:
  --rootchain.challenger value        Address of challenger account
  --challenger.password value         Challenger password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.
  --rootchain.contract value          Address of the RootChain contract
  --rootchain.deploygasprice value    Transaction gas price to deploy rootchain in GWei (default: 10000000000). This flag applies only to deploy command.

PLASMA EVM - STAKING OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)
  --rootchain.ton value               Address of TON token contract
  --rootchain.wton value              Address of WTON token contract
  --rootchain.registry value          Address of RootChainRegistry contract
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.seigmanager value       Address of SeigManager contract
  --rootchain.powerton value          Address of PowerTON contract
  
PLASMA EVM - CHILDCHAIN OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.
  --childchain.sender value           Sender address of child chain transaction
  --childchain.gasprice value         Gas price for child chain transaction in GWei (default: 0)

Additional Commands

For more information, run below command (and sub-command) with --help flag.

account

$ geth account import-key <privateKey>    # Import a private key from hex key into a new account

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")
  --keystore value                    Directory for the keystore (default = inside the datadir)
  --lightkdf                          Reduce key-derivation RAM & CPU usage at some expense of KDF strength

ACCOUNT OPTIONS:
  --password value                    Password file to use for non-interactive password input

$ geth account import-hdwallet <mnemonic> <path>    # Import a mnemonic into a new account

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")
  --keystore value                    Directory for the keystore (default = inside the datadir)
  --lightkdf                          Reduce key-derivation RAM & CPU usage at some expense of KDF strength

ACCOUNT OPTIONS:
  --password value                    Password file to use for non-interactive password input

deploy

$ geth deploy <genesisPath> <chainId> <withPETH> <NRELength>    # Deploy RootChain contract and make genesis file

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - DEVELOPMENT MODE OPTIONS:
  --dev.key value                     Comma seperated developer account key as hex(for dev)

PLASMA EVM - STAMINA OPTIONS:
  --stamina.operatoramount value      Operator stamina amount at genesis block in ETH (default: 1)
  --stamina.mindeposit value          Minimum deposit amount in ETH (default: 0.5)
  --stamina.recoverepochlength value  The length of recovery epoch in block (default: 120960)
  --stamina.withdrawaldelay value     Withdrawal delay in block (default: 362880)

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.
  --rootchain.deploygasprice value    Transaction gas price to deploy rootchain in GWei (default: 10000000000). This flag applies only to deploy command.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)

stamina

$ geth stamina get-delegatee <address>    # Get delegatee of account

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.

$ geth stamina get-stamina <address>    # Get stamina of account

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.

$ geth stamina get-totaldeposit <address>    # Get total deposit of account

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.

$ geth stamina get-deposit <depositor> <delegatee>    # Get deposit of account from the depositor

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.

$ geth stamina get-lastrecoveryblock <delegatee>    # Get last recovery block of the delegatee

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.

$ geth stamina get-withdrawal <depositor>    # Get withdrawal requests

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.

$ geth stamina set-delegator <delegator>    # Set delegator

ETHEREUM OPTIONS:
--datadir value                       Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.
  --childchain.sender value           Sender address of child chain transaction
  --childchain.gasprice value         Gas price for child chain transaction in GWei (default: 0)

$ geth stamina deposit <delegatee> <value>    # Deposit PETH to gain stamina

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.
  --childchain.sender value           Sender address of child chain transaction
  --childchain.gasprice value         Gas price for child chain transaction in GWei (default: 0)

$ geth stamina request-withdrawal <delegatee> <value>    # Request withdraw

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.
  --childchain.sender value           Sender address of child chain transaction
  --childchain.gasprice value         Gas price for child chain transaction in GWei (default: 0)

$ geth stamina withdraw    # Process withdraw

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - CHILDCHAIN OPTIONS OPTIONS:
  --childchain.url value              JSONRPC endpoint of child chain provider.
  --childchain.sender value           Sender address of child chain transaction
  --childchain.gasprice value         Gas price for child chain transaction in GWei (default: 0)                              

manage-staking

$ geth manage-staking deploy-managers <withdrawalDelay> <seigPerBlock>    # Deploy staking manager contracts (except PowerTON)

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - DEVELOPMENT MODE OPTIONS:
  --dev.key value                     Comma separated developer account key as hex(for dev)

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.ton value               Address of TON token contract
  --rootchain.wton value              Address of WTON token contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth manage-staking deploy-powerton <roundDuration>    # Deploy PowerTON contract

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)
  --rootchain.wton value              Address of WTON token contract
  --rootchain.seigmanager value       Address of SeigManager contract

$ geth manage-staking start-powerton    # Start PowerTON first round

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - DEVELOPMENT MODE OPTIONS:
  --dev.key value                     Comma seperated developer account key as hex(for dev)

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.powerton value          Address of PowerTON contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth manage-staking register    # Register RootChain contract

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - DEVELOPMENT MODE OPTIONS:
  --dev.key value                     Comma seperated developer account key as hex(for dev)

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth manage-staking set-commission-rate <rate> <isCommissionRateNegative>    # Set commission rate

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - DEVELOPMENT MODE OPTIONS:
  --dev.key value                     Comma seperated developer account key as hex(for dev)

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth manage-staking get-managers <path>    # Get staking managers addresses in database

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

$ geth manage-staking set-managers <uri>    # Set staking managers addresses in database

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.ton value               Address of TON token contract
  --rootchain.wton value              Address of WTON token contract
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.registry value          Address of RootChainRegistry contract
  --rootchain.seigmanager value       Address of SeigManager contract
  --rootchain.powerton value          Address of PowerTON contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth manage-staking mint-ton <to> <amount>    # Mint TON to account (for dev)

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.ton value               Address of TON token contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

staking

$ geth staking balances <address>    # Print balances of token and stake

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.ton value               Address of TON token contract
  --rootchain.wton value              Address of WTON token contract
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.seigmanager value       Address of SeigManager contract

$ geth staking swap-from-ton <tonAmount>    # Swap TON to WTON

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.ton value               Address of TON token contract
  --rootchain.wton value              Address of WTON token contract
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.seigmanager value       Address of SeigManager contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth staking swap-to-ton <wtonAmount>    # Swap WTON to TON

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.ton value               Address of TON token contract
  --rootchain.wton value              Address of WTON token contract
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.seigmanager value       Address of SeigManager contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth staking stake-ton <amount>    # Stake TON

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.ton value               Address of TON token contract
  --rootchain.wton value              Address of WTON token contract
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.seigmanager value       Address of SeigManager contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth staking stake-wton <amount>    # Stake WTON

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.ton value               Address of TON token contract
  --rootchain.wton value              Address of WTON token contract
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.seigmanager value       Address of SeigManager contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth staking restake <amount>    # Restake pending withdrawal request

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.ton value               Address of TON token contract
  --rootchain.wton value              Address of WTON token contract
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.seigmanager value       Address of SeigManager contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth staking request-withdrawal <amount>    # Make a withdrawal request

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

$ geth staking process-withdrawal <numRequests>    # Process pending withdrawals

ETHEREUM OPTIONS:
  --datadir value                     Data directory for the databases and keystore (default: "/Users/thomashin/Library/Ethereum")

ACCOUNT OPTIONS:
  --unlock value                      Comma separated list of accounts to unlock
  --password value                    Password file to use for non-interactive password input

PLASMA EVM - ROOTCHAIN CONTRACT OPTIONS:
  --rootchain.url value               JSONRPC endpoint of rootchain provider. If URL is empty, ignore the provider.

PLASMA EVM - STAKING OPTIONS OPTIONS:
  --rootchain.sender value            Address of root chain transaction sender account. it MUST be unlocked by --unlock, --password flags (CAVEAT: To set plasma operator, use --operator flag)
  --rootchain.depositmanager value    Address of Deposit Manager contract
  --rootchain.gasprice value          Transaction gas price to root chain in GWei (default: 10000000000)

Documentation

Overview

Package ethereum defines interfaces for interacting with Ethereum.

Index

• Variables
• type CallMsg
• type ChainReader
• type ChainStateReader
• type ChainSyncReader
• type ContractCaller
• type FilterQuery
• type GasEstimator
• type GasPricer
• type LogFilterer
• type PendingContractCaller
• type PendingStateEventer
• type PendingStateReader
• type Subscription
• type SyncProgress
• type TransactionReader
• type TransactionSender

Variables

var NotFound = errors.New("not found")

NotFound is returned by API methods if the requested item does not exist.

Types

type CallMsg

type CallMsg struct {
	From     common.Address  // the sender of the 'transaction'
	To       *common.Address // the destination contract (nil for contract creation)
	Gas      uint64          // if 0, the call executes with near-infinite gas
	GasPrice *big.Int        // wei <-> gas exchange ratio
	Value    *big.Int        // amount of wei sent along with the call
	Data     []byte          // input data, usually an ABI-encoded contract method invocation
}

CallMsg contains parameters for contract calls.

type ChainReader

type ChainReader interface {
	BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
	BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)
	HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
	HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
	TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error)
	TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error)

	// This method subscribes to notifications about changes of the head block of
	// the canonical chain.
	SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (Subscription, error)
}

ChainReader provides access to the blockchain. The methods in this interface access raw data from either the canonical chain (when requesting by block number) or any blockchain fork that was previously downloaded and processed by the node. The block number argument can be nil to select the latest canonical block. Reading block headers should be preferred over full blocks whenever possible.

The returned error is NotFound if the requested item does not exist.

type ChainStateReader

type ChainStateReader interface {
	BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error)
	StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error)
	CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error)
	NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)
}

ChainStateReader wraps access to the state trie of the canonical blockchain. Note that implementations of the interface may be unable to return state values for old blocks. In many cases, using CallContract can be preferable to reading raw contract storage.

type ChainSyncReader

type ChainSyncReader interface {
	SyncProgress(ctx context.Context) (*SyncProgress, error)
}

ChainSyncReader wraps access to the node's current sync status. If there's no sync currently running, it returns nil.

type ContractCaller

type ContractCaller interface {
	CallContract(ctx context.Context, call CallMsg, blockNumber *big.Int) ([]byte, error)
}

A ContractCaller provides contract calls, essentially transactions that are executed by the EVM but not mined into the blockchain. ContractCall is a low-level method to execute such calls. For applications which are structured around specific contracts, the abigen tool provides a nicer, properly typed way to perform calls.

type FilterQuery

type FilterQuery struct {
	BlockHash *common.Hash     // used by eth_getLogs, return logs only from block with this hash
	FromBlock *big.Int         // beginning of the queried range, nil means genesis block
	ToBlock   *big.Int         // end of the range, nil means latest block
	Addresses []common.Address // restricts matches to events created by specific contracts

	// The Topic list restricts matches to particular event topics. Each event has a list
	// of topics. Topics matches a prefix of that list. An empty element slice matches any
	// topic. Non-empty elements represent an alternative that matches any of the
	// contained topics.
	//
	// Examples:
	// {} or nil          matches any topic list
	// {{A}}              matches topic A in first position
	// {{}, {B}}          matches any topic in first position AND B in second position
	// {{A}, {B}}         matches topic A in first position AND B in second position
	// {{A, B}, {C, D}}   matches topic (A OR B) in first position AND (C OR D) in second position
	Topics [][]common.Hash
}

FilterQuery contains options for contract log filtering.

type GasEstimator

type GasEstimator interface {
	EstimateGas(ctx context.Context, call CallMsg) (uint64, error)
}

GasEstimator wraps EstimateGas, which tries to estimate the gas needed to execute a specific transaction based on the pending state. There is no guarantee that this is the true gas limit requirement as other transactions may be added or removed by miners, but it should provide a basis for setting a reasonable default.

type GasPricer

type GasPricer interface {
	SuggestGasPrice(ctx context.Context) (*big.Int, error)
}

GasPricer wraps the gas price oracle, which monitors the blockchain to determine the optimal gas price given current fee market conditions.

type LogFilterer

type LogFilterer interface {
	FilterLogs(ctx context.Context, q FilterQuery) ([]types.Log, error)
	SubscribeFilterLogs(ctx context.Context, q FilterQuery, ch chan<- types.Log) (Subscription, error)
}

LogFilterer provides access to contract log events using a one-off query or continuous event subscription.

Logs received through a streaming query subscription may have Removed set to true, indicating that the log was reverted due to a chain reorganisation.

type PendingContractCaller

type PendingContractCaller interface {
	PendingCallContract(ctx context.Context, call CallMsg) ([]byte, error)
}

PendingContractCaller can be used to perform calls against the pending state.

type PendingStateEventer

type PendingStateEventer interface {
	SubscribePendingTransactions(ctx context.Context, ch chan<- *types.Transaction) (Subscription, error)
}

A PendingStateEventer provides access to real time notifications about changes to the pending state.

type PendingStateReader

type PendingStateReader interface {
	PendingBalanceAt(ctx context.Context, account common.Address) (*big.Int, error)
	PendingStorageAt(ctx context.Context, account common.Address, key common.Hash) ([]byte, error)
	PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error)
	PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
	PendingTransactionCount(ctx context.Context) (uint, error)
}

A PendingStateReader provides access to the pending state, which is the result of all known executable transactions which have not yet been included in the blockchain. It is commonly used to display the result of ’unconfirmed’ actions (e.g. wallet value transfers) initiated by the user. The PendingNonceAt operation is a good way to retrieve the next available transaction nonce for a specific account.

type Subscription

type Subscription interface {
	// Unsubscribe cancels the sending of events to the data channel
	// and closes the error channel.
	Unsubscribe()
	// Err returns the subscription error channel. The error channel receives
	// a value if there is an issue with the subscription (e.g. the network connection
	// delivering the events has been closed). Only one value will ever be sent.
	// The error channel is closed by Unsubscribe.
	Err() <-chan error
}

Subscription represents an event subscription where events are delivered on a data channel.

type SyncProgress

type SyncProgress struct {
	StartingBlock uint64 // Block number where sync began
	CurrentBlock  uint64 // Current block number where sync is at
	HighestBlock  uint64 // Highest alleged block number in the chain
	PulledStates  uint64 // Number of state trie entries already downloaded
	KnownStates   uint64 // Total number of state trie entries known about
}

SyncProgress gives progress indications when the node is synchronising with the Ethereum network.

type TransactionReader

type TransactionReader interface {
	// TransactionByHash checks the pool of pending transactions in addition to the
	// blockchain. The isPending return value indicates whether the transaction has been
	// mined yet. Note that the transaction may not be part of the canonical chain even if
	// it's not pending.
	TransactionByHash(ctx context.Context, txHash common.Hash) (tx *types.Transaction, isPending bool, err error)
	// TransactionReceipt returns the receipt of a mined transaction. Note that the
	// transaction may not be included in the current canonical chain even if a receipt
	// exists.
	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
}

TransactionReader provides access to past transactions and their receipts. Implementations may impose arbitrary restrictions on the transactions and receipts that can be retrieved. Historic transactions may not be available.

Avoid relying on this interface if possible. Contract logs (through the LogFilterer interface) are more reliable and usually safer in the presence of chain reorganisations.

The returned error is NotFound if the requested item does not exist.

type TransactionSender

type TransactionSender interface {
	SendTransaction(ctx context.Context, tx *types.Transaction) error
}

TransactionSender wraps transaction sending. The SendTransaction method injects a signed transaction into the pending transaction pool for execution. If the transaction was a contract creation, the TransactionReceipt method can be used to retrieve the contract address after the transaction has been mined.

The transaction must be signed and have a valid nonce to be included. Consumers of the API can use package accounts to maintain local private keys and need can retrieve the next available nonce using PendingNonceAt.