chore(ts-sdk-sui): added transport interface for extra params

Signed-off-by: kaancaglan <[email protected]>

Author: Caglankaan

ts-sdk-sui/examples/sui-create-client-generate-instruction.ts

@@ -30,7 +30,7 @@ import * as TokenOrder from "@unionlabs/sdk/TokenOrder"
 
 const MNEMONIC = process.env.SUI_MNEMONIC ?? "..."
 const RECIPIENT = process.env.RECIPIENT
-  ?? "0x03ff9dd9e093387bdd4432c6a3eb6a1bd5a8f39a530042ac7efe576f18d3232b"
+  ?? "union1wycy8g8v5sff6gsjl9yhjs43q98xpl05p3gn2s"
 
 const keypair = Ed25519Keypair.deriveKeypair(MNEMONIC)
 
@@ -56,7 +56,7 @@ const program = Effect.gen(function*() {
     source,
     destination,
     sender: sender,
-    receiver: "union1wycy8g8v5sff6gsjl9yhjs43q98xpl05p3gn2s",
+    receiver: RECIPIENT,
     baseToken: "0x2::sui::SUI",
     baseAmount: 10000000n,
     quoteToken: "union1y05e0p2jcvhjzf7kcqsrqx93d4g3u93hc2hykaq8hrvkqrp5ltrssagzyd",
@@ -71,8 +71,27 @@ const program = Effect.gen(function*() {
     source,
     destination,
     channelId: ChannelId.make(5),
-    ucs03Address: "union1rfz3ytg6l60wxk5rxsk27jvn2907cyav04sz8kde3xhmmf9nplxqr8y05c",
+    ucs03Address: "0x8675045186976da5b60baf20dc94413fb5415a7054052dc14d93c13d3dbdf830",
     instruction: tokenOrder,
+  
+    // NEW — only read by the Sui client
+    transport: {
+      sui: {
+        relayStoreId:
+          "0x393a99c6d55d9a79efa52dea6ea253fef25d2526787127290b985222cc20a924",
+        vaultId:
+          "0x7c4ade19208295ed6bf3c4b58487aa4b917ba87d31460e9e7a917f7f12207ca3",
+        ibcStoreId:
+          "0xac7814eebdfbf975235bbb796e07533718a9d83201346769e5f281dc90009175",
+        coins: [
+          {
+            typeArg: "0x2::sui::SUI",
+            objectId:
+              "0xab70523198047a482febffab381a2a564002459bdcfa98991c747a013b3fd3e4",
+          },
+        ],
+      },
+    },
   })
 
   const zkgmClient = yield* ZkgmClient.ZkgmClient

ts-sdk-sui/src/internal/zkgmClient.ts

@@ -1,8 +1,6 @@
 import { Transaction } from "@mysten/sui/transactions"
-import { Indexer, ZkgmIncomingMessage } from "@unionlabs/sdk"
 import * as Call from "@unionlabs/sdk/Call"
 import type { Hex } from "@unionlabs/sdk/schema/hex"
-import * as Token from "@unionlabs/sdk/Token"
 import * as TokenOrder from "@unionlabs/sdk/TokenOrder"
 import * as Ucs03 from "@unionlabs/sdk/Ucs03"
 import * as Utils from "@unionlabs/sdk/Utils"
@@ -12,17 +10,14 @@ import * as ClientRequest from "@unionlabs/sdk/ZkgmClientRequest"
 import * as ClientResponse from "@unionlabs/sdk/ZkgmClientResponse"
 import * as IncomingMessage from "@unionlabs/sdk/ZkgmIncomingMessage"
 import * as ZkgmInstruction from "@unionlabs/sdk/ZkgmInstruction"
-import { Brand, Chunk, flow, Match, ParseResult, pipe, Predicate, Tuple } from "effect"
+import { Match, ParseResult, pipe, Predicate } from "effect"
 import * as A from "effect/Array"
 import * as Effect from "effect/Effect"
 import * as Inspectable from "effect/Inspectable"
-import * as O from "effect/Option"
 import * as S from "effect/Schema"
 import * as Stream from "effect/Stream"
-import * as Safe from "../Safe.js"
 import * as Sui from "../Sui.js"
 
-// import { Sui } from "../index.js"
 
 export const fromWallet = (
   opts: { client: Sui.Sui.PublicClient; wallet: Sui.Sui.WalletClient },
@@ -84,6 +79,8 @@ export const fromWallet = (
 
       console.log("[@unionlabs/sdk-sui/internal/zkgmClient]", { wallet, client })
 
+
+
       const timeoutTimestamp = Utils.getTimeoutInNanoseconds24HoursFromNow()
       const salt = yield* Utils.generateSalt("sui").pipe(
         Effect.mapError((cause) =>
@@ -117,18 +114,36 @@ export const fromWallet = (
       const tHeight = 0n
       const module = "zkgm" // zkgm module name
 
-      // These will be fetched from hubble or from deployments.json
-      const packageId = "0x8675045186976da5b60baf20dc94413fb5415a7054052dc14d93c13d3dbdf830" // zkgm package id
-      // TODO: packageId can be changed when zkgm updated
-      const relayStoreId = "0x393a99c6d55d9a79efa52dea6ea253fef25d2526787127290b985222cc20a924" // This won't be changed for a while
-      const vaultId = "0x7c4ade19208295ed6bf3c4b58487aa4b917ba87d31460e9e7a917f7f12207ca3" // This won't be changed for a while
-      const ibcStoreId = "0xac7814eebdfbf975235bbb796e07533718a9d83201346769e5f281dc90009175" // This won't be changed
 
-      // This 2 will be get by user all the time
-      const typeArg = "0x2::sui::SUI" // TODO: This should be dynamic based on the token sent
-      const coinObjectId = "0x89c430d35fa9f2778b0a635027b178146eb26d70d16292c289304d476ecf76cd" // TODO: This should be given by user
-      // Note: There can be multiple coins, for simplicity we are using one coin here
-      // User should be able to provide typeArgs and coinObjectIds array
+
+      const suiParams = request.transport?.sui
+      console.log("request.transport:", request.transport)
+      if (!suiParams) {
+        return yield* Effect.fail(
+          new ClientError.RequestError({
+            reason: "Transport",
+            request,
+            cause: new Error("Missing Sui transport params on ZkgmClientRequest.transport.sui"),
+            description: "Provide relayStoreId/vaultId/ibcStoreId and coins[]",
+          }),
+        )
+      }
+
+      const { relayStoreId, vaultId, ibcStoreId, coins } = suiParams
+
+      console.log("[@unionlabs/sdk-sui/internal/zkgmClient]", { relayStoreId, vaultId, ibcStoreId, coins })
+      // // These will be fetched from hubble or from deployments.json
+      // const packageId = "0x8675045186976da5b60baf20dc94413fb5415a7054052dc14d93c13d3dbdf830" // zkgm package id
+      // // TODO: packageId can be changed when zkgm updated
+      // const relayStoreId = "0x393a99c6d55d9a79efa52dea6ea253fef25d2526787127290b985222cc20a924" // This won't be changed for a while
+      // const vaultId = "0x7c4ade19208295ed6bf3c4b58487aa4b917ba87d31460e9e7a917f7f12207ca3" // This won't be changed for a while
+      // const ibcStoreId = "0xac7814eebdfbf975235bbb796e07533718a9d83201346769e5f281dc90009175" // This won't be changed
+
+      // // This 2 will be get by user all the time
+      // const typeArg = "0x2::sui::SUI" // TODO: This should be dynamic based on the token sent
+      // const coinObjectId = "0x89c430d35fa9f2778b0a635027b178146eb26d70d16292c289304d476ecf76cd" // TODO: This should be given by user
+      // // Note: There can be multiple coins, for simplicity we are using one coin here
+      // // User should be able to provide typeArgs and coinObjectIds array
 
       const hexToBytes = (hex: `0x${string}`): Uint8Array => {
         const s = hex.slice(2)
@@ -141,33 +156,36 @@ export const fromWallet = (
 
       // 1) begin_send(channel_id: u32, salt: vector<u8>) -> SendCtx
       let sendCtx = tx.moveCall({
-        target: `${packageId}::${module}::begin_send`,
+        target: `${request.ucs03Address}::${module}::begin_send`,
         typeArguments: [],
         arguments: [
           tx.pure.u32(Number(request.channelId)),
           tx.pure.vector("u8", hexToBytes(salt as `0x${string}`)),
         ],
       })
 
-      // 2) send_with_coin<T>(relay_store, vault, ibc_store, coin, version, opcode, operand, ctx) -> SendCtx
-      sendCtx = tx.moveCall({
-        target: `${packageId}::${module}::send_with_coin`,
-        typeArguments: [typeArg],
-        arguments: [
-          tx.object(relayStoreId),
-          tx.object(vaultId),
-          tx.object(ibcStoreId),
-          tx.object(coinObjectId),
-          tx.pure.u8(Number(request.instruction.version)),
-          tx.pure.u8(Number(request.instruction.opcode)),
-          tx.pure.vector("u8", hexToBytes(operand as `0x${string}`)),
-          sendCtx,
-        ],
-      })
+      // 2) For each coin: send_with_coin<T>(relay_store, vault, ibc_store, coin, version, opcode, operand, ctx) -> SendCtx
+      for (const { typeArg, objectId } of coins) {
+        sendCtx = tx.moveCall({
+          target: `${request.ucs03Address}::${module}::send_with_coin`,
+          typeArguments: [typeArg],
+          arguments: [
+            tx.object(relayStoreId),
+            tx.object(vaultId),
+            tx.object(ibcStoreId),
+            tx.object(objectId),
+            tx.pure.u8(Number(request.instruction.version)),
+            tx.pure.u8(Number(request.instruction.opcode)),
+            tx.pure.vector("u8", hexToBytes(operand as `0x${string}`)),
+            sendCtx,
+          ],
+        })
+      }
+
 
       // 3) end_send(ibc_store, clock, t_height: u64, timeout_ns: u64, ctx)
       tx.moveCall({
-        target: `${packageId}::${module}::end_send`,
+        target: `${request.ucs03Address}::${module}::end_send`,
         typeArguments: [],
         arguments: [
           tx.object(ibcStoreId),

ts-sdk/src/ZkgmClientRequest.ts

@@ -13,6 +13,38 @@ import { ChannelId } from "./schema/channel.js"
 import type * as Token from "./Token.js"
 import type * as ZkgmInstruction from "./ZkgmInstruction.js"
 
+
+/** @since 2.0.0 */
+export namespace Transport {
+  
+  export interface Sui {
+    readonly relayStoreId: string
+    readonly vaultId: string
+    readonly ibcStoreId: string
+    /** One or more coins a user wants to spend. Keep array for multi-coin support. */
+    readonly coins: ReadonlyArray<{
+      /** e.g. "0x2::sui::SUI" or a custom coin type */
+      readonly typeArg: string
+      /** Concrete coin object id(s) for spending */
+      readonly objectId: string
+    }>
+  }
+
+  export interface Evm {
+    readonly _?: never
+  }
+
+  export interface Cosmos {
+    readonly _?: never
+  }
+
+  export interface Params {
+    readonly sui?: Sui | undefined
+    readonly evm?: Evm | undefined
+    readonly cosmos?: Cosmos | undefined
+  }
+}
+
 /**
  * @category type ids
  * @since 2.0.0
@@ -40,6 +72,8 @@ export interface ZkgmClientRequest extends Inspectable, Pipeable {
    * **NOTE:** only for EVM submission
    */
   readonly kind: "execute" | "simulateAndExecute"
+  /** NEW: optional, per-runtime parameters (non-breaking) */
+  readonly transport?: Transport.Params | undefined
 }
 
 /**
@@ -53,6 +87,8 @@ export interface Options {
   readonly ucs03Address: string // XXX: narrow
   readonly instruction?: ZkgmInstruction.ZkgmInstruction | undefined
   readonly kind?: "execute" | "simulateAndExecute" | undefined
+  /** NEW: optional, per-runtime parameters (non-breaking) */
+  readonly transport?: Transport.Params | undefined
 }
 
 /**
@@ -66,8 +102,10 @@ export const make: (options: {
   ucs03Address: string // XXX: narrow
   instruction: ZkgmInstruction.ZkgmInstruction
   kind?: "execute" | "simulateAndExecute" | undefined
+  transport?: Transport.Params | undefined
 }) => ZkgmClientRequest = internal.make
 
+
 /**
  * @category combinators
  * @since 2.0.0

ts-sdk/src/internal/zkgmClientRequest.ts

@@ -9,6 +9,7 @@ import { Hex } from "../schema/hex.js"
 import type * as Token from "../Token.js"
 import type * as ClientRequest from "../ZkgmClientRequest.js"
 import { ZkgmInstruction } from "../ZkgmInstruction.js"
+import type { Transport } from "../ZkgmClientRequest.js"
 
 /** @internal */
 export const TypeId: ClientRequest.TypeId = Symbol.for(
@@ -44,6 +45,7 @@ function makeProto(
   ucs03Address: string,
   instruction: ZkgmInstruction,
   kind: "execute" | "simulateAndExecute",
+  transport?: Transport.Params | undefined
 ): ClientRequest.ZkgmClientRequest {
   const self = Object.create(Proto)
   self.source = source
@@ -52,6 +54,7 @@ function makeProto(
   self.ucs03Address = ucs03Address
   self.instruction = instruction
   self.kind = kind
+  self.transport = transport  
   return self
 }
 
@@ -67,6 +70,7 @@ export const empty: ClientRequest.ZkgmClientRequest = makeProto(
   void 0 as unknown as Hex,
   void 0 as unknown as ZkgmInstruction,
   "execute",
+  undefined,
 )
 
 /** @internal */
@@ -77,6 +81,7 @@ export const make = (options: {
   ucs03Address: string
   instruction: ZkgmInstruction
   kind?: "execute" | "simulateAndExecute" | undefined
+  transport?: Transport.Params | undefined
 }) => modify(empty, options)
 
 /** @internal */
@@ -110,6 +115,8 @@ export const modify = dual<
     result = setKind(result, options.kind)
   }
 
+  if (options.transport) result = setTransport(result, options.transport) 
+
   return result
 })
 
@@ -127,6 +134,7 @@ export const setSource = dual<
     self.ucs03Address,
     self.instruction,
     self.kind,
+    self.transport,
   ))
 
 /** @internal */
@@ -143,8 +151,26 @@ export const setDestination = dual<
     self.ucs03Address,
     self.instruction,
     self.kind,
+    self.transport,
   ))
 
+export const setTransport = dual<
+  (transport: Transport.Params) =>
+    (self: ClientRequest.ZkgmClientRequest) => ClientRequest.ZkgmClientRequest,
+  (self: ClientRequest.ZkgmClientRequest, transport: Transport.Params) =>
+    ClientRequest.ZkgmClientRequest
+>(2, (self, transport) =>
+  makeProto(
+    self.source,
+    self.destination,
+    self.channelId,
+    self.ucs03Address,
+    self.instruction,
+    self.kind,
+    transport,                                 
+  ))
+
+
 /** @internal */
 export const setChannelId = dual<
   (
@@ -159,6 +185,7 @@ export const setChannelId = dual<
     self.ucs03Address,
     self.instruction,
     self.kind,
+    self.transport,
   ))
 /** @internal */
 export const setUcs03Address = dual<
@@ -174,6 +201,7 @@ export const setUcs03Address = dual<
     ucs03Address,
     self.instruction,
     self.kind,
+    self.transport,
   ))
 
 /** @internal */
@@ -193,6 +221,7 @@ export const setInstruction = dual<
     self.ucs03Address,
     instruction,
     self.kind,
+    self.transport,
   ))
 
 /** @internal */
@@ -212,6 +241,7 @@ export const setKind = dual<
     self.ucs03Address,
     self.instruction,
     kind,
+    self.transport,
   ))
 
 /** @internal */