common

Documentation

Index

• Constants
• func ExtractChildTokenAddr(receipt *ethgo.Receipt, childChainMintable bool) (*types.Address, error)
• func ExtractExitEventIDs(receipt *ethgo.Receipt) ([]*big.Int, error)
• type BridgeParams
  • func (p *BridgeParams) RegisterCommonFlags(cmd *cobra.Command)
  • func (p *BridgeParams) Validate() error
• type BridgeTxResult
  • func (r *BridgeTxResult) GetOutput() string
• type ERC1155BridgeParams
  • func NewERC1155BridgeParams() *ERC1155BridgeParams
  • func (bp *ERC1155BridgeParams) Validate() error
• type ERC20BridgeParams
  • func NewERC20BridgeParams() *ERC20BridgeParams
  • func (bp *ERC20BridgeParams) Validate() error
• type ERC721BridgeParams
  • func NewERC721BridgeParams() *ERC721BridgeParams
  • func (bp *ERC721BridgeParams) Validate() error
• type TokenType

Constants

const (
	SenderKeyFlag          = "sender-key"
	ReceiversFlag          = "receivers"
	AmountsFlag            = "amounts"
	TokenIDsFlag           = "token-ids"
	RootTokenFlag          = "root-token"
	RootPredicateFlag      = "root-predicate"
	ChildPredicateFlag     = "child-predicate"
	ChildTokenFlag         = "child-token"
	JSONRPCFlag            = "json-rpc"
	ChildChainMintableFlag = "child-chain-mintable"

	MinterKeyFlag     = "minter-key"
	MinterKeyFlagDesc = "minter key is the account which is able to mint tokens to sender account " +
		"(if provided tokens are minted prior to depositing)"
)

Functions

func ExtractChildTokenAddr

func ExtractChildTokenAddr(receipt *ethgo.Receipt, childChainMintable bool) (*types.Address, error)

ExtractChildTokenAddr extracts predicted deterministic child token address

func ExtractExitEventIDs

func ExtractExitEventIDs(receipt *ethgo.Receipt) ([]*big.Int, error)

ExtractExitEventIDs tries to extract all exit event ids from provided receipt

Types

type BridgeParams

type BridgeParams struct {
	SenderKey          string
	Receivers          []string
	TokenAddr          string
	PredicateAddr      string
	JSONRPCAddr        string
	ChildChainMintable bool
}

func (*BridgeParams) RegisterCommonFlags

func (p *BridgeParams) RegisterCommonFlags(cmd *cobra.Command)

RegisterCommonFlags registers common bridge flags to a given command

func (*BridgeParams) Validate

func (p *BridgeParams) Validate() error

type BridgeTxResult

type BridgeTxResult struct {
	Sender         string         `json:"sender"`
	Receivers      []string       `json:"receivers"`
	ExitEventIDs   []*big.Int     `json:"exitEventIDs"`
	Amounts        []string       `json:"amounts"`
	TokenIDs       []string       `json:"tokenIds"`
	BlockNumbers   []uint64       `json:"blockNumbers"`
	ChildTokenAddr *types.Address `json:"childTokenAddr"`

	Title string `json:"title"`
}

func (*BridgeTxResult) GetOutput

func (r *BridgeTxResult) GetOutput() string

type ERC1155BridgeParams

type ERC1155BridgeParams struct {
	*BridgeParams
	Amounts  []string
	TokenIDs []string
}

func NewERC1155BridgeParams

func NewERC1155BridgeParams() *ERC1155BridgeParams

func (*ERC1155BridgeParams) Validate

func (bp *ERC1155BridgeParams) Validate() error

type ERC20BridgeParams

type ERC20BridgeParams struct {
	*BridgeParams
	Amounts []string
}

func NewERC20BridgeParams

func NewERC20BridgeParams() *ERC20BridgeParams

func (*ERC20BridgeParams) Validate

func (bp *ERC20BridgeParams) Validate() error

type ERC721BridgeParams

type ERC721BridgeParams struct {
	*BridgeParams
	TokenIDs []string
}

func NewERC721BridgeParams

func NewERC721BridgeParams() *ERC721BridgeParams

func (*ERC721BridgeParams) Validate

func (bp *ERC721BridgeParams) Validate() error

type TokenType

type TokenType int

const (
	ERC20 TokenType = iota
	ERC721
	ERC1155
)