Non-fungible token unshielded

.github/CODEOWNERS

@@ -13,4 +13,4 @@
 
 # Global:
 
-* @OpenZeppelin/contracts-midnight-maintainers 
+* @OpenZeppelin/contracts-midnight-maintainers

README.md

@@ -31,6 +31,27 @@ Usage: compactc.bin <flag> ... <source-pathname> <target-directory-pathname>
 > - [turbo](https://turborepo.com/docs/getting-started/installation)
 > - [compact](https://docs.midnight.network/develop/tutorial/building/#midnight-compact-compiler)
 
+Make sure you have [nvm](https://github.com/nvm-sh/nvm) and [yarn](https://yarnpkg.com/getting-started/install) installed on your machine.
+
+Follow Midnight's [compact installation guide](https://docs.midnight.network/develop/tutorial/building/#midnight-compact-compiler) and confirm that `compactc` is in the `PATH` env variable.
+
+```bash
+$ compactc
+
+Compactc version: 0.23.0
+Usage: compactc.bin <flag> ... <source-pathname> <target-directory-pathname>
+       --help displays detailed usage information
+```
+
+## Set up the project
+
+> ### Requirements
+>
+> - [node](https://nodejs.org/)
+> - [yarn](https://yarnpkg.com/getting-started/install)
+> - [turbo](https://turborepo.com/docs/getting-started/installation)
+> - [compact](https://docs.midnight.network/develop/tutorial/building/#midnight-compact-compiler)
+
 Clone the repository:
 
 ```bash

SECURITY.md

@@ -4,4 +4,4 @@ Security vulnerabilities should be disclosed to the project maintainers by email
 
 ## Legal
 
-Blockchain is a nascent technology and carries a high level of risk and uncertainty. OpenZeppelin makes certain software available under open source licenses, which disclaim all warranties in relation to the project and which limits the liability of OpenZeppelin. Subject to any particular licensing terms, your use of the project is governed by the terms found at [www.openzeppelin.com/tos](https://www.openzeppelin.com/tos) (the "Terms"). As set out in the Terms, you are solely responsible for any use of the project and you assume all risks associated with any such use. This Security Policy in no way evidences or represents an ongoing duty by any contributor, including OpenZeppelin, to correct any issues or vulnerabilities or alert you to all or any of the risks of utilizing the project.
+Blockchain is a nascent technology and carries a high level of risk and uncertainty. OpenZeppelin makes certain software available under open source licenses, which disclaim all warranties in relation to the project and which limits the liability of OpenZeppelin. Subject to any particular licensing terms, your use of the project is governed by the terms found at [www.openzeppelin.com/tos](https://www.openzeppelin.com/tos) (the "Terms"). As set out in the Terms, you are solely responsible for any use of the project and you assume all risks associated with any such use. This Security Policy in no way evidences or represents an ongoing duty by any contributor, including OpenZeppelin, to correct any issues or vulnerabilities or alert you to all or any of the risks of utilizing the project.

biome.json

@@ -21,7 +21,9 @@
   "formatter": {
     "enabled": true,
     "indentStyle": "space",
-    "ignore": ["package.json"]
+    "ignore": [
+      "package.json"
+    ]
   },
   "organizeImports": {
     "enabled": true
@@ -87,4 +89,4 @@
       "indentStyle": "space"
     }
   }
-}
+}

compact/package.json

@@ -22,6 +22,9 @@
   "scripts": {
     "build": "tsc -p .",
     "types": "tsc -p tsconfig.json --noEmit",
+    "fmt-and-lint": "biome check . --changed",
+    "fmt-and-lint:fix": "biome check . --changed --fix",
+    "fmt-and-lint:ci": "biome ci --changed --no-errors-on-unmatched",
     "clean": "git clean -fXd"
   },
   "devDependencies": {

compact/tsconfig.json

@@ -1,25 +1,27 @@
 {
-    "compilerOptions": {
-        "outDir": "dist",
-        "rootDir": "src",
-        "declaration": true,
-        "lib": ["es2023"],
-        "module": "nodenext",
-        "target": "es2022",
-        "strict": true,
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "moduleResolution": "node16",
-        "sourceMap": true,
-        "rewriteRelativeImportExtensions": true,
-        "erasableSyntaxOnly": true,
-        "verbatimModuleSyntax": true
-    },
-    "include": [
-        "src/**/*"
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true,
+    "lib": [
+      "es2022"
     ],
-    "exclude": [
-        "node_modules",
-        "dist"
-    ]
-}
+    "module": "nodenext",
+    "target": "es2022",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "moduleResolution": "nodenext",
+    "sourceMap": true,
+    "rewriteRelativeImportExtensions": true,
+    "erasableSyntaxOnly": true,
+    "verbatimModuleSyntax": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

compact/turbo.json

@@ -1,12 +1,21 @@
 {
   "$schema": "https://turbo.build/schema.json",
-  "extends": ["//"],
+  "extends": [
+    "//"
+  ],
   "tasks": {
     "build": {
-      "outputs": ["dist/**"],
-      "inputs": ["src/**/*.ts", "tsconfig.json"],
-      "env": ["COMPACT_HOME"],
+      "outputs": [
+        "dist/**"
+      ],
+      "inputs": [
+        "src/**/*.ts",
+        "tsconfig.json"
+      ],
+      "env": [
+        "COMPACT_HOME"
+      ],
       "cache": true
     }
   }
-}
+}

contracts/fungibleToken/package.json

@@ -18,6 +18,9 @@
     "build": "compact-builder && tsc",
     "test": "vitest run",
     "types": "tsc -p tsconfig.json --noEmit",
+    "fmt-and-lint": "biome check . --changed",
+    "fmt-and-lint:fix": "biome check . --changed --fix",
+    "fmt-and-lint:ci": "biome ci --changed --no-errors-on-unmatched",
     "clean": "git clean -fXd"
   },
   "dependencies": {

contracts/fungibleToken/src/FungibleToken.compact

@@ -66,7 +66,6 @@ module FungibleToken {
   export sealed ledger _name: Opaque<"string">;
   export sealed ledger _symbol: Opaque<"string">;
   export sealed ledger _decimals: Uint<8>;
-
   /**
    * @description Initializes the contract by setting the name, symbol, and decimals.
    * @dev This MUST be called in the implementing contract's constructor. Failure to do so

contracts/fungibleToken/src/test/FungibleToken.test.ts

@@ -1,7 +1,7 @@
 import type { CoinPublicKey } from '@midnight-ntwrk/compact-runtime';
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
-import { FungibleTokenSimulator } from './simulators/FungibleTokenSimulator';
-import * as utils from './utils/address';
+import { FungibleTokenSimulator } from './simulators/FungibleTokenSimulator.js';
+import * as utils from './utils/address.js';
 
 // Metadata
 const EMPTY_STRING = '';

contracts/fungibleToken/src/test/simulators/FungibleTokenSimulator.ts

@@ -18,17 +18,16 @@ import {
 import {
   type FungibleTokenPrivateState,
   FungibleTokenWitnesses,
-} from '../../witnesses/FungibleTokenWitnesses';
-import type { IContractSimulator } from '../types/test';
+} from '../../witnesses/FungibleTokenWitnesses.js';
+import type { IContractSimulator } from '../types/test.js';
 
 /**
  * @description A simulator implementation of a FungibleToken contract for testing purposes.
  * @template P - The private state type, fixed to FungibleTokenPrivateState.
  * @template L - The ledger type, fixed to Contract.Ledger.
  */
 export class FungibleTokenSimulator
-  implements IContractSimulator<FungibleTokenPrivateState, Ledger>
-{
+  implements IContractSimulator<FungibleTokenPrivateState, Ledger> {
   /** @description The underlying contract instance managing contract logic. */
   readonly contract: MockFungibleToken<FungibleTokenPrivateState>;
 

contracts/fungibleToken/src/test/utils/test.ts

@@ -6,7 +6,7 @@ import {
   QueryContext,
   emptyZswapLocalState,
 } from '@midnight-ntwrk/compact-runtime';
-import type { IContractSimulator } from '../types/test';
+import type { IContractSimulator } from '../types/test.js';
 
 /**
  * Constructs a `CircuitContext` from the given state and sender information.

contracts/fungibleToken/tsconfig.json

@@ -1,13 +1,17 @@
 {
-  "include": ["src/**/*.ts"],
+  "include": [
+    "src/**/*.ts"
+  ],
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "dist",
     "declaration": true,
-    "lib": ["ESNext"],
+    "lib": [
+      "ES2022"
+    ],
     "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "node",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
     "allowJs": true,
     "forceConsistentCasingInFileNames": true,
     "noImplicitAny": true,
@@ -18,4 +22,4 @@
     "esModuleInterop": true,
     "skipLibCheck": true
   }
-}
+}

contracts/fungibleToken/turbo.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "dependsOn": ["^build", "compact"]
+    }
+  }
+}

contracts/nonFungibleToken/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@openzeppelin-midnight/non-fungible-token",
+  "private": true,
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "compact": "compact-compiler",
+    "build": "compact-builder && tsc",
+    "test": "vitest run",
+    "types": "tsc -p tsconfig.json --noEmit",
+    "fmt-and-lint": "biome check . --changed",
+    "fmt-and-lint:fix": "biome check . --changed --fix",
+    "fmt-and-lint:ci": "biome ci --changed --no-errors-on-unmatched",
+    "clean": "git clean -fXd"
+  },
+  "dependencies": {
+    "@openzeppelin-midnight/compact": "workspace:^"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@types/node": "22.14.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.2.2",
+    "vitest": "^3.1.3"
+  }
+}