Skip to content

Commit

Permalink
impl: tests
Browse files Browse the repository at this point in the history
  • Loading branch information
berzanorg committed Jan 20, 2024
1 parent 862c209 commit 04777a3
Show file tree
Hide file tree
Showing 21 changed files with 620 additions and 410 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Tests

on:
push:
paths:
- "packages/**"
- "tests/**"
jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install Node
uses: actions/setup-node@v3
with:
node-version: 20
- name: Install PNPM
uses: pnpm/action-setup@v2
with:
version: 8
run_install: false
- name: Get PNPM store directory
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
- name: Setup PNPM cache
uses: actions/cache@v3
with:
path: ${{ env.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Install dependencies
run: pnpm install
- name: Build packages
run: pnpm build:packages
- name: Run tests
run: pnpm test
4 changes: 1 addition & 3 deletions client/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ if (!clientPrivateKey) {
}

if (!clientPort) {
throw Error(
"Set `XANE_CLIENT_PORT` environment variable before running Xane client.",
)
throw Error("Set `XANE_CLIENT_PORT` environment variable before running Xane client.")
}

const client = Client.create({
Expand Down
107 changes: 2 additions & 105 deletions client/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,110 +1,7 @@
{
"extends": "../tsconfig.base.json",
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

/* Modules */
"module": "ESNext" /* Specify what module code is generated. */,
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "Node" /* Specify how TypeScript looks up a file from a given module specifier. */,
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

/* Emit */
"declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "build" /* Specify an output folder for all emitted files. */,
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
"outDir": "build"
},
"include": ["src/**/*.ts"]
}
14 changes: 9 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@
"type": "module",
"license": "GPL-3.0-only",
"scripts": {
"lint": "eslint .",
"format": "prettier --write .",
"test": "node --test --import tsx/esm tests/src/*.test.ts",
"build:packages": "pnpm -r -F=./packages/** build",
"build:client": "pnpm -r -F=./client build",
"build:docs": "pnpm -r -F=./docs build",
"dev:docs": "pnpm -r -F=./docs dev"
"build:frontend": "pnpm -r -F=./frontend build",
"build:packages": "pnpm -r -F=./packages/** build",
"dev:docs": "pnpm -r -F=./docs dev",
"dev:frontend": "pnpm -r -F=./frontend dev",
"clean": "find . \\( -name '.pnpm-store' -o -name 'build' -o -name 'node_modules' \\) -type d -exec rm -rf {} +",
"format": "prettier --write .",
"lint": "eslint .",
"test": "pnpm -r -F=./tests test"
},
"keywords": [],
"packageManager": "pnpm@8.14.0",
Expand Down
4 changes: 2 additions & 2 deletions packages/xane/src/OrderStorage.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Field, MerkleTree, MerkleWitness } from "o1js"
import { RollupErrors } from "./RollupErrors"
import { OrderEntry } from "./OrderEntry"
import { RollupErrors } from "./RollupErrors.js"
import { OrderEntry } from "./OrderEntry.js"

/**
* Height of the merkle tree that stores order entries.
Expand Down
30 changes: 20 additions & 10 deletions packages/xane/src/RollupContract.ts
Original file line number Diff line number Diff line change
@@ -1,30 +1,40 @@
import { DeployArgs, Permissions, SmartContract, State, method, state } from "o1js"
import { RollupState } from "./RollupState"
import { RollupProof } from "./RollupProof"
import {
DeployArgs,
Field,
Permissions,
Poseidon,
SmartContract,
State,
method,
state,
} from "o1js"
import { RollupState } from "./RollupState.js"
import { RollupProof } from "./RollupProof.js"

/**
* The on-chain smart contract of the rollup that stores rollup state.
*/
export class RollupContract extends SmartContract {
@state(RollupState) rollupState = State<RollupState>()
@state(Field) rollupStateHash = State<Field>()

deploy(args?: DeployArgs) {
super.deploy(args)

this.account.permissions.set({
...Permissions.allImpossible(),
access: Permissions.proof(),
editState: Permissions.proof(),
send: Permissions.proof(),
receive: Permissions.proof(),
})
}

@method initState(stateHash: RollupState) {
this.rollupState.set(stateHash)
@method initStateHash(rollupState: RollupState) {
const hashOfRollupState = Poseidon.hash(rollupState.toFields())
this.rollupStateHash.set(hashOfRollupState)
}

@method updateState(proof: RollupProof) {
@method updateStateHash(proof: RollupProof) {
proof.verify()
this.rollupState.set(proof.publicInput)
const hashOfRollupState = Poseidon.hash(proof.publicInput.toFields())
this.rollupStateHash.set(hashOfRollupState)
}
}
17 changes: 12 additions & 5 deletions packages/xane/src/RollupProgram.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
import { Field, Poseidon, PublicKey, Signature, UInt64, ZkProgram } from "o1js"
import { PoolWitness } from "./StorageForPools"
import { LiqudityWitness } from "./StorageForLiquidities"
import { Balance, Liquidity, Pool } from "./Structs"
import { RollupState } from "./RollupState"
import { PoolWitness } from "./StorageForPools.js"
import { LiqudityWitness } from "./StorageForLiquidities.js"
import { Balance, Liquidity, Pool } from "./Structs.js"
import { RollupState } from "./RollupState.js"

/**
* The off-chain zk-program of the rollup that generates prooves.
*/
export const RollupProgram = ZkProgram({
name: "xane",
name: "xane-program",

publicInput: RollupState,

methods: {
doNothing: {
privateInputs: [PublicKey, Signature],
method(rollupState: RollupState, sender: PublicKey, signature: Signature) {
const message: Array<Field> = []
signature.verify(sender, message).assertTrue()
},
},
createPool: {
privateInputs: [
PublicKey,
Expand Down
2 changes: 1 addition & 1 deletion packages/xane/src/RollupProof.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ZkProgram } from "o1js"
import { RollupProgram } from "./RollupProgram"
import { RollupProgram } from "./RollupProgram.js"

/**
* The type of proofs `RollupProgram` generates.
Expand Down
10 changes: 5 additions & 5 deletions packages/xane/src/RollupStorage.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { StorageForBalances } from "./StorageForBalances"
import { StorageForLiquidities } from "./StorageForLiquidities"
import { StorageForPools } from "./StorageForPools"
import { RollupState } from "./RollupState"
import { Balance, Liquidity, Pool } from "./Structs"
import { StorageForBalances } from "./StorageForBalances.js"
import { StorageForLiquidities } from "./StorageForLiquidities.js"
import { StorageForPools } from "./StorageForPools.js"
import { RollupState } from "./RollupState.js"
import { Balance, Liquidity, Pool } from "./Structs.js"

/**
* Stores all the data of a rollup.
Expand Down
19 changes: 16 additions & 3 deletions packages/xane/src/StorageForBalances.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import { Field, MerkleTree, MerkleWitness, Poseidon, PublicKey } from "o1js"
import { RollupErrors } from "./RollupErrors"
import { Balance } from "./Structs"
import { RollupErrors } from "./RollupErrors.js"
import { Balance } from "./Structs.js"

// Change the type of `Error` to provide error messagees in a type-safe way.
declare function Error(msg: `${RollupErrors}`): Error

/**
* Height of the merkle tree that stores user balance entries.
*/
export const BALANCES_TREE_HEIGHT = 10
export const BALANCES_TREE_HEIGHT = 5

/**
* Merkle witness for the merkle tree that stores user balance entries.
Expand Down Expand Up @@ -87,6 +87,19 @@ export class StorageForBalances {
return new BalanceWitness(witness)
}

/**
* Returns the merkle witness for the next empty leaf.
*
* Uses the internal counter that stores the count of balance entries.
*/
public getWitnessNew(): BalanceWitness {
const index = this.getCounter()

const witness = this.innerTree.getWitness(BigInt(index))

return new BalanceWitness(witness)
}

/**
* Stores the given balance.
*
Expand Down
Loading

0 comments on commit 04777a3

Please sign in to comment.