@hyperbridge/sdk 1.0.0

package/dist/utils/xcmGateway.js

@@ -0,0 +1,218 @@
+import { u8aToHex } from "@polkadot/util";
+import { decodeAddress } from "@polkadot/util-crypto";
+import { parseUnits } from "viem";
+const DECIMALS = 10;
+/**
+ * Teleports DOT tokens from Polkadot relay chain to an EVM-based destination chain
+ * using XCM (Cross-Consensus Message Format).
+ *
+ * This function initiates a teleport transaction, monitors its status, and yields events
+ * about the transaction's progress through an AsyncGenerator. It handles the complete
+ * lifecycle of a teleport operation:
+ * 1. Transaction preparation and signing
+ * 2. Broadcasting to the relay chain
+ * 3. Tracking the transaction until it's included in a block
+ * 4. Monitoring  Hyperbridge for the commitment hash
+ *
+ * @param relayApi - Polkadot API instance connected to the relay chain
+ * @param hyperbridge - Polkadot API instance connected to the Hyperbridge parachain
+ * @param who - Sender's SS58Address address
+ * @param options - Transaction signing options
+ * @param params - Teleport parameters including destination, recipient, and amount
+ * @yields {HyperbridgeTxEvents} Stream of events indicating transaction status
+ * @throws {Error} If there's an issue getting the Hyperbridge block or other failures
+ */
+export async function teleportDot(relayApi, hyperbridge, who, options, params) {
+    // 2. initiate the transaction
+    const destination = {
+        V3: {
+            parents: 0,
+            interior: {
+                X1: {
+                    Parachain: params.paraId,
+                },
+            },
+        },
+    };
+    const beneficiary = {
+        V3: {
+            parents: 0,
+            interior: {
+                X3: [
+                    {
+                        AccountId32: {
+                            id: u8aToHex(decodeAddress(who, false, 42)),
+                            network: null,
+                        },
+                    },
+                    {
+                        AccountKey20: {
+                            network: {
+                                Ethereum: {
+                                    chainId: params.destination,
+                                },
+                            },
+                            key: params.recipient,
+                        },
+                    },
+                    {
+                        GeneralIndex: params.timeout,
+                    },
+                ],
+            },
+        },
+    };
+    const assets = {
+        V3: [
+            {
+                id: {
+                    Concrete: {
+                        parents: 0,
+                        interior: "Here",
+                    },
+                },
+                fun: {
+                    Fungible: parseUnits(params.amount.toString(), DECIMALS),
+                },
+            },
+        ],
+    };
+    const feeAssetItem = 0;
+    const weightLimit = "Unlimited";
+    const tx = relayApi.tx.xcmPallet.limitedReserveTransferAssets(destination, beneficiary, assets, feeAssetItem, weightLimit);
+    const finalizedHash = await hyperbridge.rpc.chain.getFinalizedHead();
+    const finalizedHead = await hyperbridge.rpc.chain.getHeader(finalizedHash);
+    const hyperbridgeBlock = finalizedHead.number.toNumber();
+    if (!hyperbridgeBlock)
+        throw new Error("Error getting Hyperbridge Block");
+    let unsubscribe;
+    const stream = new ReadableStream({
+        async start(controller) {
+            unsubscribe = await tx.signAndSend(who, options, async (result) => {
+                try {
+                    const { status, dispatchError, txHash } = result;
+                    // @ts-expect-error Type Mismatch
+                    const events = result.events;
+                    if (dispatchError) {
+                        controller.enqueue({
+                            kind: "Error",
+                            error: `Error watching extrinsic: ${dispatchError.toString()}`,
+                        });
+                        return;
+                    }
+                    if (status.isReady) {
+                        // send tx hash as soon as it is available
+                        controller.enqueue({
+                            kind: "Ready",
+                            transaction_hash: txHash.toHex(),
+                        });
+                    }
+                    else if (status.isInBlock) {
+                        await relayApi.rpc.chain.getHeader(status.asInBlock);
+                        const { commitment, block_number } = await watchForRequestCommitment(hyperbridge, who, params, hyperbridgeBlock);
+                        // send block number once available
+                        controller.enqueue({
+                            kind: "Dispatched",
+                            block_number: block_number,
+                            transaction_hash: txHash.toHex(),
+                            commitment,
+                            events: events,
+                        });
+                    }
+                    if (status.isFinalized) {
+                        controller.enqueue({
+                            kind: "Finalized",
+                            transaction_hash: txHash.toHex(),
+                            events: events,
+                        });
+                    }
+                }
+                catch (err) {
+                    controller.enqueue({
+                        kind: "Error",
+                        error: String(err),
+                    });
+                }
+            });
+        },
+        pull() {
+            // We don't really need a pull in this example
+        },
+        cancel() {
+            // This is called if the reader cancels,
+            unsubscribe?.();
+        },
+    }, {
+        highWaterMark: 3,
+        size: () => 1,
+    });
+    return stream;
+}
+// Watch for the request to be dispatched from hyperbridge
+async function watchForRequestCommitment(hyperbridge, who, params, start_block) {
+    return new Promise((resolve, reject) => {
+        let blockCount = 0;
+        let last_block = start_block;
+        let unsubscribeHyperbridgeEvents = () => { };
+        const handleLatestHeader = async (lastHeader) => {
+            const finalized = lastHeader.number.toNumber();
+            blockCount += Math.max(finalized - last_block, 1);
+            for (let block_number = last_block; block_number <= finalized; block_number++) {
+                const block_hash = await hyperbridge.rpc.chain.getBlockHash(block_number);
+                // just to be safe, query events at this specific hash
+                const apiAt = await hyperbridge.at(block_hash);
+                const events = (await apiAt.query.system.events());
+                for (const record of events) {
+                    const { event } = record;
+                    if (event.section === "xcmGateway" && event.method === "AssetTeleported") {
+                        const commitment = extractCommitmentHashFromEvent({
+                            record,
+                            from: who,
+                            params,
+                        });
+                        if (commitment) {
+                            unsubscribeHyperbridgeEvents?.();
+                            resolve({
+                                commitment,
+                                block_hash: block_hash.toHex(),
+                                block_number: BigInt(block_number),
+                            });
+                        }
+                    }
+                }
+            }
+            last_block = finalized + 1;
+            if (blockCount >= 30) {
+                unsubscribeHyperbridgeEvents?.();
+                reject(new Error("No commitment received"));
+            }
+        };
+        hyperbridge.rpc.chain
+            .subscribeFinalizedHeads((header) => {
+            // @ts-expect-error Issue referencing type
+            return handleLatestHeader(header);
+        })
+            .then((unsubscribe) => {
+            unsubscribeHyperbridgeEvents = unsubscribe;
+        })
+            .catch(reject);
+    });
+}
+/**
+ * Extracts the commitment hash from the event data if the event data
+ * matches the expected data
+ */
+export function extractCommitmentHashFromEvent({ record, from: who, params, }) {
+    const { event } = record;
+    const [from, to, _amount, dest, commitment] = event.data;
+    const decodedFrom = u8aToHex(decodeAddress(from.toString(), false));
+    const decodedWho = u8aToHex(decodeAddress(who, false));
+    const isExpectedEvent = decodedFrom === decodedWho &&
+        to.toString().toLowerCase() === params.recipient.toLowerCase() &&
+        dest.toString().includes(params.destination?.toString());
+    if (!isExpectedEvent) {
+        throw new Error("Error extracting commitment. Data mismatch");
+    }
+    return commitment.toString();
+}
+//# sourceMappingURL=xcmGateway.js.map

package/dist/utils/xcmGateway.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xcmGateway.js","sourceRoot":"","sources":["../../src/utils/xcmGateway.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AA0BjC,MAAM,QAAQ,GAAG,EAAE,CAAA;AAmCnB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAChC,QAAoB,EACpB,WAAuB,EACvB,GAAW,EACX,OAA+B,EAC/B,MAAwB;IAExB,8BAA8B;IAC9B,MAAM,WAAW,GAAG;QACnB,EAAE,EAAE;YACH,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE;gBACT,EAAE,EAAE;oBACH,SAAS,EAAE,MAAM,CAAC,MAAM;iBACxB;aACD;SACD;KACD,CAAA;IAED,MAAM,WAAW,GAAG;QACnB,EAAE,EAAE;YACH,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE;gBACT,EAAE,EAAE;oBACH;wBACC,WAAW,EAAE;4BACZ,EAAE,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;4BAC3C,OAAO,EAAE,IAAI;yBACb;qBACD;oBACD;wBACC,YAAY,EAAE;4BACb,OAAO,EAAE;gCACR,QAAQ,EAAE;oCACT,OAAO,EAAE,MAAM,CAAC,WAAW;iCAC3B;6BACD;4BACD,GAAG,EAAE,MAAM,CAAC,SAAS;yBACrB;qBACD;oBACD;wBACC,YAAY,EAAE,MAAM,CAAC,OAAO;qBAC5B;iBACD;aACD;SACD;KACD,CAAA;IACD,MAAM,MAAM,GAAG;QACd,EAAE,EAAE;YACH;gBACC,EAAE,EAAE;oBACH,QAAQ,EAAE;wBACT,OAAO,EAAE,CAAC;wBACV,QAAQ,EAAE,MAAM;qBAChB;iBACD;gBACD,GAAG,EAAE;oBACJ,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC;iBACxD;aACD;SACD;KACD,CAAA;IAED,MAAM,YAAY,GAAG,CAAC,CAAA;IACtB,MAAM,WAAW,GAAG,WAAW,CAAA;IAE/B,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,4BAA4B,CAC5D,WAAW,EACX,WAAW,EACX,MAAM,EACN,YAAY,EACZ,WAAW,CACX,CAAA;IACD,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAA;IACpE,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;IAC1E,MAAM,gBAAgB,GAAG,aAAa,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAA;IAExD,IAAI,CAAC,gBAAgB;QAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;IAEzE,IAAI,WAAuB,CAAA;IAC3B,MAAM,MAAM,GAAG,IAAI,cAAc,CAChC;QACC,KAAK,CAAC,KAAK,CAAC,UAAU;YACrB,WAAW,GAAG,MAAM,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;gBACjE,IAAI,CAAC;oBACJ,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;oBAChD,iCAAiC;oBACjC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAsC,CAAA;oBAE5D,IAAI,aAAa,EAAE,CAAC;wBACnB,UAAU,CAAC,OAAO,CAAC;4BAClB,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE,6BAA6B,aAAa,CAAC,QAAQ,EAAE,EAAE;yBAC9D,CAAC,CAAA;wBACF,OAAM;oBACP,CAAC;oBAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;wBACpB,0CAA0C;wBAC1C,UAAU,CAAC,OAAO,CAAC;4BAClB,IAAI,EAAE,OAAO;4BACb,gBAAgB,EAAE,MAAM,CAAC,KAAK,EAAE;yBAChC,CAAC,CAAA;oBACH,CAAC;yBAAM,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;wBAC7B,MAAM,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;wBACpD,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,MAAM,yBAAyB,CACnE,WAAW,EACX,GAAG,EACH,MAAM,EACN,gBAAgB,CAChB,CAAA;wBAED,mCAAmC;wBACnC,UAAU,CAAC,OAAO,CAAC;4BAClB,IAAI,EAAE,YAAY;4BAClB,YAAY,EAAE,YAAY;4BAC1B,gBAAgB,EAAE,MAAM,CAAC,KAAK,EAAE;4BAChC,UAAU;4BACV,MAAM,EAAE,MAAM;yBACd,CAAC,CAAA;oBACH,CAAC;oBAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;wBACxB,UAAU,CAAC,OAAO,CAAC;4BAClB,IAAI,EAAE,WAAW;4BACjB,gBAAgB,EAAE,MAAM,CAAC,KAAK,EAAE;4BAChC,MAAM,EAAE,MAAM;yBACd,CAAC,CAAA;oBACH,CAAC;gBACF,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACd,UAAU,CAAC,OAAO,CAAC;wBAClB,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC;qBAClB,CAAC,CAAA;gBACH,CAAC;YACF,CAAC,CAAC,CAAA;QACH,CAAC;QACD,IAAI;YACH,8CAA8C;QAC/C,CAAC;QACD,MAAM;YACL,wCAAwC;YACxC,WAAW,EAAE,EAAE,CAAA;QAChB,CAAC;KACD,EACD;QACC,aAAa,EAAE,CAAC;QAChB,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;KACb,CACD,CAAA;IAED,OAAO,MAAM,CAAA;AACd,CAAC;AAED,0DAA0D;AAC1D,KAAK,UAAU,yBAAyB,CACvC,WAAuB,EACvB,GAAW,EACX,MAAwB,EACxB,WAAmB;IAMnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,IAAI,UAAU,GAAG,CAAC,CAAA;QAClB,IAAI,UAAU,GAAG,WAAW,CAAA;QAC5B,IAAI,4BAA4B,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;QAE3C,MAAM,kBAAkB,GAAG,KAAK,EAAE,UAAkB,EAAE,EAAE;YACvD,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAA;YAC9C,UAAU,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,UAAU,EAAE,CAAC,CAAC,CAAA;YACjD,KAAK,IAAI,YAAY,GAAG,UAAU,EAAE,YAAY,IAAI,SAAS,EAAE,YAAY,EAAE,EAAE,CAAC;gBAC/E,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAA;gBAEzE,sDAAsD;gBACtD,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,EAAE,CAAC,UAAU,CAAC,CAAA;gBAC9C,MAAM,MAAM,GAAG,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAA6B,CAAA;gBAE9E,KAAK,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;oBAC7B,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;oBAExB,IAAI,KAAK,CAAC,OAAO,KAAK,YAAY,IAAI,KAAK,CAAC,MAAM,KAAK,iBAAiB,EAAE,CAAC;wBAC1E,MAAM,UAAU,GAAG,8BAA8B,CAAC;4BACjD,MAAM;4BACN,IAAI,EAAE,GAAG;4BACT,MAAM;yBACN,CAAC,CAAA;wBAEF,IAAI,UAAU,EAAE,CAAC;4BAChB,4BAA4B,EAAE,EAAE,CAAA;4BAChC,OAAO,CAAC;gCACP,UAAU;gCACV,UAAU,EAAE,UAAU,CAAC,KAAK,EAAE;gCAC9B,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC;6BAClC,CAAC,CAAA;wBACH,CAAC;oBACF,CAAC;gBACF,CAAC;YACF,CAAC;YAED,UAAU,GAAG,SAAS,GAAG,CAAC,CAAA;YAE1B,IAAI,UAAU,IAAI,EAAE,EAAE,CAAC;gBACtB,4BAA4B,EAAE,EAAE,CAAA;gBAChC,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAA;YAC5C,CAAC;QACF,CAAC,CAAA;QAED,WAAW,CAAC,GAAG,CAAC,KAAK;aACnB,uBAAuB,CAAC,CAAC,MAAM,EAAE,EAAE;YACnC,0CAA0C;YAC1C,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAClC,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;YACrB,4BAA4B,GAAG,WAAW,CAAA;QAC3C,CAAC,CAAC;aACD,KAAK,CAAC,MAAM,CAAC,CAAA;IAChB,CAAC,CAAC,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAAC,EAC9C,MAAM,EACN,IAAI,EAAE,GAAG,EACT,MAAM,GAKN;IACA,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;IAExB,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC,IAAI,CAAA;IAExD,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC,CAAA;IACnE,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;IACtD,MAAM,eAAe,GACpB,WAAW,KAAK,UAAU;QAC1B,EAAE,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE;QAC9D,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAA;IAEzD,IAAI,CAAC,eAAe,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;IAC9D,CAAC;IAED,OAAO,UAAU,CAAC,QAAQ,EAAe,CAAA;AAC1C,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,57 @@
+import { HexString, IPostRequest, RequestStatus, TimeoutStatus } from "./types";
+export * from "./utils/mmr";
+export * from "./utils/substrate";
+export declare const DEFAULT_POLL_INTERVAL = 5000;
+/**
+ * Sleeps for the specified number of milliseconds.
+ * @param ms The number of milliseconds to sleep.
+ */
+export declare function sleep(ms?: number): Promise<unknown>;
+/**
+ * Checks if the given state machine ID represents an EVM chain.
+ * @param stateMachineId The state machine ID to check.
+ */
+export declare function isEvmChain(stateMachineId: string): boolean;
+/**
+ * Checks if the given state machine ID represents a Substrate chain.
+ * @param stateMachineId The state machine ID to check.
+ */
+export declare function isSubstrateChain(stateMachineId: string): boolean;
+/**
+ * Checks if the given string is a valid UTF-8 string.
+ * @param str The string to check.
+ */
+export declare function isValidUTF8(str: string): boolean;
+/**
+ * Calculates the commitment hash for a post request.
+ * @param post The post request to calculate the commitment hash for.
+ * @returns The commitment hash.
+ */
+export declare function postRequestCommitment(post: IPostRequest): HexString;
+/**
+ ** Calculates the weight of a request status.
+ * Used to determine the progression of a request through its lifecycle.
+ * Higher weights represent more advanced states in the processing pipeline.
+ * @returns A record mapping each RequestStatus to its corresponding weight value.
+ */
+export declare const REQUEST_STATUS_WEIGHTS: Record<RequestStatus, number>;
+/**
+ * Calculates the weight of a timeout status.
+ * Used to determine the progression of a timeout through its lifecycle.
+ * Higher weights represent more advanced states in the timeout processing.
+ * @returns A record mapping each TimeoutStatus to its corresponding weight value.
+ */
+export declare const TIMEOUT_STATUS_WEIGHTS: Record<TimeoutStatus, number>;
+/**
+ * Combines both request and timeout status weights into a single mapping.
+ * This provides a comprehensive view of all possible states a request can be in,
+ * with higher weights representing more advanced states in either the normal
+ * processing pipeline or the timeout handling process.
+ *
+ * The weights follow this progression:
+ * 0-4: Normal request processing (SOURCE to DESTINATION)
+ * 5-9: Timeout handling progression (PENDING_TIMEOUT to TIMED_OUT)
+ *
+ * @returns A record mapping each RequestStatus and TimeoutStatus to its corresponding weight value.
+ */
+export declare const COMBINED_STATUS_WEIGHTS: Record<RequestStatus | TimeoutStatus, number>;

package/dist/utils.js

@@ -0,0 +1,96 @@
+import { RequestStatus, TimeoutStatus } from "./types/index.js";
+import { encodePacked, keccak256, toHex } from "viem";
+export * from "./utils/mmr.js";
+export * from "./utils/substrate.js";
+export const DEFAULT_POLL_INTERVAL = 5000;
+/**
+ * Sleeps for the specified number of milliseconds.
+ * @param ms The number of milliseconds to sleep.
+ */
+export function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms || DEFAULT_POLL_INTERVAL));
+}
+/**
+ * Checks if the given state machine ID represents an EVM chain.
+ * @param stateMachineId The state machine ID to check.
+ */
+export function isEvmChain(stateMachineId) {
+    return stateMachineId.startsWith("EVM");
+}
+/**
+ * Checks if the given state machine ID represents a Substrate chain.
+ * @param stateMachineId The state machine ID to check.
+ */
+export function isSubstrateChain(stateMachineId) {
+    return (stateMachineId.startsWith("POLKADOT") ||
+        stateMachineId.startsWith("KUSAMA") ||
+        stateMachineId.startsWith("SUBSTRATE"));
+}
+/**
+ * Checks if the given string is a valid UTF-8 string.
+ * @param str The string to check.
+ */
+export function isValidUTF8(str) {
+    return Buffer.from(str).toString("utf8") === str;
+}
+/**
+ * Calculates the commitment hash for a post request.
+ * @param post The post request to calculate the commitment hash for.
+ * @returns The commitment hash.
+ */
+export function postRequestCommitment(post) {
+    return keccak256(encodePacked(["bytes", "bytes", "uint64", "uint64", "bytes", "bytes", "bytes"], [toHex(post.source), toHex(post.dest), post.nonce, post.timeoutTimestamp, post.from, post.to, post.body]));
+}
+/**
+ ** Calculates the weight of a request status.
+ * Used to determine the progression of a request through its lifecycle.
+ * Higher weights represent more advanced states in the processing pipeline.
+ * @returns A record mapping each RequestStatus to its corresponding weight value.
+ */
+export const REQUEST_STATUS_WEIGHTS = {
+    [RequestStatus.SOURCE]: 0,
+    [RequestStatus.SOURCE_FINALIZED]: 1,
+    [RequestStatus.HYPERBRIDGE_DELIVERED]: 2,
+    [RequestStatus.HYPERBRIDGE_FINALIZED]: 3,
+    [RequestStatus.DESTINATION]: 4,
+    [RequestStatus.HYPERBRIDGE_TIMED_OUT]: 5,
+    [RequestStatus.TIMED_OUT]: 6,
+};
+/**
+ * Calculates the weight of a timeout status.
+ * Used to determine the progression of a timeout through its lifecycle.
+ * Higher weights represent more advanced states in the timeout processing.
+ * @returns A record mapping each TimeoutStatus to its corresponding weight value.
+ */
+export const TIMEOUT_STATUS_WEIGHTS = {
+    [TimeoutStatus.PENDING_TIMEOUT]: 1,
+    [TimeoutStatus.DESTINATION_FINALIZED_TIMEOUT]: 2,
+    [TimeoutStatus.HYPERBRIDGE_TIMED_OUT]: 3,
+    [TimeoutStatus.HYPERBRIDGE_FINALIZED_TIMEOUT]: 4,
+    [TimeoutStatus.TIMED_OUT]: 5,
+};
+/**
+ * Combines both request and timeout status weights into a single mapping.
+ * This provides a comprehensive view of all possible states a request can be in,
+ * with higher weights representing more advanced states in either the normal
+ * processing pipeline or the timeout handling process.
+ *
+ * The weights follow this progression:
+ * 0-4: Normal request processing (SOURCE to DESTINATION)
+ * 5-9: Timeout handling progression (PENDING_TIMEOUT to TIMED_OUT)
+ *
+ * @returns A record mapping each RequestStatus and TimeoutStatus to its corresponding weight value.
+ */
+export const COMBINED_STATUS_WEIGHTS = {
+    [RequestStatus.SOURCE]: 0,
+    [RequestStatus.SOURCE_FINALIZED]: 1,
+    [RequestStatus.HYPERBRIDGE_DELIVERED]: 2,
+    [RequestStatus.HYPERBRIDGE_FINALIZED]: 3,
+    [RequestStatus.DESTINATION]: 4,
+    [TimeoutStatus.PENDING_TIMEOUT]: 5,
+    [TimeoutStatus.DESTINATION_FINALIZED_TIMEOUT]: 6,
+    [TimeoutStatus.HYPERBRIDGE_TIMED_OUT]: 7,
+    [TimeoutStatus.HYPERBRIDGE_FINALIZED_TIMEOUT]: 8,
+    [TimeoutStatus.TIMED_OUT]: 9,
+};
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAC/E,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,MAAM,CAAA;AAErD,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AAEjC,MAAM,CAAC,MAAM,qBAAqB,GAAG,IAAK,CAAA;AAE1C;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,EAAW;IAChC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,IAAI,qBAAqB,CAAC,CAAC,CAAA;AAClF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,cAAsB;IAChD,OAAO,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;AACxC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,cAAsB;IACtD,OAAO,CACN,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC;QACrC,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC;QACnC,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CACtC,CAAA;AACF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACtC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,GAAG,CAAA;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAkB;IACvD,OAAO,SAAS,CACf,YAAY,CACX,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EACjE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CACxG,CACD,CAAA;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAkC;IACpE,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;IACzB,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE,CAAC;IACnC,CAAC,aAAa,CAAC,qBAAqB,CAAC,EAAE,CAAC;IACxC,CAAC,aAAa,CAAC,qBAAqB,CAAC,EAAE,CAAC;IACxC,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;IAC9B,CAAC,aAAa,CAAC,qBAAqB,CAAC,EAAE,CAAC;IACxC,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;CAC5B,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAkC;IACpE,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,CAAC;IAClC,CAAC,aAAa,CAAC,6BAA6B,CAAC,EAAE,CAAC;IAChD,CAAC,aAAa,CAAC,qBAAqB,CAAC,EAAE,CAAC;IACxC,CAAC,aAAa,CAAC,6BAA6B,CAAC,EAAE,CAAC;IAChD,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;CAC5B,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAkD;IACrF,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;IACzB,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE,CAAC;IACnC,CAAC,aAAa,CAAC,qBAAqB,CAAC,EAAE,CAAC;IACxC,CAAC,aAAa,CAAC,qBAAqB,CAAC,EAAE,CAAC;IACxC,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;IAC9B,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,CAAC;IAClC,CAAC,aAAa,CAAC,6BAA6B,CAAC,EAAE,CAAC;IAChD,CAAC,aAAa,CAAC,qBAAqB,CAAC,EAAE,CAAC;IACxC,CAAC,aAAa,CAAC,6BAA6B,CAAC,EAAE,CAAC;IAChD,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;CAC5B,CAAA"}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@hyperbridge/sdk",
+  "version": "1.0.0",
+  "description": "The hyperclient SDK provides utilities for querying proofs and statuses for cross-chain requests from HyperBridge.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "./dist/index.mjs",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "hyperbridge",
+    "indexer",
+    "subquery",
+    "graphql",
+    "substrate",
+    "blockchain",
+    "interoperability",
+    "cryptocurrency",
+    "evm"
+  ],
+  "type": "module",
+  "homepage": "https://github.com/polytope-labs/hyperbridge-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/polytope-labs/hyperbridge-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/polytope-labs/hyperbridge-sdk.git"
+  },
+  "license": "ISC",
+  "author": "Polytope Labs",
+  "dependencies": {
+    "@async-generator/merge-race": "^1.0.3",
+    "@polkadot/api": "^15.7.1",
+    "@polkadot/types": "14.0.1",
+    "@polkadot/util": "13.3.1",
+    "@polkadot/util-crypto": "13.3.1",
+    "graphql": "^16.10.0",
+    "graphql-request": "^7.1.2",
+    "lodash": "^4.17.21",
+    "rpc-websocket-client": "^1.1.4",
+    "scale-ts": "^1.6.1",
+    "ts-pattern": "^5.6.2",
+    "viem": "^2.23.5"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@polkadot/keyring": "13.4.3",
+    "@polytope-labs/hyperclient": "1.2.0",
+    "@types/lodash": "^4.17.15",
+    "@types/node": "^22.13.5",
+    "@vitest/coverage-v8": "^3.0.7",
+    "dotenv": "^16.4.7",
+    "jsdom": "^26.0.0",
+    "log-timestamp": "^0.3.0",
+    "resolve-tspaths": "^0.8.23",
+    "typescript": "^5.7.3",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.0.7",
+    "vite": "^6.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc && resolve-tspaths",
+    "test": "vitest --watch=false --maxConcurrency=1",
+    "test:watch": "vitest",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint --write .",
+    "format": "prettier --write \"src/**/*.ts\""
+  }
+}