cctp

Documentation

Overview

Package cctp contains the contract bindings for the SynapseCCTP contract.

Index

• type EventLog
• type EventType
  • func AllEventTypes() []EventType
  • func (i EventType) Int() uint8
  • func (i EventType) String() string

Types

type EventLog

type EventLog interface {
	// GetTxHash returns the transaction hash of the log.
	GetTxHash() common.Hash
	// GetContractAddress returns the contract address of the log.
	GetContractAddress() common.Address
	// GetBlockNumber returns the block number of the log.
	GetBlockNumber() uint64
	// GetEventType returns the event type of the log.
	GetEventType() EventType
	// GetEventIndex returns the index of the log.
	GetEventIndex() uint64
	// GetRequestID returns the request id of the CCTP transfer.
	GetRequestID() [32]byte
	// GetToken returns the address of the received token.
	GetToken() string
	// GetAmount returns the amount of the CCTP transfer.
	GetAmount() *big.Int
	// GetOriginChainID returns the chain id of the CCTP transfer.
	GetOriginChainID() *big.Int
	// GetDestinationChainID returns the chain id of the CCTP transfer.
	GetDestinationChainID() *big.Int
	// GetSender returns the sender of the CCTP transfer.
	GetSender() *string
	// GetNonce returns the nonce of the CCTP transfer.
	GetNonce() *uint64
	// GetMintToken returns the mint token of the CCTP transfer.
	GetMintToken() *string

	// GetRequestVersion returns the request version of the CCTP transfer.
	GetRequestVersion() *uint32
	// GetFormattedRequest returns the formatted request of the CCTP transfer.
	GetFormattedRequest() *[]byte
	// GetRecipient returns the receipient of the CCTP transfer.
	GetRecipient() *string
	// GetFee returns the fee of the CCTP transfer.
	GetFee() *big.Int
}

EventLog is the interface for all cctp events.

type EventType

type EventType uint8

EventType is the type of the cctp event.

const (
	// CircleRequestSentEvent is emitted when a Circle token is sent with an attached action request.
	CircleRequestSentEvent EventType = iota
	// CircleRequestFulfilledEvent is emitted when a Circle token is received with an attached action request.
	CircleRequestFulfilledEvent
)

func AllEventTypes

func AllEventTypes() []EventType

AllEventTypes is a list of the event types.

func (EventType) Int

func (i EventType) Int() uint8

Int gets the int value of the event type.

func (EventType) String

func (i EventType) String() string