shogun-relay-sdk 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -6,6 +6,7 @@ import { NetworkModule } from './modules/network';
 import { DealsModule } from './modules/deals';
 import { RegistryModule } from './modules/registry';
 import { UploadsModule } from './modules/uploads';
+import { BridgeModule } from './modules/bridge';
 export declare class ShogunRelaySDK {
     private client;
     system: SystemModule;
@@ -15,6 +16,7 @@ export declare class ShogunRelaySDK {
     deals: DealsModule;
     registry: RegistryModule;
     uploads: UploadsModule;
+    bridge: BridgeModule;
     constructor(config: ApiClientConfig);
     setToken(token: string): void;
 }

package/dist/index.js

@@ -9,6 +9,7 @@ const network_1 = require("./modules/network");
 const deals_1 = require("./modules/deals");
 const registry_1 = require("./modules/registry");
 const uploads_1 = require("./modules/uploads");
+const bridge_1 = require("./modules/bridge");
 class ShogunRelaySDK {
     constructor(config) {
         this.client = new client_1.ApiClient(config);
@@ -19,6 +20,7 @@ class ShogunRelaySDK {
         this.deals = new deals_1.DealsModule(this.client);
         this.registry = new registry_1.RegistryModule(this.client);
         this.uploads = new uploads_1.UploadsModule(this.client);
+        this.bridge = new bridge_1.BridgeModule(this.client);
     }
     setToken(token) {
         this.client.setToken(token);

package/dist/modules/bridge.d.ts

@@ -0,0 +1,146 @@
+import { ApiClient } from '../client';
+export interface PendingWithdrawal {
+    user: string;
+    amount: string;
+    nonce: string;
+    timestamp: number;
+    txHash?: string;
+}
+export interface BridgeState {
+    currentStateRoot: string;
+    currentBatchId: string;
+    sequencer: string;
+    contractBalance: string;
+    contractBalanceEth: string;
+}
+export interface WithdrawalProof {
+    proof: string[];
+    batchId: string;
+    root: string;
+    withdrawal: {
+        user: string;
+        amount: string;
+        nonce: string;
+    };
+}
+export interface TransferResult {
+    from: string;
+    to: string;
+    amount: string;
+    txHash: string;
+    fromBalance: string;
+    toBalance: string;
+}
+export interface WithdrawalResult {
+    user: string;
+    amount: string;
+    nonce: string;
+    timestamp: number;
+}
+export interface BatchResult {
+    batchId: string;
+    root: string;
+    withdrawalCount: number;
+    txHash: string;
+    blockNumber: number;
+}
+export declare class BridgeModule {
+    private client;
+    constructor(client: ApiClient);
+    /**
+     * Get user's L2 balance
+     * @param userAddress User's Ethereum address
+     * @returns Balance in wei and ETH
+     */
+    getBalance(userAddress: string): Promise<{
+        success: boolean;
+        user: string;
+        balance: string;
+        balanceEth: string;
+    }>;
+    /**
+     * Transfer balance from one user to another (L2 -> L2)
+     * @param params Transfer parameters
+     * @returns Transfer result
+     */
+    transfer(params: {
+        from: string;
+        to: string;
+        amount: string;
+        message: string;
+        seaSignature: string;
+        ethSignature: string;
+        gunPubKey: string;
+    }): Promise<{
+        success: boolean;
+        transfer: TransferResult;
+    }>;
+    /**
+     * Request withdrawal from L2 (creates pending withdrawal)
+     * @param params Withdrawal parameters
+     * @returns Withdrawal result
+     */
+    withdraw(params: {
+        user: string;
+        amount: string;
+        nonce: string;
+        message: string;
+        seaSignature: string;
+        ethSignature: string;
+        gunPubKey: string;
+    }): Promise<{
+        success: boolean;
+        withdrawal: WithdrawalResult;
+        message: string;
+    }>;
+    /**
+     * Get all pending withdrawals (waiting for batch submission)
+     * @returns List of pending withdrawals
+     */
+    getPendingWithdrawals(): Promise<{
+        success: boolean;
+        withdrawals: PendingWithdrawal[];
+        count: number;
+    }>;
+    /**
+     * Generate Merkle proof for a withdrawal
+     * The withdrawal must be included in the latest batch
+     * @param user User address
+     * @param amount Withdrawal amount
+     * @param nonce Withdrawal nonce
+     * @returns Merkle proof
+     */
+    getProof(user: string, amount: string, nonce: string): Promise<{
+        success: boolean;
+        proof: WithdrawalProof;
+    }>;
+    /**
+     * Get current bridge state (root, batchId, contract balance, etc.)
+     * @returns Bridge state
+     */
+    getState(): Promise<{
+        success: boolean;
+        state: BridgeState;
+    }>;
+    /**
+     * Submit a batch with Merkle root (sequencer only)
+     * @returns Batch submission result
+     */
+    submitBatch(): Promise<{
+        success: boolean;
+        batch: BatchResult;
+    }>;
+    /**
+     * Get deposit instructions (informational endpoint)
+     * Note: Actual deposits should be done on-chain by calling the contract's deposit() function
+     * @param amount Amount to deposit
+     * @returns Deposit instructions
+     */
+    getDepositInstructions(amount: string): Promise<{
+        success: boolean;
+        message: string;
+        contractAddress: string;
+        amount: string;
+        instructions: string;
+    }>;
+}

package/dist/modules/bridge.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BridgeModule = void 0;
+class BridgeModule {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get user's L2 balance
+     * @param userAddress User's Ethereum address
+     * @returns Balance in wei and ETH
+     */
+    async getBalance(userAddress) {
+        return this.client.get(`/api/v1/bridge/balance/${userAddress}`);
+    }
+    /**
+     * Transfer balance from one user to another (L2 -> L2)
+     * @param params Transfer parameters
+     * @returns Transfer result
+     */
+    async transfer(params) {
+        return this.client.post('/api/v1/bridge/transfer', params);
+    }
+    /**
+     * Request withdrawal from L2 (creates pending withdrawal)
+     * @param params Withdrawal parameters
+     * @returns Withdrawal result
+     */
+    async withdraw(params) {
+        return this.client.post('/api/v1/bridge/withdraw', params);
+    }
+    /**
+     * Get all pending withdrawals (waiting for batch submission)
+     * @returns List of pending withdrawals
+     */
+    async getPendingWithdrawals() {
+        return this.client.get('/api/v1/bridge/pending-withdrawals');
+    }
+    /**
+     * Generate Merkle proof for a withdrawal
+     * The withdrawal must be included in the latest batch
+     * @param user User address
+     * @param amount Withdrawal amount
+     * @param nonce Withdrawal nonce
+     * @returns Merkle proof
+     */
+    async getProof(user, amount, nonce) {
+        return this.client.get(`/api/v1/bridge/proof/${user}/${amount}/${nonce}`);
+    }
+    /**
+     * Get current bridge state (root, batchId, contract balance, etc.)
+     * @returns Bridge state
+     */
+    async getState() {
+        return this.client.get('/api/v1/bridge/state');
+    }
+    /**
+     * Submit a batch with Merkle root (sequencer only)
+     * @returns Batch submission result
+     */
+    async submitBatch() {
+        return this.client.post('/api/v1/bridge/submit-batch');
+    }
+    /**
+     * Get deposit instructions (informational endpoint)
+     * Note: Actual deposits should be done on-chain by calling the contract's deposit() function
+     * @param amount Amount to deposit
+     * @returns Deposit instructions
+     */
+    async getDepositInstructions(amount) {
+        return this.client.post('/api/v1/bridge/deposit', { amount });
+    }
+}
+exports.BridgeModule = BridgeModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shogun-relay-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "SDK for interacting with Shogun Relay API - HTTP client for IPFS, deals, registry, and network operations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -42,8 +42,8 @@
     "form-data": "^4.0.0"
   },
   "devDependencies": {
-    "typescript": "^5.0.0",
-    "@types/node": "^20.0.0"
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
   },
   "engines": {
     "node": ">=16.0.0"