receiver

package
v0.0.0-...-346157b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 27, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PackageName = "ccip-receiver"
	PackageID   = "bc9122dccf3457dc66339292b940c59eed691bddc384779675e8d7754e0bb68b"
	SDKVersion  = "3.4.11"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CCIPMessageReceived

type CCIPMessageReceived struct {
	Owner              types.PARTY                       `json:"owner"`
	Router             types.CONTRACT_ID                 `json:"router"`
	MessageId          types.TEXT                        `json:"messageId"`
	Message            core.MessageV1                    `json:"message"`
	TokenReleaseResult *extensionapi.ReleaseOrMintResult `json:"tokenReleaseResult" hex:"optional"`
}

CCIPMessageReceived is a Template type

func (CCIPMessageReceived) Archive

func (t CCIPMessageReceived) Archive(contractID string) *model.ExerciseCommand

Archive exercises the Archive choice on this CCIPMessageReceived contract This method uses the package name in the template ID

func (CCIPMessageReceived) ArchiveWithPackageID

func (t CCIPMessageReceived) ArchiveWithPackageID(contractID string, packageID string) *model.ExerciseCommand

ArchiveWithPackageID exercises the Archive choice using the provided package ID instead of package name

func (CCIPMessageReceived) CreateCommand

func (t CCIPMessageReceived) CreateCommand() *model.CreateCommand

CreateCommand returns a CreateCommand for this template using the package name

func (CCIPMessageReceived) CreateCommandWithPackageID

func (t CCIPMessageReceived) CreateCommandWithPackageID(packageID string) *model.CreateCommand

CreateCommandWithPackageID returns a CreateCommand using the provided package ID instead of package name

func (CCIPMessageReceived) GetTemplateID

func (t CCIPMessageReceived) GetTemplateID() string

GetTemplateID returns the template ID for this template using the package name

func (CCIPMessageReceived) GetTemplateIDWithPackageID

func (t CCIPMessageReceived) GetTemplateIDWithPackageID(packageID string) string

GetTemplateIDWithPackageID returns the template ID using the provided package ID instead of package name

func (CCIPMessageReceived) MarshalHex

func (t CCIPMessageReceived) MarshalHex() (string, error)

MarshalHex encodes CCIPMessageReceived to hex string (Canton MCMS format)

func (CCIPMessageReceived) MarshalJSON

func (t CCIPMessageReceived) MarshalJSON() ([]byte, error)

func (*CCIPMessageReceived) UnmarshalHex

func (t *CCIPMessageReceived) UnmarshalHex(data string) error

UnmarshalHex decodes CCIPMessageReceived from hex string (Canton MCMS format)

func (*CCIPMessageReceived) UnmarshalJSON

func (t *CCIPMessageReceived) UnmarshalJSON(data []byte) error

type CCIPReceiver

type CCIPReceiver struct {
	InstanceId             types.TEXT                        `json:"instanceId"`
	Owner                  types.PARTY                       `json:"owner"`
	RequiredCCVs           []chainlinkapi.RawInstanceAddress `json:"requiredCCVs"`
	OptionalCCVs           []chainlinkapi.RawInstanceAddress `json:"optionalCCVs"`
	OptionalThreshold      types.INT64                       `json:"optionalThreshold"`
	ReceiverFinalityConfig core.FinalityConfig               `json:"receiverFinalityConfig"`
}

CCIPReceiver is a Template type

func (CCIPReceiver) Archive

func (t CCIPReceiver) Archive(contractID string) *model.ExerciseCommand

Archive exercises the Archive choice on this CCIPReceiver contract This method uses the package name in the template ID

func (CCIPReceiver) ArchiveWithPackageID

func (t CCIPReceiver) ArchiveWithPackageID(contractID string, packageID string) *model.ExerciseCommand

ArchiveWithPackageID exercises the Archive choice using the provided package ID instead of package name

func (CCIPReceiver) CreateCommand

func (t CCIPReceiver) CreateCommand() *model.CreateCommand

CreateCommand returns a CreateCommand for this template using the package name

func (CCIPReceiver) CreateCommandWithPackageID

func (t CCIPReceiver) CreateCommandWithPackageID(packageID string) *model.CreateCommand

CreateCommandWithPackageID returns a CreateCommand using the provided package ID instead of package name

func (CCIPReceiver) Execute

func (t CCIPReceiver) Execute(contractID string, args Execute) *model.ExerciseCommand

Execute exercises the Execute choice on this CCIPReceiver contract This method uses the package name in the template ID

func (CCIPReceiver) ExecuteWithPackageID

func (t CCIPReceiver) ExecuteWithPackageID(contractID string, packageID string, args Execute) *model.ExerciseCommand

ExecuteWithPackageID exercises the Execute choice using the provided package ID instead of package name

func (CCIPReceiver) GetRequiredCCVs

func (t CCIPReceiver) GetRequiredCCVs(contractID string, args GetRequiredCCVs) *model.ExerciseCommand

GetRequiredCCVs exercises the GetRequiredCCVs choice on this CCIPReceiver contract This method uses the package name in the template ID

func (CCIPReceiver) GetRequiredCCVsWithPackageID

func (t CCIPReceiver) GetRequiredCCVsWithPackageID(contractID string, packageID string, args GetRequiredCCVs) *model.ExerciseCommand

GetRequiredCCVsWithPackageID exercises the GetRequiredCCVs choice using the provided package ID instead of package name

func (CCIPReceiver) GetTemplateID

func (t CCIPReceiver) GetTemplateID() string

GetTemplateID returns the template ID for this template using the package name

func (CCIPReceiver) GetTemplateIDWithPackageID

func (t CCIPReceiver) GetTemplateIDWithPackageID(packageID string) string

GetTemplateIDWithPackageID returns the template ID using the provided package ID instead of package name

func (CCIPReceiver) MarshalHex

func (t CCIPReceiver) MarshalHex() (string, error)

MarshalHex encodes CCIPReceiver to hex string (Canton MCMS format)

func (CCIPReceiver) MarshalJSON

func (t CCIPReceiver) MarshalJSON() ([]byte, error)

func (*CCIPReceiver) UnmarshalHex

func (t *CCIPReceiver) UnmarshalHex(data string) error

UnmarshalHex decodes CCIPReceiver from hex string (Canton MCMS format)

func (*CCIPReceiver) UnmarshalJSON

func (t *CCIPReceiver) UnmarshalJSON(data []byte) error

func (CCIPReceiver) UpdateRequiredCCVs

func (t CCIPReceiver) UpdateRequiredCCVs(contractID string, args UpdateRequiredCCVs) *model.ExerciseCommand

UpdateRequiredCCVs exercises the UpdateRequiredCCVs choice on this CCIPReceiver contract This method uses the package name in the template ID

func (CCIPReceiver) UpdateRequiredCCVsWithPackageID

func (t CCIPReceiver) UpdateRequiredCCVsWithPackageID(contractID string, packageID string, args UpdateRequiredCCVs) *model.ExerciseCommand

UpdateRequiredCCVsWithPackageID exercises the UpdateRequiredCCVs choice using the provided package ID instead of package name

type CCVInput

type CCVInput struct {
	CcvCid          types.CONTRACT_ID                          `json:"ccvCid"`
	VerifierResults types.TEXT                                 `json:"verifierResults"`
	CcvExtraContext splice_api_token_metadata_v1.ChoiceContext `json:"ccvExtraContext"`
}

CCVInput is a Record type

func (CCVInput) MarshalHex

func (t CCVInput) MarshalHex() (string, error)

MarshalHex encodes CCVInput to hex string (Canton MCMS format)

func (CCVInput) MarshalJSON

func (t CCVInput) MarshalJSON() ([]byte, error)

func (CCVInput) ToMap

func (t CCVInput) ToMap() map[string]any

ToMap converts CCVInput to a map for DAML arguments

func (*CCVInput) UnmarshalHex

func (t *CCVInput) UnmarshalHex(data string) error

UnmarshalHex decodes CCVInput from hex string (Canton MCMS format)

func (*CCVInput) UnmarshalJSON

func (t *CCVInput) UnmarshalJSON(data []byte) error

type Contract

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

Contract wraps template operations with Sui-style API access. Use NewContract to create instances, then call Encoder() for encoding methods.

func NewContract

func NewContract(packageID, moduleName, templateName string) *Contract

NewContract creates a Contract with encoder for the given template. This provides Sui-style API: contract.Encoder().Method(args)

func (*Contract) Encoder

func (c *Contract) Encoder() MCMSEncoder

Encoder returns the encoder for Sui-style contract.Encoder().Method() usage.

type Execute

type Execute struct {
	Context        splice_api_token_metadata_v1.ChoiceContext `json:"context"`
	RouterCid      types.CONTRACT_ID                          `json:"routerCid"`
	EncodedMessage types.TEXT                                 `json:"encodedMessage"`
	TokenTransfer  *TokenTransferInput                        `json:"tokenTransfer" hex:"optional"`
	CcvInputs      []CCVInput                                 `json:"ccvInputs"`
}

Execute is a Record type

func (Execute) MarshalHex

func (t Execute) MarshalHex() (string, error)

MarshalHex encodes Execute to hex string (Canton MCMS format)

func (Execute) MarshalJSON

func (t Execute) MarshalJSON() ([]byte, error)

func (Execute) ToMap

func (t Execute) ToMap() map[string]any

ToMap converts Execute to a map for DAML arguments

func (*Execute) UnmarshalHex

func (t *Execute) UnmarshalHex(data string) error

UnmarshalHex decodes Execute from hex string (Canton MCMS format)

func (*Execute) UnmarshalJSON

func (t *Execute) UnmarshalJSON(data []byte) error

type GetRequiredCCVs

type GetRequiredCCVs struct {
	Context        splice_api_token_metadata_v1.ChoiceContext `json:"context"`
	RouterCid      types.CONTRACT_ID                          `json:"routerCid"`
	EncodedMessage types.TEXT                                 `json:"encodedMessage"`
	TokenPoolCid   *types.CONTRACT_ID                         `json:"tokenPoolCid" hex:"optional"`
}

GetRequiredCCVs is a Record type

func (GetRequiredCCVs) MarshalHex

func (t GetRequiredCCVs) MarshalHex() (string, error)

MarshalHex encodes GetRequiredCCVs to hex string (Canton MCMS format)

func (GetRequiredCCVs) MarshalJSON

func (t GetRequiredCCVs) MarshalJSON() ([]byte, error)

func (GetRequiredCCVs) ToMap

func (t GetRequiredCCVs) ToMap() map[string]any

ToMap converts GetRequiredCCVs to a map for DAML arguments

func (*GetRequiredCCVs) UnmarshalHex

func (t *GetRequiredCCVs) UnmarshalHex(data string) error

UnmarshalHex decodes GetRequiredCCVs from hex string (Canton MCMS format)

func (*GetRequiredCCVs) UnmarshalJSON

func (t *GetRequiredCCVs) UnmarshalJSON(data []byte) error

type MCMSEncoder

type MCMSEncoder interface {
	Execute(args Execute) (*bind.EncodedChoice, error)
	GetRequiredCCVs(args GetRequiredCCVs) (*bind.EncodedChoice, error)
	UpdateRequiredCCVs(args UpdateRequiredCCVs) (*bind.EncodedChoice, error)
}

MCMSEncoder interface for typed encoding methods. Implemented by Encoder for method-based encoding.

type Template

type Template interface {
	CreateCommand() *model.CreateCommand
	GetTemplateID() string
}

type TokenTransferInput

type TokenTransferInput struct {
	TokenPoolCid       types.CONTRACT_ID                          `json:"tokenPoolCid"`
	TokenReceiverParty types.PARTY                                `json:"tokenReceiverParty"`
	PoolExtraContext   splice_api_token_metadata_v1.ChoiceContext `json:"poolExtraContext"`
}

TokenTransferInput is a Record type

func (TokenTransferInput) MarshalHex

func (t TokenTransferInput) MarshalHex() (string, error)

MarshalHex encodes TokenTransferInput to hex string (Canton MCMS format)

func (TokenTransferInput) MarshalJSON

func (t TokenTransferInput) MarshalJSON() ([]byte, error)

func (TokenTransferInput) ToMap

func (t TokenTransferInput) ToMap() map[string]any

ToMap converts TokenTransferInput to a map for DAML arguments

func (*TokenTransferInput) UnmarshalHex

func (t *TokenTransferInput) UnmarshalHex(data string) error

UnmarshalHex decodes TokenTransferInput from hex string (Canton MCMS format)

func (*TokenTransferInput) UnmarshalJSON

func (t *TokenTransferInput) UnmarshalJSON(data []byte) error

type UpdateRequiredCCVs

type UpdateRequiredCCVs struct {
	NewRequiredCCVs []chainlinkapi.RawInstanceAddress `json:"newRequiredCCVs"`
}

UpdateRequiredCCVs is a Record type

func (UpdateRequiredCCVs) MarshalHex

func (t UpdateRequiredCCVs) MarshalHex() (string, error)

MarshalHex encodes UpdateRequiredCCVs to hex string (Canton MCMS format)

func (UpdateRequiredCCVs) MarshalJSON

func (t UpdateRequiredCCVs) MarshalJSON() ([]byte, error)

func (UpdateRequiredCCVs) ToMap

func (t UpdateRequiredCCVs) ToMap() map[string]any

ToMap converts UpdateRequiredCCVs to a map for DAML arguments

func (*UpdateRequiredCCVs) UnmarshalHex

func (t *UpdateRequiredCCVs) UnmarshalHex(data string) error

UnmarshalHex decodes UpdateRequiredCCVs from hex string (Canton MCMS format)

func (*UpdateRequiredCCVs) UnmarshalJSON

func (t *UpdateRequiredCCVs) UnmarshalJSON(data []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL