@swapdk/wdk-protocol-swidge-swapdk 1.0.0-alpha.0

package/dist/index.js

@@ -0,0 +1,10 @@
+// ---------------------------------------------------------------------------
+// @swapdk/wdk-protocol-swidge-swapdk — public exports.
+// ---------------------------------------------------------------------------
+export { SwapDKSwidge } from "./SwapDKSwidge.js";
+export { swapkitChainFor, swidgeChainFor, chainFamilyFor, nativeMetaFor, allSwidgeChains, } from "./chain-map.js";
+export { encodeSwapKitAsset, toHumanAmount, fromHumanAmount, } from "./asset-encode.js";
+// Re-export the swap-engine-client errors that consumers may catch on
+// their end so they don't need to install the client package directly.
+export { SwapDKError, SwapDKNetworkError, SwapDKApiError, SwapDKProviderError, SwapDKUserError, } from "@swapdk/swap-engine-client";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,uDAAuD;AACvD,8EAA8E;AAE9E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAgCjD,OAAO,EACL,eAAe,EACf,cAAc,EACd,cAAc,EACd,aAAa,EACb,eAAe,GAChB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAE3B,sEAAsE;AACtE,uEAAuE;AACvE,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,eAAe,GAChB,MAAM,4BAA4B,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,163 @@
+import type { SwapDKClientConfig } from "@swapdk/swap-engine-client";
+import type { SwidgeProtocolConfig } from "@tetherto/wdk-wallet/protocols";
+/**
+ * Wallet-account interface SwapDKSwidge accepts. This is intentionally a
+ * structural subset of `IWalletAccount` from `@tetherto/wdk-wallet` — we
+ * only need `getAddress()` for source-address handling and `sendTransaction`
+ * for broadcasting. The concrete wallet manager module (e.g.
+ * `@tetherto/wdk-wallet-evm`, `@tetherto/wdk-wallet-tron`) supplies these.
+ *
+ * `sendTransaction` is intentionally typed `unknown`; each source-chain
+ * adapter narrows the argument shape internally and validates before
+ * dispatching. This keeps the type surface small at the top level.
+ */
+export interface SwidgeWalletAccount {
+    getAddress(): string | Promise<string>;
+    sendTransaction(tx: unknown, timeoutMs?: number): Promise<{
+        hash: string;
+        fee: bigint;
+        [key: string]: unknown;
+    }>;
+}
+/**
+ * Opaque marker for a prebuilt tronweb `Transaction`. Downstream
+ * (`@tetherto/wdk-wallet-tron@^1.0.0-beta.8`) detects the prebuilt
+ * shape via `!!tx.txID` and signs + broadcasts it verbatim.
+ */
+export interface TronPrebuiltTransaction {
+    txID: string;
+    [key: string]: unknown;
+}
+/**
+ * Structural subset of the `tronweb` client used by the TRON adapter.
+ * Any object satisfying this shape works — the concrete `TronWeb`
+ * from `import { TronWeb } from 'tronweb'`, forks, or test mocks.
+ */
+export interface TronWebLike {
+    address: {
+        toHex(addr: string): string;
+    };
+    /** Fallback per-tx energy cap when the swap-engine SwapTx doesn't supply one. */
+    feeLimit?: number;
+    transactionBuilder: {
+        /**
+         * Build a `TriggerSmartContract` transaction. When `functionSelector`
+         * is empty and `options.input` is set, tronweb passes the raw hex
+         * as calldata verbatim — the same code path used for the THORChain
+         * router `depositWithExpiry` call and TRC-20 `approve`.
+         */
+        triggerSmartContract(contractAddress: string, functionSelector: string, options: {
+            feeLimit?: number;
+            callValue?: number;
+            input?: string;
+        }, parameters: Array<{
+            type: string;
+            value: string | number | bigint;
+        }>, issuerAddress: string): Promise<{
+            transaction: TronPrebuiltTransaction;
+        }>;
+        /** Build a plain `TransferContract` (native TRX transfer). */
+        sendTrx(to: string, value: number, from: string): Promise<TronPrebuiltTransaction>;
+        /**
+         * Attach a memo to a `TransferContract` via `raw_data.data`. The
+         * memo is part of the tx hash preimage so this MUST be called
+         * before signing — the returned tx has a fresh `txID`.
+         */
+        addUpdateData(transaction: TronPrebuiltTransaction, data: string, encoding?: string): Promise<TronPrebuiltTransaction>;
+    };
+}
+/**
+ * Configuration for `SwapDKSwidge`.
+ *
+ * `defaultFromChain` seeds `fromChain` for quoteSwidge / swidge calls that
+ * omit it — useful when an instance is bound to a specific source (an
+ * `example-wdk-wallet` CLI running with NETWORK=ethereum, for instance).
+ * Per-call `fromChain` in options always wins over this default.
+ */
+export interface SwapDKSwidgeConfig extends SwapDKClientConfig, SwidgeProtocolConfig {
+    /** SwapDK swap-engine base URL (e.g. `"https://api.swapdk.com"`). */
+    apiUrl: string;
+    /** SwapDK API key (sent as `x-api-key`). */
+    apiKey: string;
+    /** Default source chain when options don't set `fromChain`. Optional. */
+    defaultFromChain?: string;
+    /**
+     * Default slippage (decimal, e.g. 0.03 for 3%) when options don't set
+     * either `slippage` or `minAmountOut`. Optional (fallback: 0.03).
+     */
+    defaultSlippage?: number;
+    /**
+     * Bitcoin miner-fee rate in sats/vB. Consumed by the BTC adapter for
+     * both THORChain-path and Chainflip-path deposits. Optional — when
+     * omitted the paired WDK BTC wallet estimates the fee from its
+     * connected Electrum backend.
+     */
+    feeRate?: number | bigint;
+    /**
+     * TronWeb instance the TRON adapter uses to build the prebuilt
+     * transaction (router-contract call or TransferContract-with-memo)
+     * before handing it to `wallet.sendTransaction`. Required for TRON
+     * sources, ignored otherwise. Pass the same tronweb instance the
+     * paired `WalletManagerTron` was constructed with.
+     *
+     * Structurally typed via `TronWebLike` — a subset covering
+     * `address.toHex`, `transactionBuilder.{triggerSmartContract,sendTrx,addUpdateData}`,
+     * and an optional `feeLimit` fallback.
+     */
+    tronWeb?: TronWebLike;
+    /** Optional Chainflip-broker-channel defaults for the BTC adapter. */
+    chainflip?: {
+        /** Refund min-price hex (default: `"0x0"`, no floor). */
+        refundMinPrice?: string;
+        /** Blocks the broker will retry the refund tx (default: 100). */
+        refundRetryDuration?: number;
+        /** DCA number of chunks (default: 1, no DCA). */
+        dcaChunks?: number;
+        /** DCA chunk interval in blocks. Required if `dcaChunks > 1`. */
+        dcaChunkInterval?: number;
+        /** Max boost fee in basis points (default: 0, no boost). */
+        maxBoostFeeBps?: number;
+    };
+}
+/**
+ * Extension of the base `SwidgeOptions` with a source-chain field. Kept
+ * separate from the module's `SwidgeOptions` re-export so consumers using
+ * the base type keep working; consumers that need multi-chain source
+ * routing import this instead.
+ */
+export interface SwapDKSwidgeOptions {
+    /**
+     * Source token identifier. For native gas coins, the upper-case ticker
+     * (`"ETH"`, `"BTC"`, `"TRX"`). For fungibles, the contract address in
+     * its chain-native format (EIP-55 hex for EVM, base58 for TRON /
+     * Solana). Matches the `token` field returned by `getSupportedTokens`.
+     */
+    fromToken: string;
+    /**
+     * Source chain identifier (matches `SwidgeSupportedChain.id`). Required
+     * for multi-family source support unless `SwapDKSwidgeConfig.defaultFromChain`
+     * is set on the instance. Accepts numeric chain-ids for parity with
+     * the base `SwidgeOptions` shape; internally normalized to string.
+     */
+    fromChain?: string | number;
+    /** Destination token identifier — same conventions as `fromToken`. */
+    toToken: string;
+    /**
+     * Destination chain identifier. Omit for same-chain swaps. Accepts
+     * numeric chain-ids for parity with the base `SwidgeOptions` shape.
+     */
+    toChain?: string | number;
+    /** Address receiving the destination tokens. */
+    recipient?: string;
+    /** Address receiving refunds if the route cannot complete. */
+    refundAddress?: string;
+    /** Slippage tolerance as a decimal (0.01 = 1%). Mutually exclusive with `minAmountOut`. */
+    slippage?: number;
+    /** Explicit minimum destination amount (base units). Overrides `slippage`. */
+    minAmountOut?: bigint | number;
+    /** Exact amount to spend (base units of the source token). Mutually exclusive with `toTokenAmount`. */
+    fromTokenAmount?: bigint | number;
+    /** Exact amount to receive (base units of the destination token). Mutually exclusive with `fromTokenAmount`. */
+    toTokenAmount?: bigint | number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAE3E;;;;;;;;;;GAUG;AACH,MAAM,WAAW,mBAAmB;IAClC,UAAU,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACvC,eAAe,CAAC,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QACxD,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE;QAAE,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACzC,iFAAiF;IACjF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,EAAE;QAClB;;;;;WAKG;QACH,oBAAoB,CAClB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,EACxB,OAAO,EAAE;YAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;YAAC,SAAS,CAAC,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,EAClE,UAAU,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC,EACpE,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC;YAAE,WAAW,EAAE,uBAAuB,CAAA;SAAE,CAAC,CAAC;QAErD,8DAA8D;QAC9D,OAAO,CACL,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,uBAAuB,CAAC,CAAC;QAEpC;;;;WAIG;QACH,aAAa,CACX,WAAW,EAAE,uBAAuB,EACpC,IAAI,EAAE,MAAM,EACZ,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,uBAAuB,CAAC,CAAC;KACrC,CAAC;CACH;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB,EAAE,oBAAoB;IAClF,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,sEAAsE;IACtE,SAAS,CAAC,EAAE;QACV,yDAAyD;QACzD,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,iEAAiE;QACjE,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,iDAAiD;QACjD,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,iEAAiE;QACjE,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,4DAA4D;QAC5D,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,sEAAsE;IACtE,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8DAA8D;IAC9D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B,uGAAuG;IACvG,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,gHAAgH;IAChH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACjC"}

package/dist/types.js

@@ -0,0 +1,12 @@
+// ---------------------------------------------------------------------------
+// SwapDKSwidge public types.
+//
+// The base `SwidgeOptions` in @tetherto/wdk-wallet/protocols does not carry a
+// `fromChain` field (only `toChain`), and its `fromToken` is expected to be
+// unambiguous on its own. For SwapDK's multi-family source support (BTC / EVM
+// / Cosmos / Solana / TRON) a plain "USDC" identifier can't disambiguate
+// between ethereum-USDC and arbitrum-USDC, so we extend the base with an
+// explicit `fromChain` — same pattern Orchestra's module uses.
+// ---------------------------------------------------------------------------
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,6BAA6B;AAC7B,EAAE;AACF,8EAA8E;AAC9E,4EAA4E;AAC5E,8EAA8E;AAC9E,yEAAyE;AACzE,yEAAyE;AACzE,+DAA+D;AAC/D,8EAA8E"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@swapdk/wdk-protocol-swidge-swapdk",
+  "version": "1.0.0-alpha.0",
+  "description": "WDK swidge protocol module for arbitrary-asset cross-chain swaps and bridges via the SwapDK swap-engine (THORChain, MAYAChain, Chainflip). Single class covering Bitcoin, EVM, Cosmos-family, Solana, and TRON source chains.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "build": "tsc -b",
+    "prepack": "npm run clean && npm run build",
+    "dev": "tsc -b --watch",
+    "lint": "tsc -b --dry"
+  },
+  "keywords": [
+    "wdk",
+    "tether",
+    "swapdk",
+    "swidge",
+    "cross-chain",
+    "bridge",
+    "swap",
+    "thorchain",
+    "mayachain",
+    "chainflip"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Swap-DK/wdk-protocol-bridges-swapdk.git",
+    "directory": "packages/swidge"
+  },
+  "author": "SwapDK",
+  "bugs": {
+    "url": "https://github.com/Swap-DK/wdk-protocol-bridges-swapdk/issues"
+  },
+  "homepage": "https://swapdk.com",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@solana-program/memo": "^0.11.0",
+    "@solana-program/system": "^0.12.0",
+    "@solana/addresses": "^6.8.0",
+    "@solana/signers": "^6.8.0",
+    "@solana/transaction-messages": "^6.8.0",
+    "@swapdk/swap-engine-client": "^0.3.0"
+  },
+  "peerDependencies": {
+    "@tetherto/wdk-wallet": "1.0.0-beta.11"
+  },
+  "devDependencies": {
+    "@tetherto/wdk-wallet": "1.0.0-beta.11"
+  }
+}