@galacticcouncil/xc-cfg 2.2.0 → 2.3.0-pr349-c576e3a

package/build/bridges/wormhole/constants.d.ts

@@ -0,0 +1,12 @@
+export declare const NTT_DEFAULT_INSTRUCTIONS = "0x00";
+export declare const NTT_TRIMMED_DECIMALS = 8;
+export declare const EXECUTOR_API = "https://executor.labsapis.com";
+/**
+ * Names the ntt message an Executor request is paying to deliver.
+ *
+ * The sequence is the manager's `nextMessageSequence()` read at build time,
+ * so a transfer through the same manager landing in between leaves the
+ * request pointing at the wrong message. It relays nothing then, and the
+ * transfer stays claimable by hand.
+ */
+export declare const encodeNttRequest: (srcWormholeId: number, nttManager: string, sequence: bigint) => `0x${string}`;

package/build/bridges/wormhole/constants.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/bridges/wormhole/executor/evm.d.ts

@@ -0,0 +1,3 @@
+import { ExecutorBudgetBuilder } from './types';
+/** An evm redeem holds nothing - receiveMessage moves no value. */
+export declare const EvmExecutorBudget: () => ExecutorBudgetBuilder;

package/build/bridges/wormhole/executor/index.d.ts

@@ -0,0 +1,18 @@
+import { EvmExecutorBudget } from './evm';
+import { SolanaExecutorBudget } from './solana';
+import { SuiExecutorBudget } from './sui';
+import { ExecutorBudget, ExecutorBudgetParams } from './types';
+export * from './types';
+/**
+ * Executor budget for a destination.
+ *
+ * Keyed on the destination, not the source: hydration -> sui is an evm source
+ * with a sui destination, and it is sui's budget that has to be met.
+ *
+ * The single place either budget is decided. A signed quote is only honoured
+ * for the instructions it was priced against, so the fee builder and the
+ * transfer builder have to derive them the same way or the amount paid and
+ * the amount requested disagree.
+ */
+export declare const executorBudget: (params: ExecutorBudgetParams) => Promise<ExecutorBudget>;
+export { EvmExecutorBudget, SolanaExecutorBudget, SuiExecutorBudget };

package/build/bridges/wormhole/executor/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/bridges/wormhole/executor/solana.d.ts

@@ -0,0 +1,11 @@
+import { ExecutorBudgetBuilder } from './types';
+/**
+ * An svm redeem mints into the recipient's associated token account and the
+ * relayer opens it when missing, so its rent is charged only then - mirroring
+ * upstream, which adds it on `getAccountInfo(ata) === null`.
+ *
+ * Budgeting it unconditionally would be simpler, but the executor charges
+ * source native for lamports it fronts, so every transfer to an existing
+ * account would pay for rent nobody spends.
+ */
+export declare const SolanaExecutorBudget: () => ExecutorBudgetBuilder;

package/build/bridges/wormhole/executor/sui.d.ts

@@ -0,0 +1,3 @@
+import { ExecutorBudgetBuilder } from './types';
+/** A sui redeem holds nothing - the coin is minted to the recipient. */
+export declare const SuiExecutorBudget: () => ExecutorBudgetBuilder;

package/build/bridges/wormhole/executor/types.d.ts

@@ -0,0 +1,22 @@
+import { AnyChain, Asset } from '@galacticcouncil/xc-core';
+/**
+ * What the Executor is asked to reserve to redeem on a destination.
+ *
+ * `gasLimit` budgets execution, `msgValue` budgets what the executor must
+ * hold. Both are destination units - evm gas, svm compute units, sui MIST -
+ * so neither has a value that is meaningful across chains.
+ */
+export type ExecutorBudget = {
+    gasLimit: bigint;
+    msgValue: bigint;
+};
+export type ExecutorBudgetParams = {
+    destination: AnyChain;
+    /** Destination asset, resolving the spl mint on an svm destination. */
+    asset?: Asset;
+    /** Recipient on the destination, whose accounts the redeem may open. */
+    recipient?: string;
+};
+export interface ExecutorBudgetBuilder {
+    build: (params: ExecutorBudgetParams) => Promise<ExecutorBudget>;
+}

package/build/bridges/wormhole/index.d.ts

@@ -0,0 +1,2 @@
+export * from './constants';
+export * from './executor';

package/build/builders/ContractBuilder.d.ts

@@ -1,18 +1,32 @@
+import { ContractConfigBuilder, ContractConfigBuilderParams, ExtrinsicConfigBuilder } from '@galacticcouncil/xc-core';
 import { Erc20 } from './contracts/Erc20';
 import { PolkadotXcm } from './contracts/PolkadotXcm';
 import { Wormhole } from './contracts/Wormhole';
 export declare function ContractBuilder(): {
     Batch: () => {
-        batchAll: (configs: import("@galacticcouncil/xc-core").ContractConfigBuilder[]) => import("@galacticcouncil/xc-core").ContractConfigBuilder;
+        batchAll: (configs: ContractConfigBuilder[]) => ContractConfigBuilder;
     };
     Erc20: typeof Erc20;
     Basejump: () => {
-        bridgeViaWormhole: () => import("@galacticcouncil/xc-core").ContractConfigBuilder;
+        bridgeViaWormhole: () => ContractConfigBuilder;
     };
     PolkadotXcm: typeof PolkadotXcm;
     Snowbridge: () => {
-        v2SendMessage: () => import("@galacticcouncil/xc-core").ContractConfigBuilder;
-        sendToken: () => import("@galacticcouncil/xc-core").ContractConfigBuilder;
+        v2SendMessage: () => ContractConfigBuilder;
+        sendToken: () => ContractConfigBuilder;
     };
     Wormhole: typeof Wormhole;
 };
+/**
+ * Contract counterpart of {@link ExtrinsicDecorator} - attaches an extrinsic
+ * to run ahead of the call.
+ *
+ * Where the extrinsic decorator can wrap both sides in `Utility.batch_all`
+ * itself, a contract call is not a substrate call: the batching happens later,
+ * once the platform knows the origin is ss58 and has wrapped the call in
+ * `EVM.call`. So this only carries the extrinsic on the config and leaves the
+ * assembly to {@link SubstrateEvm}.
+ */
+export declare function ContractDecorator(predicate: (params: ContractConfigBuilderParams) => boolean, extrinsic: ExtrinsicConfigBuilder): {
+    prior: (config: ContractConfigBuilder) => ContractConfigBuilder;
+};

package/build/builders/ContractBuilder.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/builders/FeeAmountBuilder.d.ts

@@ -13,6 +13,20 @@ declare function XcmPaymentApi(): {
         reserve?: AnyParachain;
     }) => FeeAmountConfigBuilder;
 };
+declare function Wormhole(): {
+    /**
+     * Native gas an executor-delivered NTT transfer pays on top of itself -
+     * the wormhole delivery price plus what the Executor charges to redeem
+     * on the far side.
+     *
+     * Declared as the route's destination fee because an erc20 source pays it
+     * out of a balance the amount never competes for, so
+     * {@link EvmPlatform.estimateFee} deliberately leaves the call value out.
+     * A native gas source must NOT use this - there the value is already part
+     * of the source fee, and charging it twice inflates the route minimum.
+     */
+    quoteExecutorCost: () => FeeAmountConfigBuilder;
+};
 declare function Basejump(): {
     quoteFee: () => FeeAmountConfigBuilder;
 };
@@ -20,5 +34,6 @@ export declare function FeeAmountBuilder(): {
     Basejump: typeof Basejump;
     XcmPaymentApi: typeof XcmPaymentApi;
     Snowbridge: typeof Snowbridge;
+    Wormhole: typeof Wormhole;
 };
 export {};

package/build/builders/contracts/Wormhole/Ntt.d.ts

@@ -1,4 +1,6 @@
 import { ContractConfigBuilder } from '@galacticcouncil/xc-core';
 export declare const Ntt: () => {
     transfer: () => ContractConfigBuilder;
+    transferWithExecutor: () => ContractConfigBuilder;
+    transferViaExecutor: () => ContractConfigBuilder;
 };

package/build/builders/contracts/Wormhole/index.d.ts

@@ -1,5 +1,7 @@
 export declare function Wormhole(): {
     Ntt: () => {
         transfer: () => import("@galacticcouncil/xc-core").ContractConfigBuilder;
+        transferWithExecutor: () => import("@galacticcouncil/xc-core").ContractConfigBuilder;
+        transferViaExecutor: () => import("@galacticcouncil/xc-core").ContractConfigBuilder;
     };
 };

package/build/clients/executor.d.ts

@@ -0,0 +1,27 @@
+import { ExecutorBudget } from '../bridges/wormhole';
+export type ExecutorQuote = {
+    /** Quoter-signed cost attestation, passed through to the shim. */
+    signedQuote: `0x${string}`;
+    /** What the Executor charges for delivery, in source chain native. */
+    estimatedCost: bigint;
+    /** Serialized delivery request the quote was priced for. */
+    relayInstructions: `0x${string}`;
+};
+/**
+ * Off-chain Executor quoting service.
+ *
+ * A signed quote carries its own expiry (an hour, currently) and the executor
+ * rejects a stale one, so quotes are reused only while comfortably live.
+ */
+export declare class ExecutorClient {
+    /**
+     * Price the delivery of one NTT transfer.
+     *
+     * @param srcWormholeId - source chain wormhole id
+     * @param dstWormholeId - destination chain wormhole id
+     * @param budget - what the executor must reserve on the destination, from
+     * {@link executorBudget}. Both halves are keyed here: a quote is only
+     * honoured for the instructions it priced.
+     */
+    quote(srcWormholeId: number, dstWormholeId: number, budget: ExecutorBudget): Promise<ExecutorQuote>;
+}

package/build/clients/executor.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/clients/index.d.ts

@@ -1,2 +1,3 @@
 export * from './base';
 export * from './chain';
+export * from './executor';

package/build/configs/evm/base/templates.d.ts

@@ -1,3 +1,9 @@
 import { Asset, AssetRoute } from '@galacticcouncil/xc-core';
 export declare function toHydrationViaNttTemplate(assetIn: Asset, assetOut: Asset): AssetRoute;
+/**
+ * Executor-delivered variant, offered alongside the self-redeem route above
+ * for the same pair - the sender pays for delivery instead of signing a
+ * redeem on the destination. Cost is native gas on the source chain.
+ */
+export declare function toHydrationViaNttExecutorTemplate(assetIn: Asset, assetOut: Asset): AssetRoute;
 export declare function toHydrationViaBasejumpTemplate(assetIn: Asset, assetOut: Asset): AssetRoute;

package/build/configs/evm/ethereum/templates.d.ts

@@ -1,4 +1,22 @@
 import { Asset, AssetRoute } from '@galacticcouncil/xc-core';
 export declare function toHydrationViaNttTemplate(assetIn: Asset, assetOut: Asset): AssetRoute;
+/**
+ * Executor-delivered variant, offered alongside the self-redeem route above
+ * for the same pair - the sender pays for delivery instead of signing a
+ * redeem on the destination.
+ *
+ * The cost is native gas on the source chain, declared as the destination fee
+ * because an erc20 source pays it from a balance the amount never competes
+ * for (which is why EvmPlatform.estimateFee leaves the call value out there).
+ */
+export declare function toHydrationViaNttExecutorTemplate(assetIn: Asset, assetOut: Asset): AssetRoute;
+/**
+ * Executor-delivered ntt out of a native gas source.
+ *
+ * The delivery price & executor cost come out of the very balance being
+ * bridged, so they are already folded into the source fee - declaring them
+ * as a destination fee too would charge the user twice.
+ */
+export declare function toHydrationViaNttExecutorNativeTemplate(assetIn: Asset, assetOut: Asset): AssetRoute;
 export declare function toHydrationViaSnowbridgeTemplate(assetIn: Asset, assetOut: Asset): AssetRoute;
 export declare function toHydrationViaSnowbridgeV1Template(assetIn: Asset, assetOut: Asset): AssetRoute;

package/build/configs/ntt.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/configs/polkadot/hydration/templates.d.ts

@@ -9,5 +9,24 @@ export declare function toHubExtTemplate(asset: Asset): AssetRoute;
 export declare function toKusamaHubTemplate(asset: Asset, destFee: number, executionFee: number): AssetRoute;
 export declare function toParaErc20Template(asset: Asset, destination: AnyParachain, transferType?: XcmTransferType): AssetRoute;
 export declare function viaNttTemplate(assetIn: Asset, assetOut: Asset, to: AnyChain): AssetRoute;
+/**
+ * Executor-delivered variant, offered alongside the self-redeem route above
+ * for the same pair - the sender pays for delivery instead of signing a
+ * redeem on the destination.
+ *
+ * Cost is charged in weth, hydration's evm native gas - `EVM.call { value }`
+ * debits the weth balance (asset 20), not hdx - whether the transfer is signed
+ * as h160 or wrapped in EVM.call. Ntt still delivers the full amount.
+ *
+ * Must stay an 18 decimal asset: the builder returns a raw evm value, and hdx
+ * would both name the wrong balance and resolve to 12 decimals.
+ *
+ * A sender holding no weth buys it first: the same destination fee swap the
+ * xcm routes use, batched ahead of the call. Only an ss58 origin needs it -
+ * that one pays its extrinsic fee in hdx and can hold zero weth. An h160 has
+ * nothing to batch into, but pays its own gas in weth, so it already holds
+ * some.
+ */
+export declare function viaNttExecutorTemplate(assetIn: Asset, assetOut: Asset, to: AnyChain): AssetRoute;
 export declare function viaSnowbridgeTemplate(assetIn: Asset, assetOut: Asset, to: AnyChain): AssetRoute;
 export declare function viaSnowbridgeV1Template(assetIn: Asset, assetOut: Asset, to: AnyChain): AssetRoute;