@relay-protocol/settlement-sdk 0.0.84 → 0.0.86

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 { SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, getOrderAddress, WithdrawalAddressParams, WithdrawalInitiationMessage, WithdrawalInitiatedMessage, WithdrawalAddressRequest, computeWithdrawerBalanceMessage, OnChainWithdrawalQuery, OnchainWithdrawalSignatureRequest, OnchainWithdrawalRequest } from "./messages/v2.2/withdrawal-execution";
+import { DenormalizedSubmitWithdrawRequest, SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, getOrderAddress, 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, SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, getOrderAddress, WithdrawalAddressParams, WithdrawalInitiationMessage, WithdrawalInitiatedMessage, WithdrawalAddressRequest, computeWithdrawerBalanceMessage, OnChainWithdrawalQuery, OnchainWithdrawalSignatureRequest, OnchainWithdrawalRequest, 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, OrderAddressParams, WithdrawalAddressParams, NetworkConfigs, ProtocolContracts, NetworkConfig, };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.computeWithdrawerBalanceMessage = 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.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,7 +40,6 @@ 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, "computeWithdrawerBalanceMessage", { enumerable: true, get: function () { return withdrawal_execution_1.computeWithdrawerBalanceMessage; } });
 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.1/depository-withdrawal.js

@@ -606,7 +606,7 @@ const getDecodedWithdrawalAmount = (decodedWithdrawal) => {
         }
         case "bitcoin-vm": {
             const psbt = bitcoin.Psbt.fromHex(decodedWithdrawal.withdrawal.psbt);
-            const fee = psbt.getFee();
+            const fee = psbt.finalizeAllInputs().getFee();
             return (psbt.txOutputs[0].value + fee).toString();
         }
         case "hyperliquid-vm": {

package/dist/messages/v2.2/withdrawal-execution.d.ts

@@ -1,3 +1,4 @@
+import { Address } from "viem";
 import { VmType } from "../../utils";
 export interface SubmitWithdrawRequest {
     chainId: string;
@@ -5,111 +6,54 @@ export interface SubmitWithdrawRequest {
     currency: string;
     amount: string;
     spender: string;
-    receiver: string;
-    data: string;
+    recipient: string;
     nonce: string;
+    data: string;
 }
+export type DenormalizedSubmitWithdrawRequest = Omit<SubmitWithdrawRequest, "data"> & {
+    additionalData?: {
+        "bitcoin-vm"?: {
+            allocatorUtxos: {
+                txid: string;
+                vout: number;
+                value: string;
+            }[];
+            feeRate: number;
+        };
+        "hyperliquid-vm"?: {
+            currencyHyperliquidSymbol: string;
+            currentTime: number;
+        };
+    };
+};
 export declare const getSubmitWithdrawRequestHash: (request: SubmitWithdrawRequest) => `0x${string}`;
 export type WithdrawalAddressParams = {
+    vmType: VmType;
+    chainId: string;
     depository: string;
-    depositoryChainId: string;
     currency: string;
     recipient: string;
-    withdrawerAlias: string;
-    withdrawalNonce: string;
+    ownerAlias: string;
+    nonce: string;
 };
 /**
  * Compute deterministic withdrawal address
  *
+ * @param vmType the vm type of the depository chain
+ * @param chainId the chain id of the depository contract currently holding the funds
  * @param depository the depository contract holding the funds on origin chain (as string)
- * @param depositoryChainId the chain id of the depository contract currently holding the funds
  * @param currency the id of the currency as expressed on origin chain (string)
  * @param recipient the address that will receive the withdrawn funds on destination chain
- * @param withdrawerAlias the address that owns the balance on the settlement chain
- * before the withdrawal is initiated
- * @param withdrawalNonce nonce to prevent collisions for similar withdrawals
+ * @param ownerAlias the address that owns the balance on the settlement chain before the withdrawal is initiated
+ * @param nonce nonce to prevent collisions for similar withdrawals
  * @returns withdrawal address (in lower case)
  */
-export declare function getWithdrawalAddress(withdrawalParams: WithdrawalAddressParams & {
-    depositoryVmType: VmType;
-}): string;
-export declare function getOrderAddress(data: {
-    depositChainVmType: VmType;
-    depositChainId: string;
+export declare function getWithdrawalAddress(withdrawalParams: WithdrawalAddressParams): Address;
+export type OrderAddressParams = {
+    vmType: VmType;
+    chainId: string;
     depositor: string;
-    depositTimestamp: bigint;
+    timestamp: bigint;
     depositId: string;
-}): string;
-export declare function computeWithdrawerBalanceMessage(withdrawerAlias: string, amount: bigint, withdrawalNonce: string): `0x${string}`;
-export type WithdrawalAddressRequest = Omit<WithdrawalAddressParams, "depositoryChainId" | "amount" | "depository" | "withdrawerAlias"> & {
-    withdrawer: string;
-    withdrawerChainId: string;
-    chainId: string;
-};
-export type WithdrawalInitiationMessage = {
-    data: WithdrawalAddressRequest & {
-        expectedAmount: string;
-        settlementChainId: string;
-        signature: string;
-    };
-    result: {
-        withdrawalAddress: string;
-    };
-};
-export type WithdrawalInitiatedMessage = {
-    data: WithdrawalAddressRequest & {
-        expectedAmount: string;
-        settlementChainId: string;
-    };
-    result: {
-        proofOfWithdrawalAddressBalance: string;
-        withdrawalAddress: string;
-    };
-};
-export type OnChainWithdrawalQuery = {
-    data: {
-        chainId: string;
-        payloadId: string;
-        payloadParams: SubmitWithdrawRequest;
-    };
-    result: {
-        encodedData: string;
-        signature?: string;
-        signer?: string;
-    };
-};
-export type OnchainWithdrawalRequest = {
-    data: {
-        chainId: string;
-        currency: string;
-        amount: string;
-        recipient: string;
-        spender: string;
-        nonce: string;
-        additionalData?: {
-            "hyperliquid-vm"?: {
-                currencyHyperliquidSymbol: string;
-            };
-        };
-        signature: string;
-        owner: string;
-        ownerChainId: string;
-    };
-    result: {
-        id: string;
-        encodedData: string;
-        payloadId: string;
-        submitWithdrawalRequestParams: SubmitWithdrawRequest;
-        signer: string;
-    };
-};
-export type OnchainWithdrawalSignatureRequest = {
-    data: {
-        chainId: string;
-        payloadId: string;
-        payloadParams: SubmitWithdrawRequest;
-    };
-    result: {
-        message: string;
-    };
 };
+export declare function getOrderAddress(orderParams: OrderAddressParams): Address;

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

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSubmitWithdrawRequestHash = void 0;
 exports.getWithdrawalAddress = getWithdrawalAddress;
 exports.getOrderAddress = getOrderAddress;
-exports.computeWithdrawerBalanceMessage = computeWithdrawerBalanceMessage;
 const viem_1 = require("viem");
 const hub_utils_1 = require("../../hub/hub-utils");
 const utils_1 = require("../../utils");
@@ -17,7 +16,7 @@ const getSubmitWithdrawRequestHash = (request) => {
             currency: request.currency,
             amount: BigInt(request.amount),
             spender: request.spender,
-            receiver: request.receiver,
+            receiver: request.recipient,
             data: request.data,
             nonce: request.nonce,
         },
@@ -28,44 +27,36 @@ exports.getSubmitWithdrawRequestHash = getSubmitWithdrawRequestHash;
 /**
  * Compute deterministic withdrawal address
  *
+ * @param vmType the vm type of the depository chain
+ * @param chainId the chain id of the depository contract currently holding the funds
  * @param depository the depository contract holding the funds on origin chain (as string)
- * @param depositoryChainId the chain id of the depository contract currently holding the funds
  * @param currency the id of the currency as expressed on origin chain (string)
  * @param recipient the address that will receive the withdrawn funds on destination chain
- * @param withdrawerAlias the address that owns the balance on the settlement chain
- * before the withdrawal is initiated
- * @param withdrawalNonce nonce to prevent collisions for similar withdrawals
+ * @param ownerAlias the address that owns the balance on the settlement chain before the withdrawal is initiated
+ * @param nonce nonce to prevent collisions for similar withdrawals
  * @returns withdrawal address (in lower case)
  */
 function getWithdrawalAddress(withdrawalParams) {
     const hash = (0, viem_1.keccak256)((0, viem_1.encodePacked)(["string", "bytes", "bytes", "bytes", "address", "bytes32"], [
-        withdrawalParams.depositoryChainId,
-        (0, hub_utils_1.arrayToHex)((0, utils_1.encodeAddress)(withdrawalParams.depository, withdrawalParams.depositoryVmType)),
-        (0, hub_utils_1.arrayToHex)((0, utils_1.encodeAddress)(withdrawalParams.currency, withdrawalParams.depositoryVmType)),
-        (0, hub_utils_1.arrayToHex)((0, utils_1.encodeAddress)(withdrawalParams.recipient, withdrawalParams.depositoryVmType)),
-        withdrawalParams.withdrawerAlias,
-        `0x${BigInt(withdrawalParams.withdrawalNonce).toString(16).padStart(64, "0")}`,
+        withdrawalParams.chainId,
+        (0, hub_utils_1.arrayToHex)((0, utils_1.encodeAddress)(withdrawalParams.depository, withdrawalParams.vmType)),
+        (0, hub_utils_1.arrayToHex)((0, utils_1.encodeAddress)(withdrawalParams.currency, withdrawalParams.vmType)),
+        (0, hub_utils_1.arrayToHex)((0, utils_1.encodeAddress)(withdrawalParams.recipient, withdrawalParams.vmType)),
+        withdrawalParams.ownerAlias,
+        `0x${BigInt(withdrawalParams.nonce).toString(16).padStart(64, "0")}`,
     ]));
-    // get 40 bytes for an address
+    // Get 40 bytes for an address
     const withdrawalAddress = hash.slice(2).slice(-40).toLowerCase();
     return `0x${withdrawalAddress}`;
 }
-function getOrderAddress(data) {
+function getOrderAddress(orderParams) {
     const hash = (0, viem_1.keccak256)((0, viem_1.encodePacked)(["string", "bytes", "uint256", "bytes32"], [
-        data.depositChainId,
-        (0, hub_utils_1.arrayToHex)((0, utils_1.encodeAddress)(data.depositor, data.depositChainVmType)),
-        BigInt(data.depositTimestamp),
-        data.depositId,
+        orderParams.chainId,
+        (0, hub_utils_1.arrayToHex)((0, utils_1.encodeAddress)(orderParams.depositor, orderParams.vmType)),
+        orderParams.timestamp,
+        orderParams.depositId,
     ]));
+    // Get 40 bytes for an address
     const orderAddress = hash.slice(2).slice(-40);
     return `0x${orderAddress}`;
 }
-// compute a message about withdrawer balance
-// to be signed as auth proof for the oracle
-function computeWithdrawerBalanceMessage(withdrawerAlias, amount, withdrawalNonce) {
-    return (0, viem_1.keccak256)((0, viem_1.encodePacked)(["address", "uint256", "bytes32"], [
-        withdrawerAlias,
-        BigInt(amount),
-        withdrawalNonce,
-    ]));
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relay-protocol/settlement-sdk",
-  "version": "0.0.84",
+  "version": "0.0.86",
   "description": "Relay protocol SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",