ccip_receiver

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Jun 5, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const ContractType = "CCIPReceiver"

ContractType labels the example CCIP receiver contract.

Variables

View Source
var AcceptOwnership = cldfops.NewOperation(
	"ccip-receiver:accept-ownership",
	stellarops.ContractDeploymentVersion,
	"Accepts CCIP example receiver ownership after transfer_ownership",
	func(b cldfops.Bundle, d stellardeps.StellarDeps, in AcceptOwnershipInput) (stellarops.Void, error) {
		c := recvbindings.NewExampleCcipReceiverClient(d.Invoker, in.ContractID)
		if err := c.AcceptOwnership(b.GetContext()); err != nil {
			return stellarops.Void{}, err
		}
		return stellarops.Void{}, nil
	},
)

AcceptOwnership calls `accept_ownership` on the example CCIP receiver.

View Source
var Deploy = stellarops.NewDeployOperation("ccip-receiver:deploy", "Deploys the example CCIP receiver Soroban contract from WASM")

Deploy uploads ccip_receiver_example.wasm.

View Source
var EnableRemoteChain = cldfops.NewOperation(
	"ccip-receiver:enable-remote-chain",
	stellarops.ContractDeploymentVersion,
	"Enables CCIP receiver processing for a remote chain selector",
	func(b cldfops.Bundle, d stellardeps.StellarDeps, in EnableRemoteChainInput) (stellarops.Void, error) {
		c := recvbindings.NewExampleCcipReceiverClient(d.Invoker, in.ContractID)
		if err := c.EnableRemoteChain(b.GetContext(), in.Caller, in.RemoteChainSelector, in.ExtraArgs, in.AllowedFinalityConfig); err != nil {
			return stellarops.Void{}, err
		}
		return stellarops.Void{}, nil
	},
)

EnableRemoteChain calls `enable_remote_chain`.

View Source
var Initialize = cldfops.NewOperation(
	"ccip-receiver:initialize",
	stellarops.ContractDeploymentVersion,
	"Initializes CCIP example receiver with owner and router",
	func(b cldfops.Bundle, d stellardeps.StellarDeps, in InitializeInput) (stellarops.Void, error) {
		c := recvbindings.NewExampleCcipReceiverClient(d.Invoker, in.ContractID)
		if err := c.Initialize(b.GetContext(), in.Owner, in.Router); err != nil {
			return stellarops.Void{}, err
		}
		return stellarops.Void{}, nil
	},
)

Initialize calls example receiver `initialize`.

View Source
var TransferOwnership = cldfops.NewOperation(
	"ccip-receiver:transfer-ownership",
	stellarops.ContractDeploymentVersion,
	"Transfers CCIP example receiver ownership to a pending new owner",
	func(b cldfops.Bundle, d stellardeps.StellarDeps, in TransferOwnershipInput) (stellarops.Void, error) {
		c := recvbindings.NewExampleCcipReceiverClient(d.Invoker, in.ContractID)
		if err := c.TransferOwnership(b.GetContext(), in.NewOwner); err != nil {
			return stellarops.Void{}, err
		}
		return stellarops.Void{}, nil
	},
)

TransferOwnership calls `transfer_ownership` on the example CCIP receiver.

Functions

This section is empty.

Types

type AcceptOwnershipInput

type AcceptOwnershipInput struct {
	ContractID string `json:"contract_id"`
}

AcceptOwnershipInput completes two-step ownership transfer for the caller.

type EnableRemoteChainInput

type EnableRemoteChainInput struct {
	ContractID            string `json:"contract_id"`
	Caller                string `json:"caller"`
	RemoteChainSelector   uint64 `json:"remote_chain_selector"`
	ExtraArgs             []byte `json:"extra_args"`
	AllowedFinalityConfig uint32 `json:"allowed_finality_config"`
}

EnableRemoteChainInput enables inbound CCIP receive from a remote chain selector.

type InitializeInput

type InitializeInput struct {
	ContractID string `json:"contract_id"`
	Owner      string `json:"owner"`
	Router     string `json:"router"`
}

InitializeInput wires owner and router on the receiver.

type TransferOwnershipInput

type TransferOwnershipInput struct {
	ContractID string `json:"contract_id"`
	NewOwner   string `json:"new_owner"`
}

TransferOwnershipInput starts two-step ownership transfer.

Jump to

Keyboard shortcuts

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