@unionlabs/payments 0.3.0 → 0.3.1

package/src/ChainRegistry.ts

@@ -0,0 +1,27 @@
+import { Effect, Option as O, pipe, Record as R } from "effect";
+import * as Domain from "./Domain.js";
+import * as Error from "./Error.js";
+
+export const UniversalChainIdMap: Record<Domain.UniversalChainId, bigint> = {
+  [Domain.UniversalChainId.make("base.8453")]: 8453n,
+  [Domain.UniversalChainId.make("ethereum.1")]: 1n,
+};
+
+export const getOrError: (
+  ucid: Domain.UniversalChainId,
+) => Effect.Effect<bigint, Error.SdkError, never> = (ucid) =>
+  pipe(
+    UniversalChainIdMap,
+    R.get(ucid),
+    O.match({
+      onNone: () =>
+        Effect.fail(
+          new Error.SystemError({
+            method: "resolveUniversalChainId",
+            module: "EvmWalletClient",
+            reason: "InvalidData",
+          }),
+        ),
+      onSome: Effect.succeed,
+    }),
+  );

package/src/Payment.ts

@@ -16,6 +16,7 @@ import {
   toHex,
 } from "viem";
 import type * as Attestor from "./Attestor.js";
+import * as ChainRegistry from "./ChainRegistry.js";
 import * as Constants from "./Constants.js";
 import * as ZAssetRegistry from "./constants/z-asset-registry.js";
 import * as Domain from "./Domain.js";
@@ -39,9 +40,8 @@ export interface DepositOptions {
   readonly depositAddress: DepositAddress;
   /** Amount to deposit (in underlying token's smallest unit) */
   readonly amount: bigint;
-  readonly sourceChainId: bigint;
   readonly srcErc20Address: Domain.Erc20Address;
-  readonly universalChainId: Domain.UniversalChainId;
+  readonly destinationChainId: Domain.UniversalChainId;
 }
 
 /**
@@ -72,23 +72,27 @@ export interface DepositAddress {
     Domain.Erc20Address,
   ];
   readonly zAssetAddress: Domain.ZAssetAddress;
-  readonly destinationChainId: bigint;
+  readonly destinationChainId: Domain.UniversalChainId;
 }
 
 export const getDepositAddress = Effect.fn("getDepositAddress")(
   (options: {
     paymentKey: Domain.PaymentKey;
     beneficiaries: ReadonlyArray<Domain.Erc20Address>;
-    destinationChainId: bigint;
+    destinationChainId: Domain.UniversalChainId;
   }) =>
     Effect.gen(function* () {
       const paddedBeneficiaries = yield* padBeneficiaries(
         options.beneficiaries,
       );
+
+      const _destinationChainId = yield* ChainRegistry.getOrError(
+        options.destinationChainId,
+      );
       const unspendableAddress = pipe(
         Poseidon2.computeUnspendableAddress(
           options.paymentKey,
-          options.destinationChainId,
+          _destinationChainId,
           paddedBeneficiaries,
         ),
         Domain.Erc20Address,
@@ -96,6 +100,7 @@ export const getDepositAddress = Effect.fn("getDepositAddress")(
 
       return {
         beneficiaries: paddedBeneficiaries,
+        // TODO: unspendablae address
         zAssetAddress: Domain.ZAssetAddress(unspendableAddress),
         destinationChainId: options.destinationChainId,
       };
@@ -132,26 +137,27 @@ const padBeneficiaries = Effect.fn("padBeneficiaries")(
 
 export const getNullifier: (options: {
   paymentKey: Domain.PaymentKey;
-  destinationChainId: bigint;
+  destinationChainId: Domain.UniversalChainId;
 }) => Effect.Effect<Domain.Nullifier, Error.SdkError, never> = Effect.fn(
   "getNullifier",
 )((options) =>
   pipe(
-    Effect.try({
-      try: () =>
-        Poseidon2.computeNullifier(
-          options.paymentKey,
-          options.destinationChainId,
-        ),
-      catch: (cause) =>
-        new Error.SystemError({
-          method: "getNullifier",
-          module: "PaymentClient",
-          reason: "InvalidData",
-          cause,
+    ChainRegistry.getOrError(options.destinationChainId),
+    Effect.flatMap((chainId) =>
+      pipe(
+        Effect.try({
+          try: () => Poseidon2.computeNullifier(options.paymentKey, chainId),
+          catch: (cause) =>
+            new Error.SystemError({
+              method: "getNullifier",
+              module: "PaymentClient",
+              reason: "InvalidData",
+              cause,
+            }),
         }),
-    }),
-    Effect.map(Domain.Nullifier),
+        Effect.map(Domain.Nullifier),
+      ),
+    ),
   ),
 );
 /**
@@ -260,7 +266,7 @@ export const generateProof: (options: {
   selectedClientId: number;
   nullifier: Domain.Nullifier;
   depositAddress: DepositAddress;
-  srcChainId: bigint;
+  srcChainId: Domain.UniversalChainId;
   srcErc20Address: Domain.Erc20Address;
   dstErc20Address: Domain.Erc20Address;
 }) => Effect.Effect<
@@ -404,9 +410,13 @@ export const generateProof: (options: {
     blockNumber: selectedClient.height,
   });
 
+  const dstChainId = yield* ChainRegistry.getOrError(
+    options.depositAddress.destinationChainId,
+  );
+
   const witness: Prover.WitnessData = {
     secret: options.paymentKey,
-    dstChainId: options.depositAddress.destinationChainId,
+    dstChainId,
     beneficiaries: options.depositAddress.beneficiaries,
     beneficiary: options.beneficiary,
     redeemAmount: options.amount,
@@ -539,11 +549,9 @@ export const prepareDeposit = Effect.fn("deposit")((options: DepositOptions) =>
     return yield* srcWalletClient.prepareDeposit({
       amount: options.amount,
       depositAddress: options.depositAddress.zAssetAddress,
-      sourceChainId: options.sourceChainId,
       srcErc20Address: options.srcErc20Address,
       beneficiaries: options.depositAddress.beneficiaries,
-      destinationChainId: options.depositAddress.destinationChainId,
-      universalChainId: options.universalChainId,
+      destinationChainId: options.destinationChainId,
     });
   }),
 );

package/src/PublicClient.ts

@@ -120,9 +120,9 @@ export namespace PublicClient {
    */
   export interface ReadBalanceOptions {
     readonly srcErc20Address: Domain.Erc20Address;
-    readonly srcChainId: bigint;
+    readonly srcChainId: Domain.UniversalChainId;
     readonly dstErc20Address: Domain.Erc20Address;
-    readonly dstChainId: bigint;
+    readonly dstChainId: Domain.UniversalChainId;
     readonly depositAddress: `0x${string}`;
     readonly nullifier: Domain.Nullifier;
     readonly clientId: number;
@@ -136,8 +136,8 @@ export namespace PublicClient {
   export interface ReadBalanceAtHeightOptions {
     readonly srcErc20Address: Domain.Erc20Address;
     readonly dstErc20Address: Domain.Erc20Address;
-    readonly srcChainId: bigint;
-    readonly dstChainId: bigint;
+    readonly srcChainId: Domain.UniversalChainId;
+    readonly dstChainId: Domain.UniversalChainId;
     readonly depositAddress: `0x${string}`;
     readonly nullifier: Domain.Nullifier;
     readonly height: bigint;

package/src/WalletClient.ts

@@ -157,12 +157,10 @@ export namespace WalletClient {
   }
 
   export type Deposit = {
-    universalChainId: Domain.UniversalChainId;
+    destinationChainId: Domain.UniversalChainId;
     srcErc20Address: Domain.Erc20Address;
-    sourceChainId: bigint;
     readonly beneficiaries: ReadonlyArray<Address>;
     depositAddress: Domain.ZAssetAddress;
-    destinationChainId: bigint;
     amount: bigint;
   };
 

package/src/constants/ibc-core-registry.ts

@@ -3,16 +3,20 @@ import * as Domain from "../Domain.js";
 import * as Error from "../Error.js";
 
 export const IBC_CORE_REGISTRY: {
-  [chainId: string]: Domain.IbcCoreAddress;
+  [chainId: Domain.UniversalChainId]: Domain.IbcCoreAddress;
 } = {
-  "8453": Domain.IbcCoreAddress("0xee4ea8d358473f0fcebf0329feed95d56e8c04d7"),
+  [Domain.UniversalChainId.make("base.8453")]: Domain.IbcCoreAddress(
+    "0xee4ea8d358473f0fcebf0329feed95d56e8c04d7",
+  ),
+  [Domain.UniversalChainId.make("ethereum.1")]: Domain.IbcCoreAddress(
+    "0xee4ea8d358473f0fcebf0329feed95d56e8c04d7",
+  ),
 } as const;
 
-export function getIbcCoreAddress(
-  chainId: bigint,
-): Option.Option<Domain.IbcCoreAddress> {
-  return Option.fromNullable(IBC_CORE_REGISTRY[`${chainId}`]);
-}
+export const getIbcCoreAddress = (
+  ucid: Domain.UniversalChainId,
+): Option.Option<Domain.IbcCoreAddress> =>
+  Option.fromNullable(IBC_CORE_REGISTRY[ucid]);
 
 export const getIbcCoreAddressOrError = flow(
   getIbcCoreAddress,

package/src/constants/z-asset-registry.ts

@@ -4,22 +4,25 @@ import * as Domain from "../Domain.js";
 import * as Error from "../Error.js";
 
 export const Z_ASSET_REGISTRY: {
-  [chainId: string]: {
+  [chainId: Domain.UniversalChainId]: {
     [assetAddress: Erc20Address]: Domain.ZAssetAddress;
   };
 } = {
-  "8453": {
+  [Domain.UniversalChainId.make("base.8453")]: {
     [Domain.Erc20Address("0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913")]:
       Domain.ZAssetAddress("0xF0000101561619d8A61ABd045F47Af4f41Afe62D"),
   },
+  [Domain.UniversalChainId.make("ethereum.1")]: {
+    [Domain.Erc20Address("0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48")]: // USDC on ethereum.1
+      Domain.ZAssetAddress("0xF0000101561619d8A61ABd045F47Af4f41Afe62D"),
+  },
 } as const;
 
-export function getZAsset(
-  chainId: bigint,
+export const getZAsset = (
+  universalChainId: Domain.UniversalChainId,
   assetAddress: Erc20Address,
-): Option.Option<Domain.ZAssetAddress> {
-  return Option.fromNullable(Z_ASSET_REGISTRY[`${chainId}`]?.[assetAddress]);
-}
+): Option.Option<Domain.ZAssetAddress> =>
+  Option.fromNullable(Z_ASSET_REGISTRY?.[universalChainId]?.[assetAddress]);
 
 export const getZAssetOrError = flow(
   getZAsset,

package/src/internal/evmWalletClient.ts

@@ -2,14 +2,11 @@ import * as A from "effect/Array";
 import * as Effect from "effect/Effect";
 import { pipe } from "effect/Function";
 import * as Number from "effect/Number";
-import * as O from "effect/Option";
 import type * as P from "effect/Predicate";
-import * as R from "effect/Record";
 import * as Ref from "effect/Ref";
 import type * as Scope from "effect/Scope";
 import type * as Mipd from "mipd";
 import type * as Viem from "viem";
-import * as ViemChains from "viem/chains";
 import * as Abi from "../Abi.js";
 import * as ZAssetRegistry from "../constants/z-asset-registry.js";
 import * as Domain from "../Domain.js";
@@ -18,30 +15,6 @@ import type * as EvmWalletClient from "../EvmWalletClient.js";
 import * as Client from "../WalletClient.js";
 import * as internalEvmPublicClient from "./evmPublicClient.js";
 
-const UniversalChainIdMap: Record<Domain.UniversalChainId, Viem.Chain> = {
-  [Domain.UniversalChainId.make("base.8453")]: ViemChains.base,
-};
-
-/** @internal */
-export const resolveUniversalChainId = (
-  ucid: Domain.UniversalChainId,
-): Effect.Effect<Viem.Chain, Error.SdkError, never> =>
-  pipe(
-    UniversalChainIdMap,
-    R.get(ucid),
-    O.match({
-      onNone: () =>
-        Effect.fail(
-          new Error.SystemError({
-            method: "resolveUniversalChainId",
-            module: "EvmWalletClient",
-            reason: "InvalidData",
-          }),
-        ),
-      onSome: Effect.succeed,
-    }),
-  );
-
 /** @internal */
 export const TypeId: EvmWalletClient.TypeId = Symbol.for(
   "@unionlabs/payments/EvmWalletClient",
@@ -353,7 +326,6 @@ export const makeViem = (
     const sign = Effect.fn("sign")(function* (
       request: ReadonlyArray<Domain.PreparedRequest> | Domain.PreparedRequest,
     ) {
-      // const chain = yield* resolveUniversalChainId(request.universalChainId);
       const requests = yield* pipe(
         request,
         A.ensure,
@@ -362,11 +334,12 @@ export const makeViem = (
             n,
             Effect.liftPredicate(
               Domain.PreparedRequest.$is("PreparedEvm"),
-              (x) =>
+              (cause) =>
                 new Error.SystemError({
                   method: "sign",
                   module: "EvmWalletClient",
                   reason: "InvalidData",
+                  cause,
                 }),
             ),
           ),
@@ -474,8 +447,7 @@ export const makeViem = (
     const approveZAssetToSpendErc20 = Effect.fn("approveZAssetToSpendErc20")(
       function* (args: Client.WalletClient.ApproveZAssetToSpendErc20) {
         return yield* pipe(
-          // XXX: fix hardcoded chainid
-          ZAssetRegistry.getZAsset(8453n, args.srcErc20Address),
+          ZAssetRegistry.getZAsset(args.universalChainId, args.srcErc20Address),
           Effect.mapError(
             (cause) =>
               new Error.SystemError({
@@ -708,10 +680,8 @@ export const makeViem = (
 
     const depositUnderlyingZAsset = Effect.fn("depositUnderlyingZAsset")(
       function* (args: Client.WalletClient.DepositUnderlyingZAsset) {
-        const zAssetAddr = yield* ZAssetRegistry.getZAsset(
-          8453n,
-          args.srcErc20Address,
-        ).pipe(
+        const zAssetAddress = yield* pipe(
+          ZAssetRegistry.getZAsset(args.universalChainId, args.srcErc20Address),
           Effect.mapError(
             (cause) =>
               new Error.SystemError({
@@ -729,17 +699,10 @@ export const makeViem = (
             functionName: "deposit",
             args: [args.amount],
           }),
-          // Effect.map((data) =>
-          //   prepareTransactionRequest({
-          //     to: zAssetAddr,
-          //     data,
-          //     chain: wallet.chain,
-          //   }),
-          // ),
           Effect.map((data) =>
             Domain.PreparedRequest.PreparedEvm({
               ...data,
-              contractAddress: Domain.Erc20Address(zAssetAddr),
+              contractAddress: Domain.Erc20Address(zAssetAddress),
               universalChainId: args.universalChainId,
               kind: "Erc20.Wrap",
             }),
@@ -751,10 +714,8 @@ export const makeViem = (
     const transferZAsset = Effect.fn("transferZAsset")(function* (
       args: Client.WalletClient.TransferZAsset,
     ) {
-      const zAssetAddr = yield* ZAssetRegistry.getZAsset(
-        8453n,
-        args.srcErc20Address,
-      ).pipe(
+      const zAssetAddress = yield* pipe(
+        ZAssetRegistry.getZAsset(args.universalChainId, args.srcErc20Address),
         Effect.mapError(
           (cause) =>
             new Error.SystemError({
@@ -772,17 +733,10 @@ export const makeViem = (
           functionName: "transfer",
           args: [args.depositAddress, args.amount],
         }),
-        // Effect.flatMap((data) =>
-        //   prepareTransactionRequest({
-        //     to: zAssetAddr,
-        //     data,
-        //     chain: wallet.chain,
-        //   }),
-        // ),
         Effect.map((data) =>
           Domain.PreparedRequest.PreparedEvm({
             ...data,
-            contractAddress: Domain.Erc20Address(zAssetAddr),
+            contractAddress: Domain.Erc20Address(zAssetAddress),
             universalChainId: args.universalChainId,
             kind: "ZAsset.Transfer",
           }),
@@ -793,19 +747,18 @@ export const makeViem = (
     const prepareDeposit = Effect.fn("prepareDeposit")(function* (
       args: Client.WalletClient.Deposit,
     ) {
-      const zAssetAddress =
-        ZAssetRegistry.Z_ASSET_REGISTRY[`${args.sourceChainId}`][
-          args.srcErc20Address
-        ];
-
-      if (!zAssetAddress) {
-        return yield* new Error.SystemError({
-          method: "deposit",
-          module: "PaymentClient",
-          reason: "InvalidData",
-          description: `No zAsset found for ${args.srcErc20Address} on chain ${args.sourceChainId}`,
-        });
-      }
+      const zAssetAddress = yield* pipe(
+        ZAssetRegistry.getZAsset(args.destinationChainId, args.srcErc20Address),
+        Effect.mapError(
+          (cause) =>
+            new Error.SystemError({
+              method: "prepareDeposit",
+              module: "EvmWalletClient",
+              reason: "InvalidData",
+              cause,
+            }),
+        ),
+      );
 
       const [approval, deposit, transfer] = yield* Effect.all(
         [
@@ -819,7 +772,7 @@ export const makeViem = (
               Domain.PreparedRequest.PreparedEvm({
                 ...data,
                 contractAddress: args.srcErc20Address,
-                universalChainId: args.universalChainId,
+                universalChainId: args.destinationChainId,
                 kind: "Erc20.Approve",
               }),
             ),
@@ -834,7 +787,7 @@ export const makeViem = (
               Domain.PreparedRequest.PreparedEvm({
                 ...data,
                 contractAddress: Domain.Erc20Address(zAssetAddress),
-                universalChainId: args.universalChainId,
+                universalChainId: args.destinationChainId,
                 kind: "Erc20.Wrap",
               }),
             ),
@@ -849,7 +802,7 @@ export const makeViem = (
               Domain.PreparedRequest.PreparedEvm({
                 ...data,
                 contractAddress: Domain.Erc20Address(zAssetAddress),
-                universalChainId: args.universalChainId,
+                universalChainId: args.destinationChainId,
                 kind: "ZAsset.Transfer",
               }),
             ),
@@ -866,20 +819,19 @@ export const makeViem = (
     const prepareRedemption = Effect.fn("prepareRedemption")(function* (
       args: Client.WalletClient.Redeem,
     ) {
-      const zAssetAddr = yield* ZAssetRegistry.getZAsset(
-        8453n,
-        args.dstErc20Address,
-      ).pipe(
+      const zAssetAddress = yield* pipe(
+        ZAssetRegistry.getZAsset(args.universalChainId, args.dstErc20Address),
         Effect.mapError(
           (cause) =>
             new Error.SystemError({
-              method: "transferZAsset",
+              method: "prepareRedemption",
               module: "EvmWalletClient",
               reason: "InvalidData",
               cause,
             }),
         ),
       );
+
       return yield* pipe(
         validateFunctionData({
           abi: Abi.ZASSET_ABI,
@@ -897,17 +849,10 @@ export const makeViem = (
             args.unwrap ?? true,
           ],
         }),
-        // Effect.flatMap((data) =>
-        //   prepareTransactionRequest({
-        //     to: zAssetAddr,
-        //     data,
-        //     chain: wallet.chain,
-        //   }),
-        // ),
         Effect.map((data) =>
           Domain.PreparedRequest.PreparedEvm({
             ...data,
-            contractAddress: Domain.Erc20Address(zAssetAddr),
+            contractAddress: Domain.Erc20Address(zAssetAddress),
             universalChainId: args.universalChainId,
             kind: "ZAsset.Transfer",
           }),

package/src/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.55.1"
-    }
-  ]
-}