Merge branch 'main' into dark-pool

Author: olehmisar

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        node-version: [20]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run tests
+        # TODO(security): test all packages & apps (js, noir & rust)
+        run: cd packages/contracts && pnpm test

package.json

@@ -2,6 +2,7 @@
   "name": "@repo/monorepo",
   "type": "module",
   "private": true,
+  "packageManager": "pnpm@9.15.4",
   "devDependencies": {
     "prettier-plugin-svelte": "^3.2.7",
     "typescript": "^5.6.3"

packages/contracts/envConfig.ts

@@ -6,7 +6,10 @@ import { zPrivateKey } from "./shared/utils";
  * Parse env variables in a typesafe way.
  */
 const EnvConfigSchema = z.object({
-  DEPLOYER_PRIVATE_KEY: zPrivateKey(),
+  DEPLOYER_PRIVATE_KEY: zPrivateKey().default(
+    // random key
+    "0x845074c29c6487a92fa902e06" + "f1a1fe1ac0eb801fd6624b0a486e3c04a75721f",
+  ),
 });
 
 let envConfig: z.infer<typeof EnvConfigSchema>;

packages/contracts/noir/erc20/src/lib.nr

@@ -52,22 +52,17 @@ pub mod Token {
         from_secret_key: Field,
         from_note_inputs: common::Erc20NoteConsumptionInputs,
         to: common::WaAddress,
-        amount: common::U256,
+        amount: common::TokenAmount,
         to_randomness: Field,
         change_randomness: Field,
     ) {
         common::Erc20Note::sub_and_emit_change(
             context,
             [from_note_inputs],
-            common::TokenAmount { token: from_note_inputs.note.amount.token, amount },
+            amount,
             change_randomness,
             from_secret_key,
         );
-        common::Erc20Note {
-            owner: to,
-            amount: common::TokenAmount { token: from_note_inputs.note.amount.token, amount },
-            randomness: to_randomness,
-        }
-            .emit(context);
+        common::Erc20Note { owner: to, amount, randomness: to_randomness }.emit(context);
     }
 }

packages/contracts/noir/erc20_transfer/src/main.nr

@@ -5,7 +5,7 @@ fn main(
     from_note_inputs: erc20::Erc20NoteConsumptionInputs,
     // transfer params
     to: common::WaAddress,
-    amount: common::U256,
+    amount: common::TokenAmount,
     to_randomness: Field,
     // change
     change_randomness: Field,

packages/contracts/noir/lob_router/src/lib.nr

@@ -3,11 +3,11 @@ mod LobRouter {
         context: &mut common::Context,
         seller_secret_key: Field,
         seller_note: erc20::Erc20NoteConsumptionInputs,
-        seller_amount: common::U256,
+        seller_amount: common::TokenAmount,
         seller_randomness: Field,
         buyer_secret_key: Field,
         buyer_note: erc20::Erc20NoteConsumptionInputs,
-        buyer_amount: common::U256,
+        buyer_amount: common::TokenAmount,
         buyer_randomness: Field,
     ) {
         // TODO(security): orders must be signed by parties and the prices should match

packages/contracts/noir/lob_router_swap/src/main.nr

@@ -3,12 +3,12 @@ fn main(
     // seller
     seller_secret_key: Field,
     seller_note: erc20::Erc20NoteConsumptionInputs,
-    seller_amount: common::U256,
+    seller_amount: common::TokenAmount,
     seller_randomness: Field,
     // buyer
     buyer_secret_key: Field,
     buyer_note: erc20::Erc20NoteConsumptionInputs,
-    buyer_amount: common::U256,
+    buyer_amount: common::TokenAmount,
     buyer_randomness: Field,
 ) -> pub common::Result<4, 2> {
     let mut context = common::Context::from(tree_roots);

packages/contracts/package.json

@@ -2,9 +2,8 @@
   "name": "@repo/contracts",
   "private": true,
   "scripts": {
-    "compile": "hardhat compile --typecheck",
-    "test": "hardhat test --typecheck",
-    "test:no-typecheck": "hardhat test",
+    "compile": "hardhat compile",
+    "test": "hardhat test",
     "deploy": "pnpm hardhat deploy-and-export",
     "deploy:localhost": "rm -rf deployments/localhost && pnpm hardhat deploy-and-export --network localhost --gasprice 1gwei"
   },

packages/contracts/sdk/LobService.ts

@@ -9,7 +9,7 @@ import {
   type NoirAndBackend,
   type PoolErc20Service,
 } from "./RollupService.js";
-import { prove, toNoirU256 } from "./utils.js";
+import { prove } from "./utils.js";
 
 export class LobService {
   constructor(
@@ -24,10 +24,10 @@ export class LobService {
   async swap(params: {
     sellerSecretKey: string;
     sellerNote: Erc20Note;
-    sellerAmount: bigint;
+    sellerAmount: TokenAmount;
     buyerSecretKey: string;
     buyerNote: Erc20Note;
-    buyerAmount: bigint;
+    buyerAmount: TokenAmount;
   }) {
     const { Fr } = await import("@aztec/aztec.js");
 
@@ -37,34 +37,22 @@ export class LobService {
 
     const sellerChangeNote = await Erc20Note.from({
       owner: await CompleteWaAddress.fromSecretKey(params.sellerSecretKey),
-      amount: await TokenAmount.from({
-        token: params.sellerNote.amount.token,
-        amount: params.sellerNote.amount.amount - params.sellerAmount,
-      }),
+      amount: params.sellerNote.amount.sub(params.sellerAmount),
       randomness: sellerRandomness,
     });
     const buyerChangeNote = await Erc20Note.from({
       owner: await CompleteWaAddress.fromSecretKey(params.buyerSecretKey),
-      amount: await TokenAmount.from({
-        token: params.buyerNote.amount.token,
-        amount: params.buyerNote.amount.amount - params.buyerAmount,
-      }),
+      amount: params.buyerNote.amount.sub(params.buyerAmount),
       randomness: buyerRandomness,
     });
     const sellerSwapNote = await Erc20Note.from({
       owner: await CompleteWaAddress.fromSecretKey(params.sellerSecretKey),
-      amount: await TokenAmount.from({
-        token: params.buyerNote.amount.token,
-        amount: params.buyerAmount,
-      }),
+      amount: params.buyerAmount,
       randomness: sellerRandomness,
     });
     const buyerSwapNote = await Erc20Note.from({
       owner: await CompleteWaAddress.fromSecretKey(params.buyerSecretKey),
-      amount: await TokenAmount.from({
-        token: params.sellerNote.amount.token,
-        amount: params.sellerAmount,
-      }),
+      amount: params.sellerAmount,
       randomness: buyerRandomness,
     });
 
@@ -75,15 +63,15 @@ export class LobService {
         params.sellerSecretKey,
         params.sellerNote,
       ),
-      seller_amount: toNoirU256(params.sellerAmount),
+      seller_amount: await params.sellerAmount.toNoir(),
       seller_randomness: sellerRandomness,
 
       buyer_secret_key: params.buyerSecretKey,
       buyer_note: await this.poolErc20.toNoteConsumptionInputs(
         params.buyerSecretKey,
         params.buyerNote,
       ),
-      buyer_amount: toNoirU256(params.buyerAmount),
+      buyer_amount: await params.buyerAmount.toNoir(),
       buyer_randomness: buyerRandomness,
     };
     const { proof } = await prove("swap", swapCircuit, input);

packages/contracts/sdk/RollupService.ts

@@ -218,7 +218,7 @@ export class PoolErc20Service {
     secretKey: string;
     fromNote: Erc20Note;
     to: CompleteWaAddress;
-    amount: bigint;
+    amount: TokenAmount;
   }) {
     const { Fr } = await import("@aztec/aztec.js");
 
@@ -231,25 +231,19 @@ export class PoolErc20Service {
       from_note_inputs: await this.toNoteConsumptionInputs(secretKey, fromNote),
       from_secret_key: secretKey,
       to: { inner: to.address },
-      amount: toNoirU256(amount),
+      amount: await amount.toNoir(),
       to_randomness,
       change_randomness,
     };
     const changeNote = await Erc20Note.from({
       owner: fromNote.owner,
-      amount: await TokenAmount.from({
-        token: fromNote.amount.token,
-        amount: fromNote.amount.amount - amount,
-      }),
+      amount: fromNote.amount.sub(amount),
       randomness: change_randomness,
     });
     assert(changeNote.amount.amount >= 0n, "invalid change note");
     const toNote = await Erc20Note.from({
       owner: to,
-      amount: await TokenAmount.from({
-        token: fromNote.amount.token,
-        amount,
-      }),
+      amount,
       randomness: to_randomness,
     });
     // console.log("input\n", JSON.stringify(input));
@@ -498,6 +492,12 @@ export class TokenAmount {
       amount: toNoirU256(this.amount),
     };
   }
+
+  sub(other: TokenAmount): TokenAmount {
+    const result = this.amount - other.amount;
+    assert(result >= 0n, "TokenAmount.sub: underflow");
+    return new TokenAmount(this.token, result);
+  }
 }
 
 export type WaAddress = string;