Package Exports

@wormhole-labs/cctp-executor-route
@wormhole-labs/cctp-executor-route/dist/cjs/index.js
@wormhole-labs/cctp-executor-route/dist/esm/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@wormhole-labs/cctp-executor-route) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CCTP W7 Executor Route

Releasing

To release this package, follow these steps:

Create a New GitHub Release
- Tag the release with an appropriate semantic version (e.g., 0.1.0, 1.0.0-beta, etc.).
- This will trigger the GitHub Actions workflow responsible for building and packing the package.
GitHub Workflow
- The workflow will:
  - Build the package.
  - Create a tarball (.tgz).
  - Upload the resulting artifact to the assets section of the GitHub Release page.
Installation
- The packed package can be installed in Connect or Portal.

Usage

Once installed, import the route using:

import { CCTPW7ExecutorRoute } from "@wormhole-labs/cctp-w7-executor-route";

Transfer Example

This project includes a script for testing a USDC token transfer using the CCTPv1 Executor route with a referrer fee. You can change the source and destination chains in the examples/transfer.ts file.

Prerequisites

First, install dependencies and build the project:

npm ci && npm run build

Configure Environment Variables

Set your private keys as environment variables:

export EVM_PRIVATE_KEY=<your_evm_private_key>
export SVM_PRIVATE_KEY=<your_svm_private_key>
export SUI_PRIVATE_KEY=<your_sui_private_key>

Run the Example

To fetch a quote for the transfer:

npm run examples:test

To actually send the transfer, set an additional environment variable:

SEND_TRANSFER=true npm run examples:test

⚠️ Note:

All relevant contract addresses and constants are defined in src/consts.

Referrer fee is set to 1 basis point in src/consts.