@hyperbridge/sdk 1.4.5 → 1.4.7-rc0000000001

package/dist/browser/index.d.ts

@@ -717,8 +717,8 @@ declare class EvmChain implements IChain {
      * @param request - The post request to calculate the fee for
      * @returns The total fee in wei required to send the post request
      */
-    quote(request: IPostRequest): Promise<bigint>;
-    quoteNative(request: IPostRequest, fee: bigint): Promise<bigint>;
+    quote(request: IPostRequest | IGetRequest): Promise<bigint>;
+    quoteNative(request: IPostRequest | IGetRequest, fee: bigint): Promise<bigint>;
     private getAmountsIn;
     /**
      * Estimates the gas required for a post request execution on this chain.
@@ -2994,6 +2994,11 @@ declare class IntentGateway {
      */
     isOrderFilled(order: Order): Promise<boolean>;
     private submitAndConfirmReceipt;
+    /**
+     * Returns the native token amount required to dispatch a cancellation GET request for the given order.
+     * Internally constructs the IGetRequest and calls quoteNative.
+     */
+    quoteCancelNative(order: Order): Promise<bigint>;
     /**
      * Cancels an order through the cross-chain protocol by generating and submitting proofs.
      * This is an async generator function that yields status updates throughout the cancellation process.
@@ -3123,7 +3128,7 @@ type HyperbridgeTxEvents = {
     error: unknown;
 };
 /**
- * Parameters for teleporting DOT from Polkadot relay chain to EVM-based destination
+ * Parameters for teleporting DOT from AssetHub to EVM-based destination
  */
 type XcmGatewayParams = {
     /**
@@ -3152,33 +3157,32 @@ type XcmGatewayParams = {
     paraId: number;
 };
 /**
- * Teleports DOT tokens from Polkadot relay chain to an EVM-based destination chain
- * using XCM (Cross-Consensus Message Format) and uses the indexer client to track
- * the transaction instead of polling hyperbridge blocks.
+ * Teleports DOT tokens from AssetHub to Hyperbridge parachain
+ * using XCM V3 with transferAssetsUsingTypeAndThen.
+ *
+ * This function uses transferAssetsUsingTypeAndThen to construct XCM V3 transfers with a custom
+ * beneficiary structure that embeds Hyperbridge-specific parameters (sender account, recipient EVM address,
+ * timeout, and nonce) within an X4 junction. The beneficiary is wrapped in a DepositAsset XCM V3 instruction
+ * that deposits all transferred assets. The assets are transferred using LocalReserve transfer type.
  *
- * This function initiates a teleport transaction, monitors its status through the indexer,
- * and yields events about the transaction's progress through a ReadableStream.
  * It handles the complete lifecycle of a teleport operation:
- * 1. Transaction preparation and signing
- * 2. Broadcasting to the relay chain
- * 3. Tracking the transaction via the indexer client
- * 4. Yielding events about transaction status
+ * 1. Encoding Hyperbridge parameters into the beneficiary X4 junction
+ * 2. Wrapping the beneficiary in a DepositAsset XCM V3 instruction using sourceApi.createType
+ * 3. Constructing the XCM V3 transfer transaction using polkadotXcm.transferAssetsUsingTypeAndThen
+ * 4. Transaction signing and broadcasting
+ * 5. Yielding events about transaction status through a ReadableStream
  *
  * Note: There is no guarantee that both Dispatched and Finalized events will be yielded.
  * Consumers should listen for either one of these events instead of expecting both.
  *
- * @param sourceApi - Polkadot API instance connected to the relay chain or asset hub
- * @param sourceIsAssetHub - If `true` uses AssetHub Network for teleport
+ * @param sourceApi - Polkadot API instance connected to AssetHub
  * @param who - Sender's SS58Address address
  * @param options - Transaction signing options
- * @param params - Teleport parameters including destination, recipient, and amount
- * @param indexerClient - The indexer client to track the transaction
- * @param pollInterval - Optional polling interval in milliseconds (default: 2000)
+ * @param params - Teleport parameters including destination, recipient, amount, timeout, and paraId
  * @yields {HyperbridgeTxEvents} Stream of events indicating transaction status
  */
 declare function teleportDot(param_: {
     sourceApi: ApiPromise;
-    sourceIsAssetHub: boolean;
     who: string;
     xcmGatewayParams: XcmGatewayParams;
     options: Partial<SignerOptions>;

package/dist/browser/index.js

@@ -10,12 +10,11 @@ import { WsProvider, ApiPromise } from '@polkadot/api';
 import { keccakAsU8a, decodeAddress, keccakAsHex, xxhashAsU8a } from '@polkadot/util-crypto';
 import { GraphQLClient } from 'graphql-request';
 import { Decimal } from 'decimal.js';
-import { createStorage } from 'unstorage';
 import stringify from 'safe-stable-stringify';
-import fsDriver from 'unstorage/drivers/fs';
+import { createStorage } from 'unstorage';
+import inMemoryDriver from 'unstorage/drivers/memory';
 import indexedDBDriver from 'unstorage/drivers/indexedb';
 import localStorageDriver from 'unstorage/drivers/localstorage';
-import memoryDriver from 'unstorage/drivers/memory';
 import { hexToU8a, u8aToHex } from '@polkadot/util';
 
 var __defProp = Object.defineProperty;
@@ -6081,13 +6080,14 @@ var EvmChain = class {
    * @returns The total fee in wei required to send the post request
    */
   async quote(request) {
+    const bodyByteLength = "body" in request ? Math.floor((request.body.length - 2) / 2) : Math.floor((request.context.length - 2) / 2);
+    const args = "body" in request ? [toHex(request.dest)] : [toHex(request.source)];
     const perByteFee = await this.publicClient.readContract({
       address: this.params.host,
       abi: evmHost_default.ABI,
       functionName: "perByteFee",
-      args: [toHex(request.dest)]
+      args
     });
-    const bodyByteLength = Math.floor((request.body.length - 2) / 2);
     const length = bodyByteLength < 32 ? 32 : bodyByteLength;
     return perByteFee * BigInt(length);
   }
@@ -6923,7 +6923,7 @@ query GetResponseByRequestId($requestId: String!) {
 `;
 var ORDER_STATUS = `
 query OrderStatus($commitment: String!) {
-  orderPlaceds(
+  orders(
     filter: { commitment: { equalTo: $commitment } }
   ) {
     nodes {
@@ -6944,6 +6944,7 @@ query OrderStatus($commitment: String!) {
       outputBeneficiaries
       calldata
       status
+      referrer
       createdAt
       blockNumber
       blockTimestamp
@@ -10051,6 +10052,87 @@ var ABI4 = [
   }
 ];
 var IntentGateway_default = { ABI: ABI4 };
+var BASE_KEY = "hyperbridge/sdk/proof";
+var loadDriver = ({ key }) => {
+  if (key === "localstorage") {
+    return localStorageDriver({ base: BASE_KEY });
+  }
+  if (key === "indexeddb") {
+    return indexedDBDriver({ base: BASE_KEY });
+  }
+  console.warn(
+    `Hyperbridge/SDK/BrowserDriver: Unexpected storage driver: ${key}. Driver can't be loaded in the browser environment.`
+  );
+  return null;
+};
+
+// src/storage/index.ts
+var convertBigIntsToSerializable = (value) => {
+  if (value === null || value === void 0) return value;
+  if (typeof value === "bigint") return { __type: "bigint", value: value.toString() };
+  if (Array.isArray(value)) return value.map(convertBigIntsToSerializable);
+  if (typeof value === "object") {
+    return Object.entries(value).reduce((acc, [k, v]) => {
+      acc[k] = convertBigIntsToSerializable(v);
+      return acc;
+    }, {});
+  }
+  return value;
+};
+var convertSerializableToBigInts = (value) => {
+  if (value === null || value === void 0) return value;
+  if (Array.isArray(value)) return value.map(convertSerializableToBigInts);
+  if (typeof value === "object" && value !== null) {
+    const obj = value;
+    if (obj.__type === "bigint" && typeof obj.value === "string") {
+      return BigInt(obj.value);
+    }
+    return Object.entries(obj).reduce((acc, [k, v]) => {
+      acc[k] = convertSerializableToBigInts(v);
+      return acc;
+    }, {});
+  }
+  return value;
+};
+var detectEnvironment = () => {
+  if (typeof process !== "undefined" && !!process.versions?.node) return "node";
+  if (typeof globalThis !== "undefined" && "localStorage" in globalThis) return "localstorage";
+  if (typeof globalThis !== "undefined" && "indexedDB" in globalThis) return "indexeddb";
+  return "memory";
+};
+function createCancellationStorage(options = {}) {
+  const key = options.env ?? detectEnvironment();
+  const driver = loadDriver({ key}) ?? inMemoryDriver;
+  const baseStorage = createStorage({ driver });
+  const getItem = async (key2) => {
+    const value = await baseStorage.getItem(key2);
+    if (!value) return null;
+    try {
+      return convertSerializableToBigInts(JSON.parse(value));
+    } catch {
+      return value;
+    }
+  };
+  const setItem = async (key2, value) => {
+    const serializable = convertBigIntsToSerializable(value);
+    const stringified = stringify(serializable) ?? "null";
+    await baseStorage.setItem(key2, stringified);
+  };
+  const removeItem = async (key2) => {
+    baseStorage.removeItem(key2);
+  };
+  return Object.freeze({
+    ...baseStorage,
+    getItem,
+    setItem,
+    removeItem
+  });
+}
+var STORAGE_KEYS = Object.freeze({
+  destProof: (orderId) => `cancel-order:${orderId}:destProof`,
+  getRequest: (orderId) => `cancel-order:${orderId}:getRequest`,
+  sourceProof: (orderId) => `cancel-order:${orderId}:sourceProof`
+});
 
 // src/abis/uniswapV3Quoter.ts
 var ABI5 = [
@@ -12371,81 +12453,6 @@ var Swap = class {
     }
   }
 };
-var convertBigIntsToSerializable = (value) => {
-  if (value === null || value === void 0) return value;
-  if (typeof value === "bigint") return { __type: "bigint", value: value.toString() };
-  if (Array.isArray(value)) return value.map(convertBigIntsToSerializable);
-  if (typeof value === "object") {
-    return Object.entries(value).reduce((acc, [k, v]) => {
-      acc[k] = convertBigIntsToSerializable(v);
-      return acc;
-    }, {});
-  }
-  return value;
-};
-var convertSerializableToBigInts = (value) => {
-  if (value === null || value === void 0) return value;
-  if (Array.isArray(value)) return value.map(convertSerializableToBigInts);
-  if (typeof value === "object" && value !== null) {
-    const obj = value;
-    if (obj.__type === "bigint" && typeof obj.value === "string") {
-      return BigInt(obj.value);
-    }
-    return Object.entries(obj).reduce((acc, [k, v]) => {
-      acc[k] = convertSerializableToBigInts(v);
-      return acc;
-    }, {});
-  }
-  return value;
-};
-var detectEnvironment = () => {
-  if (typeof process !== "undefined" && !!process.versions?.node) return "node";
-  if (typeof globalThis !== "undefined" && "localStorage" in globalThis) return "localstorage";
-  if (typeof globalThis !== "undefined" && "indexedDB" in globalThis) return "indexeddb";
-  return "memory";
-};
-function createCancellationStorage(options = {}) {
-  const environment = options.env ?? detectEnvironment();
-  const driver = (() => {
-    switch (environment) {
-      case "node":
-        return fsDriver({ base: options.basePath ?? "./.hyperbridge-cache" });
-      case "localstorage":
-        return localStorageDriver({ base: "hyperbridge" });
-      case "indexeddb":
-        return indexedDBDriver({ base: "hyperbridge" });
-      default:
-        return memoryDriver();
-    }
-  })();
-  const baseStorage = createStorage({ driver });
-  const getItem = async (key) => {
-    const value = await baseStorage.getItem(key);
-    if (!value) return null;
-    try {
-      return convertSerializableToBigInts(JSON.parse(value));
-    } catch {
-      return value;
-    }
-  };
-  const setItem = async (key, value) => {
-    const serializable = convertBigIntsToSerializable(value);
-    const stringified = stringify(serializable) ?? "null";
-    await baseStorage.setItem(key, stringified);
-  };
-  const removeItem = (key) => baseStorage.removeItem(key);
-  return Object.freeze({
-    ...baseStorage,
-    getItem,
-    setItem,
-    removeItem
-  });
-}
-var STORAGE_KEYS = Object.freeze({
-  destProof: (orderId) => `cancel-order:${orderId}:destProof`,
-  getRequest: (orderId) => `cancel-order:${orderId}:getRequest`,
-  sourceProof: (orderId) => `cancel-order:${orderId}:sourceProof`
-});
 
 // src/protocols/intents.ts
 var IntentGateway = class {
@@ -12519,7 +12526,10 @@ var IntentGateway = class {
               tokenAddress,
               allowanceData
             );
-            stateDiffs.push({ slot: allowanceSlot, value: testValue });
+            stateDiffs.push({
+              slot: allowanceSlot,
+              value: testValue
+            });
           } catch (e) {
             console.warn(`Could not find allowance slot for token ${tokenAddress}:`, e);
           }
@@ -12782,6 +12792,60 @@ var IntentGateway = class {
     }
     console.log("Hyperbridge Receipt confirmed.");
   }
+  /**
+   * Returns the native token amount required to dispatch a cancellation GET request for the given order.
+   * Internally constructs the IGetRequest and calls quoteNative.
+   */
+  async quoteCancelNative(order) {
+    const orderWithCommitment = transformOrder(order);
+    const height = orderWithCommitment.deadline + 1n;
+    const destIntentGateway = this.dest.configService.getIntentGatewayAddress(orderWithCommitment.destChain);
+    const slotHash = await this.dest.client.readContract({
+      abi: IntentGateway_default.ABI,
+      address: destIntentGateway,
+      functionName: "calculateCommitmentSlotHash",
+      args: [orderWithCommitment.id]
+    });
+    const key = concatHex([destIntentGateway, slotHash]);
+    const context = encodeAbiParameters(
+      [
+        {
+          name: "requestBody",
+          type: "tuple",
+          components: [
+            { name: "commitment", type: "bytes32" },
+            { name: "beneficiary", type: "bytes32" },
+            {
+              name: "tokens",
+              type: "tuple[]",
+              components: [
+                { name: "token", type: "bytes32" },
+                { name: "amount", type: "uint256" }
+              ]
+            }
+          ]
+        }
+      ],
+      [
+        {
+          commitment: orderWithCommitment.id,
+          beneficiary: orderWithCommitment.user,
+          tokens: orderWithCommitment.inputs
+        }
+      ]
+    );
+    const getRequest = {
+      source: orderWithCommitment.sourceChain,
+      dest: orderWithCommitment.destChain,
+      from: this.source.configService.getIntentGatewayAddress(orderWithCommitment.destChain),
+      nonce: await this.source.getHostNonce(),
+      height,
+      keys: [key],
+      timeoutTimestamp: 0n,
+      context
+    };
+    return await this.source.quoteNative(getRequest, 0n);
+  }
   /**
    * Cancels an order through the cross-chain protocol by generating and submitting proofs.
    * This is an async generator function that yields status updates throughout the cancellation process.
@@ -12825,7 +12889,7 @@ var IntentGateway = class {
    */
   async *cancelOrder(order, indexerClient) {
     const orderId = orderCommitment(order);
-    let hyperbridge = indexerClient.hyperbridge;
+    const hyperbridge = indexerClient.hyperbridge;
     const sourceStateMachine = hexToString$1(order.sourceChain);
     const sourceConsensusStateId = this.source.configService.getConsensusStateId(sourceStateMachine);
     let destIProof = await this.storage.getItem(STORAGE_KEYS.destProof(orderId));
@@ -12835,19 +12899,30 @@ var IntentGateway = class {
     }
     let getRequest = await this.storage.getItem(STORAGE_KEYS.getRequest(orderId));
     if (!getRequest) {
-      const transactionHash = yield { status: "AWAITING_GET_REQUEST", data: void 0 };
-      const receipt = await this.source.client.getTransactionReceipt({ hash: transactionHash });
+      const transactionHash = yield {
+        status: "AWAITING_GET_REQUEST",
+        data: void 0
+      };
+      const receipt = await this.source.client.getTransactionReceipt({
+        hash: transactionHash
+      });
       const events = parseEventLogs({ abi: evmHost_default.ABI, logs: receipt.logs });
       const request = events.find((e) => e.eventName === "GetRequestEvent");
       if (!request) throw new Error("GetRequest missing");
       getRequest = request.args;
       await this.storage.setItem(STORAGE_KEYS.getRequest(orderId), getRequest);
     }
-    const commitment = getRequestCommitment({ ...getRequest, keys: [...getRequest.keys] });
+    const commitment = getRequestCommitment({
+      ...getRequest,
+      keys: [...getRequest.keys]
+    });
     const sourceStatusStream = indexerClient.getRequestStatusStream(commitment);
     for await (const statusUpdate of sourceStatusStream) {
       if (statusUpdate.status === RequestStatus.SOURCE_FINALIZED) {
-        yield { status: "SOURCE_FINALIZED", data: { metadata: statusUpdate.metadata } };
+        yield {
+          status: "SOURCE_FINALIZED",
+          data: { metadata: statusUpdate.metadata }
+        };
         const sourceHeight = BigInt(statusUpdate.metadata.blockNumber);
         let sourceIProof = await this.storage.getItem(STORAGE_KEYS.sourceProof(orderId));
         if (!sourceIProof) {
@@ -12878,11 +12953,17 @@ var IntentGateway = class {
         continue;
       }
       if (statusUpdate.status === RequestStatus.HYPERBRIDGE_DELIVERED) {
-        yield { status: "HYPERBRIDGE_DELIVERED", data: statusUpdate };
+        yield {
+          status: "HYPERBRIDGE_DELIVERED",
+          data: statusUpdate
+        };
         continue;
       }
       if (statusUpdate.status === RequestStatus.HYPERBRIDGE_FINALIZED) {
-        yield { status: "HYPERBRIDGE_FINALIZED", data: statusUpdate };
+        yield {
+          status: "HYPERBRIDGE_FINALIZED",
+          data: statusUpdate
+        };
         await this.storage.removeItem(STORAGE_KEYS.destProof(orderId));
         await this.storage.removeItem(STORAGE_KEYS.getRequest(orderId));
         await this.storage.removeItem(STORAGE_KEYS.sourceProof(orderId));
@@ -13116,7 +13197,7 @@ var MultiAccount = Struct({
 });
 var DECIMALS = 10;
 async function teleportDot(param_) {
-  const { sourceApi, sourceIsAssetHub, who, options, xcmGatewayParams: params } = param_;
+  const { sourceApi, who, options, xcmGatewayParams: params } = param_;
   const { nonce: accountNonce } = await sourceApi.query.system.account(who);
   const encoded_message = MultiAccount.enc({
     substrate_account: decodeAddress(who),
@@ -13127,7 +13208,7 @@ async function teleportDot(param_) {
   });
   const message_id = keccakAsHex(encoded_message);
   const beneficiary = {
-    V3: {
+    V4: {
       parents: 0,
       interior: {
         X4: [
@@ -13157,81 +13238,58 @@ async function teleportDot(param_) {
       }
     }
   };
-  let assets2;
-  let destination;
-  if (sourceIsAssetHub) {
-    destination = {
-      V3: {
-        parents: 1,
-        interior: {
-          X1: {
-            Parachain: params.paraId
-          }
-        }
+  const destination = {
+    V4: {
+      parents: 1,
+      interior: {
+        X1: [{ Parachain: params.paraId }]
       }
-    };
-    assets2 = {
-      V3: [
-        {
-          id: {
-            Concrete: {
-              parents: 1,
-              interior: "Here"
-            }
-          },
-          fun: {
-            Fungible: parseUnits(params.amount.toString(), DECIMALS)
-          }
-        }
-      ]
-    };
-  } else {
-    destination = {
-      V3: {
-        parents: 0,
-        interior: {
-          X1: {
-            Parachain: params.paraId
-          }
+    }
+  };
+  const assets2 = {
+    V4: [
+      {
+        id: {
+          parents: 1,
+          interior: "Here"
+        },
+        fun: {
+          Fungible: parseUnits(params.amount.toString(), DECIMALS)
         }
       }
-    };
-    assets2 = {
-      V3: [
-        {
-          id: {
-            Concrete: {
-              parents: 0,
-              interior: "Here"
+    ]
+  };
+  const weightLimit = "Unlimited";
+  const feeAssetId = {
+    V4: assets2.V4[0].id
+  };
+  const customXcmOnDest = {
+    V4: [
+      {
+        DepositAsset: {
+          assets: {
+            Wild: {
+              AllCounted: 1
             }
           },
-          fun: {
-            Fungible: parseUnits(params.amount.toString(), DECIMALS)
-          }
+          beneficiary: beneficiary.V4
         }
-      ]
-    };
-  }
-  const feeAssetItem = 0;
-  const weightLimit = "Unlimited";
-  let tx;
-  if (sourceIsAssetHub) {
-    tx = sourceApi.tx.polkadotXcm.limitedReserveTransferAssets(
-      destination,
-      beneficiary,
-      assets2,
-      feeAssetItem,
-      weightLimit
-    );
-  } else {
-    tx = sourceApi.tx.xcmPallet.limitedReserveTransferAssets(
-      destination,
-      beneficiary,
-      assets2,
-      feeAssetItem,
-      weightLimit
-    );
-  }
+      }
+    ]
+  };
+  const tx = sourceApi.tx.polkadotXcm.transferAssetsUsingTypeAndThen(
+    destination,
+    assets2,
+    { LocalReserve: null },
+    // Assets transfer type
+    feeAssetId,
+    // Fee asset ID wrapped as VersionedAssetId
+    { LocalReserve: null },
+    // Remote fee transfer type
+    customXcmOnDest,
+    // XCM instruction with DepositAsset containing custom beneficiary
+    weightLimit
+  );
   let closed = false;
   let unsubscribe;
   const stream = new ReadableStream(