feat: Stacks executor route

Author: kev1n-peters

.github/workflows/publish.yml

@@ -40,6 +40,7 @@ jobs:
             --workspace sdk/definitions \
             --workspace evm/ts \
             --workspace solana \
+            --workspace stacks \
             --workspace sui \
             --workspace sdk/route
         # OIDC authentication is used automatically by npm CLI 11.5.1+

Dockerfile.cli

@@ -48,6 +48,7 @@ COPY solana/package.json solana/package.json
 COPY solana/ts solana/ts
 COPY evm/ts evm/ts
 COPY solana/tsconfig.*.json solana/
+COPY stacks/ts stacks/ts
 COPY sui/ts sui/ts
 COPY cli/package.json cli/package.json
 COPY cli/package-lock.json cli/package-lock.json

cli/package.json

@@ -40,6 +40,12 @@
       "@wormhole-foundation/sdk-solana": "^4.7.0",
       "@wormhole-foundation/sdk-solana-core": "^4.7.0"
     },
+    "@wormhole-foundation/sdk-stacks-ntt": {
+      "@wormhole-foundation/sdk-base": "^4.4.0",
+      "@wormhole-foundation/sdk-definitions": "^4.4.0",
+      "@wormhole-foundation/sdk-stacks": "^4.4.0",
+      "@wormhole-foundation/sdk-stacks-core": "^4.4.0"
+    },
     "@wormhole-foundation/sdk-sui-ntt": {
       "@wormhole-foundation/sdk-base": "^4.7.0",
       "@wormhole-foundation/sdk-definitions": "^4.7.0",

evm/ts/README.md

@@ -1,8 +1,7 @@
 Evm Ntt Implementation
 ----------------------
 
-
-
+> **Note:** These are low-level protocol classes. If you are trying to perform a transfer, use the higher-level Route abstractions such as [`NttExecutorRoute`](../../sdk/route/src/executor/executor.ts) instead.
 
 
 # Building

evm/ts/src/ntt.ts

@@ -563,7 +563,11 @@ export class EvmNtt<N extends Network, C extends EvmChains>
   }
 
   // TODO: should this be some map of idx to transceiver?
-  async *redeem(attestations: Ntt.Attestation[]) {
+  async *redeem(
+    attestations: Ntt.Attestation[],
+    payer: AccountAddress<C>,
+    recipient?: AccountAddress<C>
+  ) {
     if (attestations.length !== this.xcvrs.length)
       throw new Error(
         "Not enough attestations for the registered Transceivers"
@@ -648,7 +652,7 @@ export class EvmNtt<N extends Network, C extends EvmChains>
   async *completeInboundQueuedTransfer(
     fromChain: Chain,
     transceiverMessage: Ntt.Message,
-    payer?: AccountAddress<C>
+    payer: AccountAddress<C>
   ) {
     const tx =
       await this.manager.completeInboundQueuedTransfer.populateTransaction(

foo.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+npm ci
+
+npm i @wormhole-foundation/sdk@latest
+
+npm r -w evm/ts @wormhole-foundation/sdk-base @wormhole-foundation/sdk-definitions @wormhole-foundation/sdk-evm @wormhole-foundation/sdk-evm-core
+npm r -w sdk/definitions @wormhole-foundation/sdk-base @wormhole-foundation/sdk-definitions
+npm r -w sdk/examples @wormhole-foundation/sdk
+npm r -w sdk/route @wormhole-foundation/sdk-connect
+npm r -w solana @wormhole-foundation/sdk-base @wormhole-foundation/sdk-definitions @wormhole-foundation/sdk-solana @wormhole-foundation/sdk-solana-core
+npm r -w sui/ts @wormhole-foundation/sdk-base @wormhole-foundation/sdk-definitions @wormhole-foundation/sdk-sui @wormhole-foundation/sdk-sui-core
+npm r -w stacks/ts @wormhole-foundation/sdk-base @wormhole-foundation/sdk-definitions @wormhole-foundation/sdk-stacks @wormhole-foundation/sdk-stacks-core
+
+npm i -w evm/ts --save-peer @wormhole-foundation/sdk-base@latest @wormhole-foundation/sdk-definitions@latest @wormhole-foundation/sdk-evm@latest @wormhole-foundation/sdk-evm-core@latest
+npm i -w sdk/definitions --save-peer @wormhole-foundation/sdk-base@latest @wormhole-foundation/sdk-definitions@latest
+npm i -w sdk/examples @wormhole-foundation/sdk@latest
+npm i -w sdk/route --save-peer @wormhole-foundation/sdk-connect@latest
+npm i -w solana --save-peer @wormhole-foundation/sdk-base@latest @wormhole-foundation/sdk-definitions@latest @wormhole-foundation/sdk-solana@latest @wormhole-foundation/sdk-solana-core@latest
+npm i -w sui/ts --save-peer @wormhole-foundation/sdk-base@latest @wormhole-foundation/sdk-definitions@latest @wormhole-foundation/sdk-sui@latest @wormhole-foundation/sdk-sui-core@latest
+npm i -w stacks/ts --save-peer @wormhole-foundation/sdk-base@latest @wormhole-foundation/sdk-definitions@latest @wormhole-foundation/sdk-stacks@latest @wormhole-foundation/sdk-stacks-core@latest

package-lock.json

@@ -9,6 +9,7 @@
     "build:solana": "npm run build --workspace=sdk/definitions --workspace=solana",
     "build:evm": "npm run build --workspace=sdk/definitions --workspace=sdk/evm",
     "build:sui": "npm run build --workspace=sdk/definitions --workspace=sui/ts",
+    "build:stacks": "npm run build --workspace=sdk/definitions --workspace=stacks/ts",
     "typecheck:cli": "npm run typecheck --workspace=cli",
     "generate": "npm run generate --workspaces --if-present",
     "test": "npm run test --workspaces --if-present",
@@ -38,6 +39,7 @@
     "sdk/definitions",
     "evm/ts",
     "solana",
+    "stacks/ts",
     "sui/ts",
     "sdk/route",
     "sdk/examples",

package.json

@@ -263,12 +263,15 @@ export interface Ntt<N extends Network, C extends Chain> {
   /**
    * redeem redeems a set of Attestations to the corresponding transceivers on the destination chain
    * @param attestations The attestations to redeem, the length should be equal to the number of transceivers
+   * @param payer The account that will pay for the transaction
+   * @param recipient The recipient address (only used for Stacks, can be undefined for other platforms)
    *
    * TODO: replace with Map<transceiver type, Attestation>
    */
   redeem(
     attestations: Ntt.Attestation[],
-    payer?: AccountAddress<C>
+    payer: AccountAddress<C>,
+    recipient?: AccountAddress<C>
   ): AsyncGenerator<UnsignedTransaction<N, C>>;
 
   /** Get the address for the account that custodies locked tokens  */
@@ -370,7 +373,7 @@ export interface Ntt<N extends Network, C extends Chain> {
   completeInboundQueuedTransfer(
     fromChain: Chain,
     transceiverMessage: Ntt.Message,
-    payer?: AccountAddress<C>
+    payer: AccountAddress<C>
   ): AsyncGenerator<UnsignedTransaction<N, C>>;
 
   /**

sdk/definitions/src/ntt.ts

@@ -21,6 +21,8 @@ export const getDefaultReferrerAddress = (chain: Chain): ChainAddress => {
   } else if (chainToPlatform(chain) === "Sui") {
     address =
       "0xbfa1240e48c622d97881473953be730091161b7931d89bd6afe667841cf69ef4";
+  } else if (chainToPlatform(chain) === "Stacks") {
+    address = "ST117FG1AKZ7724AXYMMABVPE4G2MNQ453SNS0S3"; // TODO: update to actual referrer address
   } else {
     throw new Error(`No referrer address for chain ${chain}`);
   }