add referrer address to config

Author: kev1n-peters

evm/ts/src/nttWithExecutor.ts

@@ -167,7 +167,7 @@ export class EvmNttWithExecutor<N extends Network, C extends EvmChains>
     };
     const feeArgs = {
       dbps: quote.referrerFeeDbps,
-      payee: quote.referrer.address.toString(),
+      payee: quote.referrer ? quote.referrer.address.toString() : senderAddress,
     };
 
     const data = iface.encodeFunctionData("transfer", [

sdk/definitions/src/nttWithExecutor.ts

@@ -13,7 +13,7 @@ export namespace NttWithExecutor {
     relayInstructions: Uint8Array; // The relay instructions for the transfer
     estimatedCost: bigint; // The estimated cost of the transfer in native token base units
     payeeAddress: Uint8Array; // The wallet address on the source chain, designated by the Quoter, to receive funds when requesting an execution
-    referrer: ChainAddress; // The referrer address (to whom the referrer fee should be paid)
+    referrer?: ChainAddress; // The referrer address (to whom the referrer fee should be paid, undefined when fee is 0)
     referrerFee: bigint; // The referrer fee in NTT token base units
     remainingAmount: bigint; // The remaining amount after the referrer fee in NTT token base units
     referrerFeeDbps: bigint; // The referrer fee in *tenths* of basis points

sdk/route/src/executor/consts.ts

@@ -1,20 +1,6 @@
-import {
-  Chain,
-  chainToPlatform,
-  Network,
-} from "@wormhole-foundation/sdk-connect";
+import { Network } from "@wormhole-foundation/sdk-connect";
 
 export const apiBaseUrl: Partial<Record<Network, string>> = {
   Mainnet: "https://executor.labsapis.com",
   Testnet: "https://executor-testnet.labsapis.com",
 };
-
-// Referrer addresses (to whom the referrer fee should be paid)
-export const getReferrerAddress = (chain: Chain): string | undefined => {
-  if (chainToPlatform(chain) === "Evm") {
-    return "0xF11e0efF8b11Ce382645dd75352fC16b3aB3551E";
-  }
-  if (chain === "Solana") {
-    return "JB3rmygUVuVZzgkxvMdV8mSKLJeQAkSXEK284Dqsziah";
-  }
-};

sdk/route/src/executor/executor.ts

@@ -32,10 +32,11 @@ import {
   serializeLayout,
   signSendWait,
   toChainId,
+  Platform,
+  chainToPlatform,
 } from "@wormhole-foundation/sdk-connect";
 import "@wormhole-foundation/sdk-definitions-ntt";
 import { NttRoute } from "../types.js";
-import { getReferrerAddress } from "./consts.js";
 import {
   calculateReferrerFee,
   fetchCapabilities,
@@ -53,13 +54,17 @@ import {
 export namespace NttExecutorRoute {
   export type Config = {
     ntt: NttRoute.Config;
+    referrerFee?: ReferrerFeeConfig;
+  };
+
+  export type ReferrerFeeConfig = {
     // Referrer Fee in *tenths* of basis points - e.g. 10 = 1 basis point (0.01%)
-    referrerFeeDbps?: bigint;
-    perTokenOverrides?: {
-      chain: Chain;
-      address: string;
-      referrerFeeDbps: bigint;
-    }[];
+    feeDbps: bigint;
+    // The address to which the referrer fee will be sent
+    referrerAddresses: Partial<Record<Platform, string>>;
+    perTokenOverrides?: Partial<
+      Record<Chain, Record<string, { referrerFeeDbps: bigint }>>
+    >;
   };
 
   export type Options = {
@@ -191,15 +196,18 @@ export class NttExecutorRoute<N extends Network>
       request.destination.id
     );
 
-    let referrerFeeDbps = this.staticConfig.referrerFeeDbps ?? 0n;
-    if (this.staticConfig.perTokenOverrides) {
-      const srcTokenAddress = canonicalAddress(request.source.id);
-      const override = this.staticConfig.perTokenOverrides.find(
-        (o) =>
-          o.chain === request.source.id.chain && o.address === srcTokenAddress
-      );
-      if (override) {
-        referrerFeeDbps = override.referrerFeeDbps;
+    let referrerFeeDbps = 0n;
+    if (this.staticConfig.referrerFee) {
+      referrerFeeDbps = this.staticConfig.referrerFee.feeDbps;
+      if (this.staticConfig.referrerFee.perTokenOverrides) {
+        const srcTokenAddress = canonicalAddress(request.source.id);
+        const override =
+          this.staticConfig.referrerFee.perTokenOverrides[
+            request.source.id.chain
+          ]?.[srcTokenAddress];
+        if (override) {
+          referrerFeeDbps = override.referrerFeeDbps;
+        }
       }
     }
 
@@ -302,11 +310,17 @@ export class NttExecutorRoute<N extends Network>
   ): Promise<NttWithExecutor.Quote> {
     const { fromChain, toChain } = request;
 
-    const referrerAddress = getReferrerAddress(fromChain.chain);
-    if (!referrerAddress) {
-      throw new Error("No referrer address found");
+    let referrer: ChainAddress | undefined = undefined;
+    const referrerFeeConfig = this.staticConfig.referrerFee;
+    if (referrerFeeConfig && referrerFeeConfig.feeDbps > 0n) {
+      const platform = chainToPlatform(fromChain.chain);
+      const referrerAddress =
+        referrerFeeConfig.referrerAddresses?.[platform] ?? "";
+      if (!referrerAddress) {
+        throw new Error("No referrer address found");
+      }
+      referrer = Wormhole.chainAddress(fromChain.chain, referrerAddress);
     }
-    const referrer = Wormhole.chainAddress(fromChain.chain, referrerAddress);
 
     const { referrerFee, remainingAmount, referrerFeeDbps } =
       calculateReferrerFee(

solana/ts/sdk/nttWithExecutor.ts

@@ -119,6 +119,7 @@ export class SolanaNttWithExecutor<N extends Network, C extends SolanaChains>
         );
 
         if (quote.referrerFee > 0n) {
+          if (!quote.referrer) throw new Error("referrer is required");
           const referrer = new PublicKey(quote.referrer.address.toString());
           const { mint } = await ntt.getConfig();
           const referrerAta = getAssociatedTokenAddressSync(