@relay-protocol/settlement-sdk 0.0.64 → 0.0.67

package/README.md

@@ -1,3 +1,109 @@
-## Relay protocol SDK
+# Relay Settlement SDK
 
-> #### SDK for the Relay protocol
+TypeScript SDK for encoding/decoding and passing messages accross the Relay Settlement Protocol.
+
+## Installation
+
+```bash
+npm install @relay-protocol/settlement-sdk
+# or
+yarn add @relay-protocol/settlement-sdk
+```
+
+## Usage
+
+### Orders
+
+```typescript
+import {
+  encodeOrderCall,
+  decodeOrderCall,
+  getOrderId,
+} from "@relay-protocol/settlement-sdk"
+
+// Encode an order call
+const encoded = encodeOrderCall({
+  vmType: "ethereum-vm",
+  call: {
+    to: "0x...",
+    data: "0x...",
+    value: "1000000000000000000",
+  },
+})
+
+// Decode an order call
+const decoded = decodeOrderCall(encoded, "ethereum-vm")
+
+// Get order ID
+const orderId = getOrderId(order, chainsConfig)
+```
+
+### Address Encoding
+
+```typescript
+import {
+  encodeAddress,
+  decodeAddress,
+  VmType,
+} from "@relay-protocol/settlement-sdk"
+
+// Encode address for a specific VM type
+const encoded = encodeAddress("bc1q...", "bitcoin-vm")
+const decoded = decodeAddress(encoded, "bitcoin-vm")
+```
+
+### Hub Contract utils
+
+```typescript
+import {
+  generateAddress,
+  generateTokenId,
+} from "@relay-protocol/settlement-sdk"
+
+// Generate virtual address
+const virtualAddress = generateAddress({
+  family: "ethereum-vm",
+  chainId: 1n,
+  address: "0x...",
+})
+
+// Generate token ID
+const tokenId = generateTokenId({
+  family: "ethereum-vm",
+  chainId: 1n,
+  address: "0x...",
+})
+```
+
+### Depository Contracts utils
+
+```typescript
+import {
+  encodeWithdrawal,
+  decodeWithdrawal,
+  getDepositoryDepositMessageId,
+  getExecutionMessageId,
+} from "@relay-protocol/settlement-sdk"
+
+// Encode/decode withdrawal messages
+const encoded = encodeWithdrawal(withdrawal, vmType)
+const decoded = decodeWithdrawal(encoded, vmType)
+
+// Get message IDs
+const depositId = getDepositoryDepositMessageId(message)
+const executionId = getExecutionMessageId(message)
+```
+
+## Supported VM Types
+
+- `bitcoin-vm`
+- `ethereum-vm`
+- `solana-vm`
+- `sui-vm`
+- `hyperliquid-vm`
+- `tron-vm`
+- `lighter-vm`
+
+## API Reference
+
+See the [TypeScript definitions](./dist/index.d.ts) for complete API documentation.

package/dist/index.d.ts

@@ -7,4 +7,5 @@ import { ActionType, ExecutionMessage, ExecutionMessageMetadata, getExecutionMes
 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, };
+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, NetworkConfigs, ProtocolContracts, NetworkConfig, };

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

@@ -10,10 +10,10 @@ export interface SubmitWithdrawRequest {
 }
 export declare const getSubmitWithdrawRequestHash: (request: SubmitWithdrawRequest) => `0x${string}`;
 export type WithdrawalAddressParams = {
-    depositoryAddress: string;
+    depository: string;
     depositoryChainId: bigint;
     currency: string;
-    recipientAddress: string;
+    recipient: string;
     withdrawerAlias: string;
     amount: bigint;
     withdrawalNonce: string;
@@ -21,10 +21,10 @@ export type WithdrawalAddressParams = {
 /**
  * Compute deterministic withdrawal address
  *
- * @param depositoryAddress the depository contract holding the funds on origin chain
+ * @param depository the depository contract holding the funds on origin chain
  * @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 recipientAddress the address that will receive the withdrawn funds on destination chain
+ * @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 amount the balance to withdraw
@@ -32,8 +32,8 @@ export type WithdrawalAddressParams = {
  * @returns withdrawal address (in lower case)
  */
 export declare function getWithdrawalAddress(withdrawalParams: WithdrawalAddressParams): string;
-export type WithdrawalAddressRequest = Omit<WithdrawalAddressParams, "depositoryChainId" | "amount"> & {
-    depositoryChainSlug: string;
+export type WithdrawalAddressRequest = Omit<WithdrawalAddressParams, "depositoryChainId" | "amount" | "depository"> & {
+    chainId: string;
     amount: string;
 };
 export type WithdrawalInitiationMessage = {

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

@@ -35,10 +35,10 @@ exports.getSubmitWithdrawRequestHash = getSubmitWithdrawRequestHash;
 /**
  * Compute deterministic withdrawal address
  *
- * @param depositoryAddress the depository contract holding the funds on origin chain
+ * @param depository the depository contract holding the funds on origin chain
  * @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 recipientAddress the address that will receive the withdrawn funds on destination chain
+ * @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 amount the balance to withdraw
@@ -57,10 +57,10 @@ function getWithdrawalAddress(withdrawalParams) {
         "uint256",
         "bytes32",
     ], [
-        withdrawalParams.depositoryAddress,
+        withdrawalParams.depository,
         withdrawalParams.depositoryChainId,
         withdrawalParams.currency,
-        withdrawalParams.recipientAddress,
+        withdrawalParams.recipient,
         withdrawalParams.withdrawerAlias,
         withdrawalParams.amount,
         nonce,

package/dist/networks.d.ts

@@ -0,0 +1,48 @@
+import { VmType } from "./utils";
+export interface ProtocolContracts {
+    depository?: string;
+    oracle?: string;
+    allocator?: string;
+    multisigSigner?: string;
+}
+export interface NetworkConfig {
+    chainId: bigint;
+    name: string;
+    family: VmType;
+    slug: string;
+    earliestBlock?: number;
+    isTestnet: boolean;
+    assets?: NetworkAssets;
+    rpc: [string, ...string[]];
+    explorerApiUrl?: string;
+    blockExplorer?: {
+        chainId: number;
+        network: string;
+        urls: {
+            apiURL: string;
+            browserURL: string;
+        };
+        apiKey?: string;
+    };
+    nativeCurrency?: {
+        decimals: number;
+        name: string;
+        symbol: string;
+    };
+    near?: {
+        rpc: string;
+        signer: string;
+    };
+    hubChainId?: string;
+    contracts?: {
+        dev?: ProtocolContracts;
+        prod?: ProtocolContracts;
+    };
+}
+interface NetworkAssets {
+    [asset: string]: string;
+}
+export interface NetworkConfigs {
+    [networkId: string]: NetworkConfig;
+}
+export {};

package/dist/networks.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

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