Ⓜ️ Add Mina SDK

Author: KimlikDAO-bot

.github/workflows/test.yml

@@ -7,7 +7,7 @@ on:
     branches: ["main"]
 
 jobs:
-  check:
+  check_server_sdk:
     strategy:
       fail-fast: true
 
@@ -16,20 +16,41 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: true
-
       - uses: oven-sh/setup-bun@v1
-
       - name: Build server-js
         run: |
           bun i
           make server-js
-
       - name: Test server-js
         run: |
-          bun i
           make server-js/test
 
+  check_client_sdk:
+    strategy:
+      fail-fast: true
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: oven-sh/setup-bun@v1
       - name: Build client
         run: |
           bun i
           make client
+
+  check_mina_sdk:
+    strategy:
+      fail-fast: true
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+      - name:
+        run: |
+          npm ci
+          npm run test

lib

@@ -0,0 +1,40 @@
+import {
+  AccountUpdate,
+  MerkleTree,
+  Mina,
+  PrivateKey
+} from "o1js";
+import { HumanIDs } from "./HumanIDs";
+
+describe('HumanIDs', () => {
+  const deployerKey = PrivateKey.random();
+  const deployer = deployerKey.toPublicKey();
+  const senderKey = PrivateKey.random();
+  const sender = senderKey.toPublicKey();
+  const appKey = PrivateKey.random();
+  const appAddr = appKey.toPublicKey();
+  let app: HumanIDs;
+
+  beforeAll(() => HumanIDs.compile());
+
+  beforeEach(() => Mina.LocalBlockchain({ proofsEnabled: true })
+    .then((local) => {
+      Mina.setActiveInstance(local);
+      app = new HumanIDs(appAddr);
+      local.addAccount(deployer, "1000000000");
+    }));
+
+  it('should deploy the app', async () => {
+    const tree = new MerkleTree(128);
+
+    await Mina.transaction(deployer, async () => {
+      AccountUpdate.fundNewAccount(deployer);
+      return app.deploy()
+        .then(() => app.initRoot(tree.getRoot()));
+    }).then((txn) => txn.prove())
+      .then((txn) => txn.sign([deployerKey, appKey]).send())
+      .then((txn) => txn.wait());
+
+    console.log('Deployed HumanIDs contract at', app.address);
+  });
+});

mina/contracts/HumanIDs.test.ts

@@ -0,0 +1,35 @@
+import {
+  Field,
+  MerkleWitness,
+  SmartContract,
+  State,
+  method,
+  state,
+} from "o1js";
+
+class MerkleWitness128 extends MerkleWitness(128) { }
+
+class HumanIDs extends SmartContract {
+  @state(Field) treeRoot = State<Field>();
+
+  @method async initRoot(root: Field) {
+    this.treeRoot.set(root);
+  }
+
+  @method async addHumanID(
+    humanID: Field,
+    leafWitness: MerkleWitness128,
+  ) {
+    const currentTreeRoot = this.treeRoot.getAndRequireEquals();
+
+    // TODO(oemerfurkan): Validate that the witness path matches a prefix of the
+    // provided humanID
+
+    // humanId.sub(leafWitness.calculateIndex().mul(Field(2n ** 127n))).toBits(127);
+
+    currentTreeRoot.assertEquals(leafWitness.calculateRoot(Field(0)));
+    this.treeRoot.set(leafWitness.calculateRoot(Field(1)));
+  }
+}
+
+export { HumanIDs, MerkleWitness128 };

mina/contracts/HumanIDs.ts

@@ -0,0 +1,21 @@
+module.exports = (request, options) => {
+  return options.defaultResolver(request, {
+    ...options,
+    packageFilter: (pkg) => {
+      // When importing o1js, we specify the Node ESM import as Jest by default imports the web version
+      if (pkg.name === 'o1js') {
+        return {
+          ...pkg,
+          main: pkg.exports.node.import,
+        };
+      }
+      if (pkg.name === 'node-fetch') {
+        return { ...pkg, main: pkg.main };
+      }
+      return {
+        ...pkg,
+        main: pkg.module || pkg.main,
+      };
+    },
+  });
+};

mina/jest-resolver.cjs

@@ -0,0 +1,24 @@
+/** @type {import('@ts-jest/dist/types').InitialOptionsTsJest} */
+export default {
+  verbose: true,
+  preset: 'ts-jest/presets/default-esm',
+  testEnvironment: 'node',
+  globals: {
+    'ts-jest': {
+      useESM: true,
+    },
+  },
+  testTimeout: 1_000_000,
+  transform: {
+    '^.+\\.(t)s$': 'ts-jest',
+    '^.+\\.(j)s$': 'babel-jest',
+  },
+  resolver: '<rootDir>/jest-resolver.cjs',
+  transformIgnorePatterns: [
+    '<rootDir>/node_modules/(?!(tslib|o1js/node_modules/tslib))',
+  ],
+  modulePathIgnorePatterns: ['<rootDir>/build/'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.+)\\.js$': '$1',
+  },
+};

mina/jest.config.js

@@ -0,0 +1,13 @@
+{
+  "scripts": {
+    "build": "tsc",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
+  },
+  "dependencies": {
+    "@types/jest": "^29.5.12",
+    "o1js": "^1.1.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.5"
+  },
+  "type": "module"
+}

mina/package.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "es2022",
+    "lib": [
+      "dom",
+      "esnext"
+    ],
+    "outDir": "./build",
+    "rootDir": ".",
+    "strict": true,
+    "strictPropertyInitialization": false, // to enable generic constructors, e.g. on CircuitValue
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "allowJs": true,
+    "declaration": true,
+    "sourceMap": true,
+    "noFallthroughCasesInSwitch": true,
+    "allowSyntheticDefaultImports": true,
+    "useDefineForClassFields": false,
+  },
+  "include": [
+    "./contracts"
+  ],
+}