core

Documentation

Index

• Constants
• Variables
• type ChildChain
  • func NewChildChain(txn *badger.Txn) (*ChildChain, error)
  • func (cc *ChildChain) AddBlock(txn *badger.Txn, signer *types.Account) (uint64, error)
  • func (cc *ChildChain) AddDepositBlock(txn *badger.Txn, ownerAddr common.Address, amount *big.Int, ...) (uint64, error)
  • func (cc *ChildChain) AddTxToMempool(txn *badger.Txn, tx *types.Tx) error
  • func (cc *ChildChain) ConfirmTx(txn *badger.Txn, txInPos types.Position, confSig types.Signature) error
  • func (cc *ChildChain) ExitTxOut(txn *badger.Txn, txOutPos types.Position) error
  • func (cc *ChildChain) GetBlock(txn *badger.Txn, blkNum uint64) (*types.Block, error)
  • func (cc *ChildChain) GetCurrentBlockNumber(txn *badger.Txn) (uint64, error)
  • func (cc *ChildChain) GetTx(txn *badger.Txn, txPos types.Position) (*types.Tx, error)
  • func (cc *ChildChain) GetTxProof(txn *badger.Txn, txPos types.Position) ([]byte, error)
  • func (cc *ChildChain) GetUTXOPositions(txn *badger.Txn, addr common.Address) ([]types.Position, error)
  • func (cc *ChildChain) RestoreTxOut(txn *badger.Txn, txOutPos types.Position) error
  • func (cc *ChildChain) ValidateTx(txn *badger.Txn, tx *types.Tx) error
• type RootChain
  • func NewRootChain(conf RootChainConfig) (*RootChain, error)
  • func (rc *RootChain) ChallengeExit(a *types.Account, txOutPos types.Position, spendingTx *types.Tx, ...) (*gethtypes.Transaction, error)
  • func (rc *RootChain) CommitPlasmaBlockRoot(a *types.Account, rootHash common.Hash) (*gethtypes.Transaction, error)
  • func (rc *RootChain) CurrentPlasmaBlockNumber() (uint64, error)
  • func (rc *RootChain) Deposit(a *types.Account, amount *big.Int) (*gethtypes.Transaction, error)
  • func (rc *RootChain) Ping() error
  • func (rc *RootChain) PlasmaExits(txOutPos types.Position) (types.Exit, error)
  • func (rc *RootChain) ProcessExits(a *types.Account) (*gethtypes.Transaction, error)
  • func (rc *RootChain) StartExit(a *types.Account, txOutPos types.Position, tx *types.Tx, txProofBytes []byte) (*gethtypes.Transaction, error)
  • func (rc *RootChain) WatchDepositCreated(ctx context.Context, sink chan<- *RootChainDepositCreated) (event.Subscription, error)
  • func (rc *RootChain) WatchExitStarted(ctx context.Context, sink chan<- *RootChainExitStarted) (event.Subscription, error)
• type RootChainConfig
  • func (conf RootChainConfig) Address() (common.Address, error)
• type RootChainDepositCreated
• type RootChainExitStarted

Constants

const (
	FirstBlockNumber = 1
	MempoolSize      = 99999 // must be less than or equal to types.MaxBlockTxesNum

)

const (
	DefaultExitBondAmount = 123456789
)

const RootChainABI = "" /* 3633-byte string literal not displayed */

const RootChainBin = `` /* 30780-byte string literal not displayed */

Variables

var (
	ErrMempoolFull = errors.New("mempool is full")

	ErrBlockNotFound = errors.New("block is not found")
	ErrEmptyBlock    = errors.New("block is empty")

	ErrTxNotFound                     = errors.New("tx is not found")
	ErrInvalidTxSignature             = errors.New("tx signature is invalid")
	ErrInvalidTxConfirmationSignature = errors.New("tx confirmation signature is invalid")
	ErrInvalidTxBalance               = errors.New("tx balance is invalid")

	ErrTxInNotFound         = errors.New("txin is not found")
	ErrInvalidTxIn          = errors.New("txin is invalid")
	ErrNullTxInConfirmation = errors.New("null txin cannot be confirmed")

	ErrTxOutNotFound      = errors.New("txout is not found")
	ErrTxOutAlreadySpent  = errors.New("txout was already spent")
	ErrTxOutAlreadyExited = errors.New("txout was already exited")

	ErrNullConfirmationSignature = errors.New("confirmation signature is null")
)

Types

type ChildChain

type ChildChain struct{}

func NewChildChain

func NewChildChain(txn *badger.Txn) (*ChildChain, error)

func (*ChildChain) AddBlock

func (cc *ChildChain) AddBlock(txn *badger.Txn, signer *types.Account) (uint64, error)

func (*ChildChain) AddDepositBlock

func (cc *ChildChain) AddDepositBlock(txn *badger.Txn, ownerAddr common.Address, amount *big.Int, signer *types.Account) (uint64, error)

func (*ChildChain) AddTxToMempool

func (cc *ChildChain) AddTxToMempool(txn *badger.Txn, tx *types.Tx) error

func (*ChildChain) ConfirmTx

func (cc *ChildChain) ConfirmTx(txn *badger.Txn, txInPos types.Position, confSig types.Signature) error

func (*ChildChain) ExitTxOut

func (cc *ChildChain) ExitTxOut(txn *badger.Txn, txOutPos types.Position) error

func (*ChildChain) GetBlock

func (cc *ChildChain) GetBlock(txn *badger.Txn, blkNum uint64) (*types.Block, error)

func (*ChildChain) GetCurrentBlockNumber

func (cc *ChildChain) GetCurrentBlockNumber(txn *badger.Txn) (uint64, error)

func (*ChildChain) GetTx

func (cc *ChildChain) GetTx(txn *badger.Txn, txPos types.Position) (*types.Tx, error)

func (*ChildChain) GetTxProof

func (cc *ChildChain) GetTxProof(txn *badger.Txn, txPos types.Position) ([]byte, error)

func (*ChildChain) GetUTXOPositions

func (cc *ChildChain) GetUTXOPositions(txn *badger.Txn, addr common.Address) ([]types.Position, error)

func (*ChildChain) RestoreTxOut

func (cc *ChildChain) RestoreTxOut(txn *badger.Txn, txOutPos types.Position) error

func (*ChildChain) ValidateTx

func (cc *ChildChain) ValidateTx(txn *badger.Txn, tx *types.Tx) error

type RootChain

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

func NewRootChain

func NewRootChain(conf RootChainConfig) (*RootChain, error)

func (*RootChain) ChallengeExit

func (rc *RootChain) ChallengeExit(a *types.Account, txOutPos types.Position, spendingTx *types.Tx, spendingInIndex uint64) (*gethtypes.Transaction, error)

func (*RootChain) CommitPlasmaBlockRoot

func (rc *RootChain) CommitPlasmaBlockRoot(a *types.Account, rootHash common.Hash) (*gethtypes.Transaction, error)

func (*RootChain) CurrentPlasmaBlockNumber

func (rc *RootChain) CurrentPlasmaBlockNumber() (uint64, error)

func (*RootChain) Deposit

func (rc *RootChain) Deposit(a *types.Account, amount *big.Int) (*gethtypes.Transaction, error)

func (*RootChain) Ping

func (rc *RootChain) Ping() error

func (*RootChain) PlasmaExits

func (rc *RootChain) PlasmaExits(txOutPos types.Position) (types.Exit, error)

func (*RootChain) ProcessExits

func (rc *RootChain) ProcessExits(a *types.Account) (*gethtypes.Transaction, error)

func (*RootChain) StartExit

func (rc *RootChain) StartExit(a *types.Account, txOutPos types.Position, tx *types.Tx, txProofBytes []byte) (*gethtypes.Transaction, error)

func (*RootChain) WatchDepositCreated

func (rc *RootChain) WatchDepositCreated(ctx context.Context, sink chan<- *RootChainDepositCreated) (event.Subscription, error)

func (*RootChain) WatchExitStarted

func (rc *RootChain) WatchExitStarted(ctx context.Context, sink chan<- *RootChainExitStarted) (event.Subscription, error)

type RootChainConfig

type RootChainConfig struct {
	RPC        string `json:"rpc"`
	WS         string `json:"ws"`
	AddressStr string `json:"address"`
}

func (RootChainConfig) Address

func (conf RootChainConfig) Address() (common.Address, error)

type RootChainDepositCreated

type RootChainDepositCreated struct {
	Owner        common.Address
	Amount       *big.Int
	DepositBlock *big.Int
	Raw          gethtypes.Log
}

type RootChainExitStarted

type RootChainExitStarted struct {
	Owner        common.Address
	UtxoPosition *big.Int
	Amount       *big.Int
	Raw          gethtypes.Log
}