@relay-protocol/settlement-sdk 0.0.80 → 0.0.81

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

@@ -1,17 +1,18 @@
+import { Address, Hex } from "viem";
 import { VmType } from "../utils";
 export interface TokenIdComponents {
     family: VmType;
-    chainId: bigint;
+    chainId: string;
     address: string;
 }
 export interface VirtualAddressComponents {
     family: VmType;
-    chainId: bigint;
+    chainId: string;
     address: string;
 }
 export type TokenId = bigint;
-export type VirtualAddress = `0x${string}`;
-export declare const getCheckSummedAddress: (family: string, address: string) => string;
+export type VirtualAddress = Address;
+export declare const arrayToHex: (arr: Uint8Array) => Hex;
 /**
  * Generates a virtual Ethereum address from token components
  * @param components The token components (family, chainId, address)

package/dist/hub/hub-utils.js

@@ -1,14 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCheckSummedAddress = void 0;
+exports.arrayToHex = 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;
+const utils_1 = require("../utils");
+const arrayToHex = (arr) => `0x${Buffer.from(arr).toString("hex")}`;
+exports.arrayToHex = arrayToHex;
 /**
  * Generates a virtual Ethereum address from token components
  * @param components The token components (family, chainId, address)
@@ -19,7 +17,7 @@ exports.getCheckSummedAddress = getCheckSummedAddress;
  */
 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 addressHash = (0, viem_1.keccak256)((0, viem_1.encodePacked)(["string", "bytes"], [chainId, (0, exports.arrayToHex)((0, utils_1.encodeAddress)(address, family))]));
     const addressBytes = addressHash.slice(2).slice(-40);
     return (0, viem_1.getAddress)("0x" + addressBytes);
 }
@@ -30,6 +28,6 @@ function generateAddress(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)]);
+    const packedData = (0, viem_1.encodePacked)(["string", "bytes"], [chainId, (0, exports.arrayToHex)((0, utils_1.encodeAddress)(address, family))]);
     return BigInt((0, viem_1.keccak256)(packedData));
 }

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, WithdrawalAddressParams, WithdrawalInitiationMessage, WithdrawalInitiatedMessage, WithdrawalAddressRequest, computeWithdrawerBalanceMessage } from "./messages/v2.2/withdrawal-execution";
-import { TokenIdComponents, VirtualAddressComponents, TokenId, VirtualAddress, getCheckSummedAddress, generateAddress, generateTokenId } from "./hub/hub-utils";
+import { SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, WithdrawalAddressParams, WithdrawalInitiationMessage, WithdrawalInitiatedMessage, WithdrawalAddressRequest, computeWithdrawerBalanceMessage, OnChainWithdrawalQuery, OnchainWithdrawalSignatureRequest, OnchainWithdrawalRequest } 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, getCheckSummedAddress, generateAddress, generateTokenId, SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, WithdrawalAddressParams, WithdrawalInitiationMessage, WithdrawalInitiatedMessage, WithdrawalAddressRequest, computeWithdrawerBalanceMessage, 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, SubmitWithdrawRequest, getSubmitWithdrawRequestHash, getWithdrawalAddress, WithdrawalAddressParams, WithdrawalInitiationMessage, WithdrawalInitiatedMessage, WithdrawalAddressRequest, computeWithdrawerBalanceMessage, OnChainWithdrawalQuery, OnchainWithdrawalSignatureRequest, OnchainWithdrawalRequest, NetworkConfigs, ProtocolContracts, NetworkConfig, };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.computeWithdrawerBalanceMessage = 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;
+exports.computeWithdrawerBalanceMessage = 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; } });
@@ -41,6 +41,5 @@ Object.defineProperty(exports, "getSubmitWithdrawRequestHash", { enumerable: tru
 Object.defineProperty(exports, "getWithdrawalAddress", { enumerable: true, get: function () { return withdrawal_execution_1.getWithdrawalAddress; } });
 Object.defineProperty(exports, "computeWithdrawerBalanceMessage", { enumerable: true, get: function () { return withdrawal_execution_1.computeWithdrawerBalanceMessage; } });
 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/v2.2/execution.js

@@ -74,7 +74,7 @@ const encodeAction = (action) => {
 };
 exports.encodeAction = encodeAction;
 const decodeAction = (action) => {
-    // Decode just the uint8 type
+    // decode just the uint8 type
     const [type] = (0, viem_1.decodeAbiParameters)((0, viem_1.parseAbiParameters)(["uint8 type"]), action);
     switch (type) {
         case ActionType.MINT: {

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

@@ -1,3 +1,4 @@
+import { VmType } from "../../utils";
 export interface SubmitWithdrawRequest {
     chainId: string;
     depository: string;
@@ -11,7 +12,7 @@ export interface SubmitWithdrawRequest {
 export declare const getSubmitWithdrawRequestHash: (request: SubmitWithdrawRequest) => `0x${string}`;
 export type WithdrawalAddressParams = {
     depository: string;
-    depositoryChainId: bigint;
+    depositoryChainId: string;
     currency: string;
     recipient: string;
     withdrawerAlias: string;
@@ -29,19 +30,26 @@ export type WithdrawalAddressParams = {
  * @param withdrawalNonce nonce to prevent collisions for similar withdrawals
  * @returns withdrawal address (in lower case)
  */
-export declare function getWithdrawalAddress(withdrawalParams: WithdrawalAddressParams): string;
-export declare const computeWithdrawerBalanceMessage: (withdrawerAlias: string, amount: bigint, withdrawalNonce: string) => `0x${string}`;
-export type WithdrawalAddressRequest = {
-    chainId: string;
-    currency: string;
-    recipient: string;
-    withdrawerChainId: string;
+export declare function getWithdrawalAddress(withdrawalParams: WithdrawalAddressParams & {
+    depositoryVmType: VmType;
+}): string;
+export declare function getOrderAddress(data: {
+    depositChainVmType: VmType;
+    depositChainId: string;
+    depositor: string;
+    depositTimestamp: 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;
-    withdrawalNonce: string;
+    withdrawerChainId: string;
+    chainId: string;
 };
 export type WithdrawalInitiationMessage = {
     data: WithdrawalAddressRequest & {
-        amount: string;
+        expectedAmount: string;
+        settlementChainId: string;
         signature: string;
     };
     result: {
@@ -50,10 +58,58 @@ export type WithdrawalInitiationMessage = {
 };
 export type WithdrawalInitiatedMessage = {
     data: WithdrawalAddressRequest & {
-        amount: string;
+        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;
+    };
+};

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

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.computeWithdrawerBalanceMessage = exports.getSubmitWithdrawRequestHash = void 0;
+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");
 const getSubmitWithdrawRequestHash = (request) => {
     const encoded = (0, viem_1.encodeAbiParameters)((0, viem_1.parseAbiParameters)([
         "(uint256 chainId, string depository, string currency, uint256 amount, address spender, string receiver, bytes data, bytes32 nonce)",
@@ -34,26 +38,34 @@ exports.getSubmitWithdrawRequestHash = getSubmitWithdrawRequestHash;
  * @returns withdrawal address (in lower case)
  */
 function getWithdrawalAddress(withdrawalParams) {
-    // Pack and hash data
-    const nonce = (0, viem_1.keccak256)((0, viem_1.encodePacked)(["string"], [withdrawalParams.withdrawalNonce]));
-    const hash = (0, viem_1.keccak256)((0, viem_1.encodePacked)(["string", "uint256", "string", "string", "address", "bytes32"], [
-        withdrawalParams.depository,
+    const hash = (0, viem_1.keccak256)((0, viem_1.encodePacked)(["string", "bytes", "bytes", "bytes", "address", "bytes32"], [
         withdrawalParams.depositoryChainId,
-        withdrawalParams.currency,
-        withdrawalParams.recipient,
+        (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,
-        nonce,
+        `0x${BigInt(withdrawalParams.withdrawalNonce).toString(16).padStart(64, "0")}`,
     ]));
-    // Get the first 40 bytes for an address
+    // get 40 bytes for an address
     const withdrawalAddress = hash.slice(2).slice(-40).toLowerCase();
     return `0x${withdrawalAddress}`;
 }
-// Compute a message about withdrawer balance to be signed as auth proof for the oracle
-const computeWithdrawerBalanceMessage = (withdrawerAlias, amount, withdrawalNonce) => {
+function getOrderAddress(data) {
+    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,
+    ]));
+    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,
     ]));
-};
-exports.computeWithdrawerBalanceMessage = computeWithdrawerBalanceMessage;
+}

package/package.json

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