@relay-protocol/settlement-sdk 0.0.64

package/README.md

@@ -0,0 +1,3 @@
+## Relay protocol SDK
+
+> #### SDK for the Relay protocol

package/dist/hub/hub-utils.d.ts

@@ -0,0 +1,29 @@
+import { VmType } from "../utils";
+export interface TokenIdComponents {
+    family: VmType;
+    chainId: bigint;
+    address: string;
+}
+export interface VirtualAddressComponents {
+    family: VmType;
+    chainId: bigint;
+    address: string;
+}
+export type TokenId = bigint;
+export type VirtualAddress = `0x${string}`;
+export declare const getCheckSummedAddress: (family: string, address: string) => string;
+/**
+ * Generates a virtual Ethereum address from token components
+ * @param components The token components (family, chainId, address)
+ * @returns A checksummed Ethereum address derived from the token ID
+ * @remarks This function first generates a token ID using the components,
+ * then converts the last 20 bytes of the hash to an Ethereum address.
+ * This is equivalent to the Solidity: address(uint160(uint256(addressHash)))
+ */
+export declare function generateAddress(components: VirtualAddressComponents): VirtualAddress;
+/**
+ * Generates a token ID based on the chain type, chain ID, and address
+ * @param components The token components (family, chainId, address)
+ * @returns The keccak256 hash of the token components
+ */
+export declare function generateTokenId(components: TokenIdComponents): TokenId;

package/dist/hub/hub-utils.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCheckSummedAddress = void 0;
+exports.generateAddress = generateAddress;
+exports.generateTokenId = generateTokenId;
+const viem_1 = require("viem");
+const getCheckSummedAddress = (family, address) => {
+    const checksummedAddress = family === "ethereum-vm" ? (0, viem_1.getAddress)(address) : address;
+    return checksummedAddress;
+};
+exports.getCheckSummedAddress = getCheckSummedAddress;
+/**
+ * Generates a virtual Ethereum address from token components
+ * @param components The token components (family, chainId, address)
+ * @returns A checksummed Ethereum address derived from the token ID
+ * @remarks This function first generates a token ID using the components,
+ * then converts the last 20 bytes of the hash to an Ethereum address.
+ * This is equivalent to the Solidity: address(uint160(uint256(addressHash)))
+ */
+function generateAddress(components) {
+    const { chainId, address, family } = components;
+    const addressHash = (0, viem_1.keccak256)((0, viem_1.encodePacked)(["string", "uint256", family === "ethereum-vm" ? "address" : "string"], [family, chainId, (0, exports.getCheckSummedAddress)(family, address)]));
+    const addressBytes = addressHash.slice(2).slice(-40);
+    return (0, viem_1.getAddress)("0x" + addressBytes);
+}
+/**
+ * Generates a token ID based on the chain type, chain ID, and address
+ * @param components The token components (family, chainId, address)
+ * @returns The keccak256 hash of the token components
+ */
+function generateTokenId(components) {
+    const { family, chainId, address } = components;
+    const packedData = (0, viem_1.encodePacked)(["string", "uint256", family === "ethereum-vm" ? "address" : "string"], [family, chainId, (0, exports.getCheckSummedAddress)(family, address)]);
+    return BigInt((0, viem_1.keccak256)(packedData));
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { Order, encodeOrderCall, decodeOrderCall, encodeOrderExtraData, decodeOrderExtraData, getOrderId } from "./order";
+import { DepositoryDepositMessage, getDepositoryDepositMessageId } from "./messages/v2.1/depository-deposit";
+import { DecodedBitcoinVmWithdrawal, DecodedEthereumVmWithdrawal, DecodedSolanaVmWithdrawal, DecodedSuiVmWithdrawal, DecodedHyperliquidVmWithdrawal, DepositoryWithdrawalMessage, DepositoryWithdrawalStatus, getDepositoryWithdrawalMessageId, encodeWithdrawal, decodeWithdrawal, getDecodedWithdrawalId, getDecodedWithdrawalCurrency, getDecodedWithdrawalAmount, getDecodedWithdrawalRecipient } from "./messages/v2.1/depository-withdrawal";
+import { SolverRefundMessage, SolverRefundStatus, getSolverRefundMessageId } from "./messages/v2.1/solver-refund";
+import { SolverFillMessage, SolverFillStatus, getSolverFillMessageId } from "./messages/v2.1/solver-fill";
+import { ActionType, ExecutionMessage, ExecutionMessageMetadata, getExecutionMessageId, encodeAction, decodeAction } from "./messages/v2.2/execution";
+import { VmType, decodeAddress, decodeTransactionId, encodeAddress, encodeBytes, encodeTransactionId, getVmTypeNativeCurrency } from "./utils";
+import { SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, WithdrawalAddressParams, WithdrawalInitiationMessage, WithdrawalInitiatedMessage, WithdrawalAddressRequest } from "./messages/v2.2/withdrawal-execution";
+import { TokenIdComponents, VirtualAddressComponents, TokenId, VirtualAddress, getCheckSummedAddress, generateAddress, generateTokenId } from "./hub/hub-utils";
+export { Order, encodeOrderCall, decodeOrderCall, encodeOrderExtraData, decodeOrderExtraData, getOrderId, VmType, decodeAddress, decodeTransactionId, encodeAddress, encodeBytes, encodeTransactionId, getVmTypeNativeCurrency, DepositoryDepositMessage, getDepositoryDepositMessageId, DecodedBitcoinVmWithdrawal, DecodedEthereumVmWithdrawal, DecodedSolanaVmWithdrawal, DecodedSuiVmWithdrawal, DecodedHyperliquidVmWithdrawal, DepositoryWithdrawalMessage, DepositoryWithdrawalStatus, getDepositoryWithdrawalMessageId, encodeWithdrawal, decodeWithdrawal, getDecodedWithdrawalId, getDecodedWithdrawalCurrency, getDecodedWithdrawalAmount, getDecodedWithdrawalRecipient, SolverRefundMessage, SolverRefundStatus, getSolverRefundMessageId, SolverFillMessage, SolverFillStatus, getSolverFillMessageId, ExecutionMessage, ExecutionMessageMetadata, ActionType, getExecutionMessageId, encodeAction, decodeAction, TokenIdComponents, VirtualAddressComponents, TokenId, VirtualAddress, getCheckSummedAddress, generateAddress, generateTokenId, SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, WithdrawalAddressParams, WithdrawalInitiationMessage, WithdrawalInitiatedMessage, WithdrawalAddressRequest, };

package/dist/index.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWithdrawalAddress = exports.getSubmitWithdrawRequestHash = exports.generateTokenId = exports.generateAddress = exports.getCheckSummedAddress = exports.decodeAction = exports.encodeAction = exports.getExecutionMessageId = exports.ActionType = exports.getSolverFillMessageId = exports.SolverFillStatus = exports.getSolverRefundMessageId = exports.SolverRefundStatus = exports.getDecodedWithdrawalRecipient = exports.getDecodedWithdrawalAmount = exports.getDecodedWithdrawalCurrency = exports.getDecodedWithdrawalId = exports.decodeWithdrawal = exports.encodeWithdrawal = exports.getDepositoryWithdrawalMessageId = exports.DepositoryWithdrawalStatus = exports.getDepositoryDepositMessageId = exports.getVmTypeNativeCurrency = exports.encodeTransactionId = exports.encodeBytes = exports.encodeAddress = exports.decodeTransactionId = exports.decodeAddress = exports.getOrderId = exports.decodeOrderExtraData = exports.encodeOrderExtraData = exports.decodeOrderCall = exports.encodeOrderCall = void 0;
+const order_1 = require("./order");
+Object.defineProperty(exports, "encodeOrderCall", { enumerable: true, get: function () { return order_1.encodeOrderCall; } });
+Object.defineProperty(exports, "decodeOrderCall", { enumerable: true, get: function () { return order_1.decodeOrderCall; } });
+Object.defineProperty(exports, "encodeOrderExtraData", { enumerable: true, get: function () { return order_1.encodeOrderExtraData; } });
+Object.defineProperty(exports, "decodeOrderExtraData", { enumerable: true, get: function () { return order_1.decodeOrderExtraData; } });
+Object.defineProperty(exports, "getOrderId", { enumerable: true, get: function () { return order_1.getOrderId; } });
+const depository_deposit_1 = require("./messages/v2.1/depository-deposit");
+Object.defineProperty(exports, "getDepositoryDepositMessageId", { enumerable: true, get: function () { return depository_deposit_1.getDepositoryDepositMessageId; } });
+const depository_withdrawal_1 = require("./messages/v2.1/depository-withdrawal");
+Object.defineProperty(exports, "DepositoryWithdrawalStatus", { enumerable: true, get: function () { return depository_withdrawal_1.DepositoryWithdrawalStatus; } });
+Object.defineProperty(exports, "getDepositoryWithdrawalMessageId", { enumerable: true, get: function () { return depository_withdrawal_1.getDepositoryWithdrawalMessageId; } });
+Object.defineProperty(exports, "encodeWithdrawal", { enumerable: true, get: function () { return depository_withdrawal_1.encodeWithdrawal; } });
+Object.defineProperty(exports, "decodeWithdrawal", { enumerable: true, get: function () { return depository_withdrawal_1.decodeWithdrawal; } });
+Object.defineProperty(exports, "getDecodedWithdrawalId", { enumerable: true, get: function () { return depository_withdrawal_1.getDecodedWithdrawalId; } });
+Object.defineProperty(exports, "getDecodedWithdrawalCurrency", { enumerable: true, get: function () { return depository_withdrawal_1.getDecodedWithdrawalCurrency; } });
+Object.defineProperty(exports, "getDecodedWithdrawalAmount", { enumerable: true, get: function () { return depository_withdrawal_1.getDecodedWithdrawalAmount; } });
+Object.defineProperty(exports, "getDecodedWithdrawalRecipient", { enumerable: true, get: function () { return depository_withdrawal_1.getDecodedWithdrawalRecipient; } });
+const solver_refund_1 = require("./messages/v2.1/solver-refund");
+Object.defineProperty(exports, "SolverRefundStatus", { enumerable: true, get: function () { return solver_refund_1.SolverRefundStatus; } });
+Object.defineProperty(exports, "getSolverRefundMessageId", { enumerable: true, get: function () { return solver_refund_1.getSolverRefundMessageId; } });
+const solver_fill_1 = require("./messages/v2.1/solver-fill");
+Object.defineProperty(exports, "SolverFillStatus", { enumerable: true, get: function () { return solver_fill_1.SolverFillStatus; } });
+Object.defineProperty(exports, "getSolverFillMessageId", { enumerable: true, get: function () { return solver_fill_1.getSolverFillMessageId; } });
+const execution_1 = require("./messages/v2.2/execution");
+Object.defineProperty(exports, "ActionType", { enumerable: true, get: function () { return execution_1.ActionType; } });
+Object.defineProperty(exports, "getExecutionMessageId", { enumerable: true, get: function () { return execution_1.getExecutionMessageId; } });
+Object.defineProperty(exports, "encodeAction", { enumerable: true, get: function () { return execution_1.encodeAction; } });
+Object.defineProperty(exports, "decodeAction", { enumerable: true, get: function () { return execution_1.decodeAction; } });
+const utils_1 = require("./utils");
+Object.defineProperty(exports, "decodeAddress", { enumerable: true, get: function () { return utils_1.decodeAddress; } });
+Object.defineProperty(exports, "decodeTransactionId", { enumerable: true, get: function () { return utils_1.decodeTransactionId; } });
+Object.defineProperty(exports, "encodeAddress", { enumerable: true, get: function () { return utils_1.encodeAddress; } });
+Object.defineProperty(exports, "encodeBytes", { enumerable: true, get: function () { return utils_1.encodeBytes; } });
+Object.defineProperty(exports, "encodeTransactionId", { enumerable: true, get: function () { return utils_1.encodeTransactionId; } });
+Object.defineProperty(exports, "getVmTypeNativeCurrency", { enumerable: true, get: function () { return utils_1.getVmTypeNativeCurrency; } });
+const withdrawal_execution_1 = require("./messages/v2.2/withdrawal-execution");
+Object.defineProperty(exports, "getSubmitWithdrawRequestHash", { enumerable: true, get: function () { return withdrawal_execution_1.getSubmitWithdrawRequestHash; } });
+Object.defineProperty(exports, "getWithdrawalAddress", { enumerable: true, get: function () { return withdrawal_execution_1.getWithdrawalAddress; } });
+const hub_utils_1 = require("./hub/hub-utils");
+Object.defineProperty(exports, "getCheckSummedAddress", { enumerable: true, get: function () { return hub_utils_1.getCheckSummedAddress; } });
+Object.defineProperty(exports, "generateAddress", { enumerable: true, get: function () { return hub_utils_1.generateAddress; } });
+Object.defineProperty(exports, "generateTokenId", { enumerable: true, get: function () { return hub_utils_1.generateTokenId; } });

package/dist/messages/common/solana-vm/idls/RelayDepositoryIdl.d.ts

@@ -0,0 +1,383 @@
+export declare const RelayDepositoryIdl: {
+    address: string;
+    metadata: {
+        name: string;
+        version: string;
+        spec: string;
+        description: string;
+    };
+    instructions: ({
+        name: string;
+        docs: string[];
+        discriminator: number[];
+        accounts: ({
+            name: string;
+            docs: string[];
+            pda: {
+                seeds: {
+                    kind: string;
+                    value: number[];
+                }[];
+            };
+            writable?: undefined;
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable: boolean;
+            signer: boolean;
+            pda?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            pda?: undefined;
+            writable?: undefined;
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable: boolean;
+            pda: {
+                seeds: {
+                    kind: string;
+                    value: number[];
+                }[];
+            };
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            address: string;
+            pda?: undefined;
+            writable?: undefined;
+            signer?: undefined;
+        })[];
+        args: ({
+            name: string;
+            type: string;
+        } | {
+            name: string;
+            type: {
+                array: (string | number)[];
+            };
+        })[];
+    } | {
+        name: string;
+        docs: string[];
+        discriminator: number[];
+        accounts: ({
+            name: string;
+            docs: string[];
+            pda: {
+                seeds: {
+                    kind: string;
+                    value: number[];
+                }[];
+                program?: undefined;
+            };
+            writable?: undefined;
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable: boolean;
+            signer: boolean;
+            pda?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            pda?: undefined;
+            writable?: undefined;
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable: boolean;
+            pda: {
+                seeds: {
+                    kind: string;
+                    path: string;
+                }[];
+                program: {
+                    kind: string;
+                    value: number[];
+                };
+            };
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            writable: boolean;
+            docs?: undefined;
+            pda?: undefined;
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            address: string;
+            pda?: undefined;
+            writable?: undefined;
+            signer?: undefined;
+        })[];
+        args: ({
+            name: string;
+            type: string;
+        } | {
+            name: string;
+            type: {
+                array: (string | number)[];
+            };
+        })[];
+    } | {
+        name: string;
+        docs: string[];
+        discriminator: number[];
+        accounts: ({
+            name: string;
+            docs: string[];
+            pda: {
+                seeds: {
+                    kind: string;
+                    value: number[];
+                }[];
+                program?: undefined;
+            };
+            writable?: undefined;
+            signer?: undefined;
+            optional?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable: boolean;
+            signer: boolean;
+            pda?: undefined;
+            optional?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable: boolean;
+            pda?: undefined;
+            signer?: undefined;
+            optional?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable: boolean;
+            pda: {
+                seeds: {
+                    kind: string;
+                    value: number[];
+                }[];
+                program?: undefined;
+            };
+            signer?: undefined;
+            optional?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            optional: boolean;
+            pda?: undefined;
+            writable?: undefined;
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable: boolean;
+            optional: boolean;
+            pda: {
+                seeds: {
+                    kind: string;
+                    path: string;
+                }[];
+                program: {
+                    kind: string;
+                    value: number[];
+                };
+            };
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            pda?: undefined;
+            writable?: undefined;
+            signer?: undefined;
+            optional?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            address: string;
+            pda?: undefined;
+            writable?: undefined;
+            signer?: undefined;
+            optional?: undefined;
+        })[];
+        args: {
+            name: string;
+            type: {
+                defined: {
+                    name: string;
+                };
+            };
+        }[];
+    } | {
+        name: string;
+        docs: string[];
+        discriminator: number[];
+        accounts: ({
+            name: string;
+            docs: string[];
+            writable: boolean;
+            pda: {
+                seeds: {
+                    kind: string;
+                    value: number[];
+                }[];
+            };
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable: boolean;
+            signer: boolean;
+            pda?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            writable?: undefined;
+            pda?: undefined;
+            signer?: undefined;
+            address?: undefined;
+        } | {
+            name: string;
+            address: string;
+            docs?: undefined;
+            writable?: undefined;
+            pda?: undefined;
+            signer?: undefined;
+        })[];
+        args: {
+            name: string;
+            type: string;
+        }[];
+    } | {
+        name: string;
+        docs: string[];
+        discriminator: number[];
+        accounts: ({
+            name: string;
+            docs: string[];
+            writable: boolean;
+            pda: {
+                seeds: {
+                    kind: string;
+                    value: number[];
+                }[];
+            };
+            signer?: undefined;
+        } | {
+            name: string;
+            docs: string[];
+            signer: boolean;
+            writable?: undefined;
+            pda?: undefined;
+        })[];
+        args: {
+            name: string;
+            type: string;
+        }[];
+    })[];
+    accounts: {
+        name: string;
+        discriminator: number[];
+    }[];
+    events: {
+        name: string;
+        discriminator: number[];
+    }[];
+    errors: {
+        code: number;
+        name: string;
+        msg: string;
+    }[];
+    types: ({
+        name: string;
+        docs: string[];
+        type: {
+            kind: string;
+            fields: ({
+                name: string;
+                docs: string[];
+                type: string;
+            } | {
+                name: string;
+                docs: string[];
+                type: {
+                    option: string;
+                    array?: undefined;
+                };
+            } | {
+                name: string;
+                docs: string[];
+                type: {
+                    array: (string | number)[];
+                    option?: undefined;
+                };
+            })[];
+        };
+    } | {
+        name: string;
+        docs: string[];
+        type: {
+            kind: string;
+            fields: ({
+                name: string;
+                docs: string[];
+                type: string;
+            } | {
+                name: string;
+                docs: string[];
+                type: {
+                    option: {
+                        array: (string | number)[];
+                    };
+                };
+            })[];
+        };
+    } | {
+        name: string;
+        docs: string[];
+        type: {
+            kind: string;
+            fields: ({
+                name: string;
+                docs: string[];
+                type: {
+                    defined: {
+                        name: string;
+                    };
+                };
+            } | {
+                name: string;
+                docs: string[];
+                type: string;
+            })[];
+        };
+    })[];
+};