@relay-protocol/settlement-sdk 0.0.86 → 0.0.87

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import { SolverRefundMessage, SolverRefundStatus, getSolverRefundMessageId } fro
 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 { DenormalizedSubmitWithdrawRequest, SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, getOrderAddress, OrderAddressParams, WithdrawalAddressParams } from "./messages/v2.2/withdrawal-execution";
+import { DenormalizedSubmitWithdrawRequest, SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, getOrderAddress, normalizePayloadParams, OrderAddressParams, WithdrawalAddressParams } from "./messages/v2.2/withdrawal-execution";
 import { TokenIdComponents, VirtualAddressComponents, TokenId, VirtualAddress, generateAddress, generateTokenId } from "./hub/hub-utils";
 import type { NetworkConfig, NetworkConfigs, ProtocolContracts } from "./networks";
-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, generateAddress, generateTokenId, DenormalizedSubmitWithdrawRequest, SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, getOrderAddress, OrderAddressParams, WithdrawalAddressParams, NetworkConfigs, ProtocolContracts, NetworkConfig, };
+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, generateAddress, generateTokenId, DenormalizedSubmitWithdrawRequest, SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, getOrderAddress, normalizePayloadParams, OrderAddressParams, WithdrawalAddressParams, NetworkConfigs, ProtocolContracts, NetworkConfig, };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrderAddress = exports.getWithdrawalAddress = exports.getSubmitWithdrawRequestHash = exports.generateTokenId = exports.generateAddress = 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;
+exports.normalizePayloadParams = exports.getOrderAddress = exports.getWithdrawalAddress = exports.getSubmitWithdrawRequestHash = exports.generateTokenId = exports.generateAddress = 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; } });
@@ -40,6 +40,7 @@ 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; } });
 Object.defineProperty(exports, "getOrderAddress", { enumerable: true, get: function () { return withdrawal_execution_1.getOrderAddress; } });
+Object.defineProperty(exports, "normalizePayloadParams", { enumerable: true, get: function () { return withdrawal_execution_1.normalizePayloadParams; } });
 const hub_utils_1 = require("./hub/hub-utils");
 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/v2.2/withdrawal-execution.d.ts

@@ -57,3 +57,7 @@ export type OrderAddressParams = {
     depositId: string;
 };
 export declare function getOrderAddress(orderParams: OrderAddressParams): Address;
+export declare function getWithdrawalInitiationHash(withdrawerAlias: string, amount: bigint, withdrawalNonce: string): `0x${string}`;
+export declare function normalizePayloadParams(request: DenormalizedSubmitWithdrawRequest & {
+    vmType: VmType;
+}): SubmitWithdrawRequest;

package/dist/messages/v2.2/withdrawal-execution.js

@@ -1,8 +1,49 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSubmitWithdrawRequestHash = void 0;
 exports.getWithdrawalAddress = getWithdrawalAddress;
 exports.getOrderAddress = getOrderAddress;
+exports.getWithdrawalInitiationHash = getWithdrawalInitiationHash;
+exports.normalizePayloadParams = normalizePayloadParams;
+const web3_js_1 = require("@solana/web3.js");
+const bitcoin = __importStar(require("bitcoinjs-lib"));
+const tronweb_1 = __importDefault(require("tronweb"));
 const viem_1 = require("viem");
 const hub_utils_1 = require("../../hub/hub-utils");
 const utils_1 = require("../../utils");
@@ -60,3 +101,136 @@ function getOrderAddress(orderParams) {
     const orderAddress = hash.slice(2).slice(-40);
     return `0x${orderAddress}`;
 }
+function getWithdrawalInitiationHash(withdrawerAlias, amount, withdrawalNonce) {
+    return (0, viem_1.keccak256)((0, viem_1.encodePacked)(["address", "uint256", "bytes32"], [
+        withdrawerAlias,
+        BigInt(amount),
+        withdrawalNonce,
+    ]));
+}
+function normalizePayloadParams(request) {
+    const defaultParams = {
+        chainId: request.chainId,
+        depository: request.depository,
+        currency: request.currency,
+        spender: request.spender,
+        recipient: request.recipient,
+        amount: request.amount,
+        nonce: request.nonce,
+        data: "0x",
+    };
+    switch (request.vmType) {
+        case "ethereum-vm": {
+            return {
+                ...defaultParams,
+                depository: defaultParams.depository.toLowerCase(),
+                currency: defaultParams.currency.toLowerCase(),
+                spender: defaultParams.spender.toLowerCase(),
+                recipient: defaultParams.recipient.toLowerCase(),
+            };
+        }
+        case "bitcoin-vm": {
+            const bitcoinAdditionalData = request.additionalData?.["bitcoin-vm"];
+            if (!bitcoinAdditionalData) {
+                throw new Error("Additional data is required for bitcoin-vm");
+            }
+            const allocatorScriptPubKey = `0x${bitcoin.address
+                .toOutputScript(request.depository, bitcoin.networks.bitcoin)
+                .toString("hex")}`;
+            const toLittleEndianTxid = (txid) => {
+                const normalizedTxid = txid.startsWith("0x") ? txid.slice(2) : txid;
+                if (!/^[0-9a-fA-F]{64}$/.test(normalizedTxid)) {
+                    throw new Error("Invalid bitcoin UTXO txid");
+                }
+                return `0x${Buffer.from(normalizedTxid, "hex")
+                    .reverse()
+                    .toString("hex")}`;
+            };
+            const data = (0, viem_1.encodeAbiParameters)([
+                {
+                    type: "tuple",
+                    components: [
+                        {
+                            type: "tuple[]",
+                            name: "utxos",
+                            components: [
+                                { type: "bytes32", name: "txid" },
+                                { type: "uint32", name: "index" },
+                                { type: "uint64", name: "value" },
+                                { type: "bytes", name: "scriptPubKey" },
+                            ],
+                        },
+                        { type: "uint64", name: "feeRate" },
+                    ],
+                },
+            ], [
+                {
+                    utxos: bitcoinAdditionalData.allocatorUtxos.map((utxo) => ({
+                        txid: toLittleEndianTxid(utxo.txid),
+                        index: utxo.vout,
+                        value: BigInt(utxo.value),
+                        scriptPubKey: allocatorScriptPubKey,
+                    })),
+                    feeRate: BigInt(bitcoinAdditionalData.feeRate),
+                },
+            ]);
+            return {
+                ...defaultParams,
+                recipient: bitcoin.address
+                    .toOutputScript(request.recipient, bitcoin.networks.bitcoin)
+                    .toString("base64"),
+                data,
+            };
+        }
+        case "tron-vm": {
+            // The "tron-vm" payload builder (which is the "ethereum-vm" one) expects addresses to be hex-encoded
+            const toHex = (address) => tronweb_1.default.utils.address
+                .toHex(address)
+                .replace(tronweb_1.default.utils.address.ADDRESS_PREFIX_REGEX, "0x");
+            return {
+                ...defaultParams,
+                depository: toHex(request.depository),
+                currency: toHex(request.currency),
+                recipient: toHex(request.recipient),
+            };
+        }
+        case "solana-vm": {
+            // The "solana-vm" payload builder expects addresses to be hex-encoded
+            const toHexString = (address) => new web3_js_1.PublicKey(address).toBuffer().toString("hex");
+            return {
+                ...defaultParams,
+                currency: request.currency === (0, utils_1.getVmTypeNativeCurrency)(request.vmType)
+                    ? ""
+                    : toHexString(request.currency),
+                recipient: toHexString(request.recipient),
+            };
+        }
+        case "hyperliquid-vm": {
+            const hyperliquidAdditionalData = request.additionalData?.["hyperliquid-vm"];
+            if (!hyperliquidAdditionalData) {
+                throw new Error("Additional data is required for hyperliquid-vm");
+            }
+            const isNativeCurrency = request.currency === (0, utils_1.getVmTypeNativeCurrency)(request.vmType);
+            // TODO: We probably shouldn't be letting the user choose the time in order
+            // to preserve the assumption that the time is always incrementing. However
+            // at the moment we need these for deterministic payload ids.
+            const currentTime = BigInt(request.additionalData["hyperliquid-vm"].currentTime ?? Date.now());
+            const currencyDex = request.currency.slice(34) === ""
+                ? "spot"
+                : Buffer.from(request.currency.slice(34), "hex").toString("ascii");
+            const data = isNativeCurrency
+                ? (0, viem_1.encodeAbiParameters)([{ type: "uint64" }], [currentTime])
+                : (0, viem_1.encodeAbiParameters)([{ type: "uint64" }, { type: "string" }, { type: "string" }], [currentTime, currencyDex, currencyDex]);
+            return {
+                ...defaultParams,
+                currency: isNativeCurrency
+                    ? ""
+                    : `${hyperliquidAdditionalData.currencyHyperliquidSymbol}:${request.currency.toLowerCase()}`,
+                data,
+            };
+        }
+        default: {
+            throw new Error("Vm type not implemented for payload params");
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relay-protocol/settlement-sdk",
-  "version": "0.0.86",
+  "version": "0.0.87",
   "description": "Relay protocol SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,6 +22,7 @@
   "dependencies": {
     "@coral-xyz/anchor": "^0.31.1",
     "@mysten/sui": "^1.24.0",
+    "@solana/web3.js": "1.98.4",
     "bech32": "^2.0.0",
     "bitcoinjs-lib": "^6.1.7",
     "bs58": "^6.0.0",