From 0a19570653182f86c70c823d4f5f31b274d6824a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 7 Nov 2023 18:07:50 +0000 Subject: [PATCH] chore(docs): docs for v0.19.2 (#3457) Co-authored-by: signorecello Co-authored-by: Savio-Sou <72797635+Savio-Sou@users.noreply.github.com> --- .../noir_js/reference/01_noirjs.md | 147 --------- .../noir_js/reference/02_bb_backend.md | 272 ----------------- .../examples/merkle-proof.mdx | 0 .../getting_started/00_nargo_installation.md | 0 .../getting_started/01_hello_world.md | 0 .../getting_started/02_breakdown.md | 0 .../index.md | 0 .../language_concepts/01_functions.md | 0 .../language_concepts/02_control_flow.md | 0 .../language_concepts/03_ops.md | 0 .../language_concepts/04_assert.md | 0 .../language_concepts/05_unconstrained.md | 0 .../language_concepts/06_generics.md | 0 .../language_concepts/07_mutability.md | 0 .../language_concepts/08_lambdas.md | 0 .../language_concepts/09_comments.md | 0 .../language_concepts/10_distinct.md | 0 .../language_concepts/11_shadowing.md | 0 .../language_concepts/data_types.md | 0 .../language_concepts/data_types/00_fields.md | 0 .../data_types/01_integers.md | 0 .../data_types/02_booleans.md | 0 .../data_types/03_strings.md | 0 .../language_concepts/data_types/04_arrays.md | 0 .../data_types/05_slices.mdx | 0 .../data_types/06_vectors.mdx | 0 .../language_concepts/data_types/07_tuples.md | 0 .../data_types/08_structs.md | 0 .../data_types/09_references.md | 0 .../data_types/10_function_types.md | 0 .../migration_notes.md | 0 .../crates_and_packages.md | 0 .../modules_packages_crates/dependencies.md | 0 .../modules_packages_crates/modules.md | 0 .../modules_packages_crates/workspaces.md | 0 .../nargo/01_commands.md | 0 .../nargo/02_testing.md | 0 .../nargo/03_solidity_verifier.md | 0 .../nargo/04_language_server.md | 0 .../getting_started/01_tiny_noir_app.md | 0 .../noir_js/noir_js.md | 2 +- .../reference/backend_barretenberg/.nojekyll | 1 + .../classes/BarretenbergBackend.md | 185 +++++++++++ .../reference/backend_barretenberg/index.md | 27 ++ .../interfaces/Backend.md | 132 ++++++++ .../type-aliases/BackendOptions.md | 19 ++ .../type-aliases/CompiledCircuit.md | 20 ++ .../type-aliases/ProofData.md | 20 ++ .../backend_barretenberg/typedoc-sidebar.cjs | 4 + .../noir_js/reference/noir_js/.nojekyll | 1 + .../noir_js/reference/noir_js/classes/Noir.md | 131 ++++++++ .../reference/noir_js/functions/and.md | 22 ++ .../reference/noir_js/functions/blake2s256.md | 21 ++ .../functions/ecdsa_secp256k1_verify.md | 29 ++ .../functions/ecdsa_secp256r1_verify.md | 28 ++ .../reference/noir_js/functions/keccak256.md | 21 ++ .../reference/noir_js/functions/sha256.md | 21 ++ .../reference/noir_js/functions/xor.md | 22 ++ .../noir_js/reference/noir_js/index.md | 36 +++ .../noir_js/type-aliases/CompiledCircuit.md | 20 ++ .../type-aliases/ForeignCallHandler.md | 24 ++ .../noir_js/type-aliases/ForeignCallInput.md | 9 + .../noir_js/type-aliases/ForeignCallOutput.md | 9 + .../noir_js/type-aliases/ProofData.md | 20 ++ .../noir_js/type-aliases/WitnessMap.md | 9 + .../reference/noir_js/typedoc-sidebar.cjs | 4 + .../standard_library/black_box_fns.md | 0 .../cryptographic_primitives.md | 0 .../cryptographic_primitives/00_hashes.mdx | 0 .../cryptographic_primitives/01_scalar.mdx | 0 .../cryptographic_primitives/02_schnorr.mdx | 0 .../03_ecdsa_sig_verification.mdx | 0 .../04_ec_primitives.md | 0 .../cryptographic_primitives/05_eddsa.mdx | 0 .../standard_library/logging.md | 0 .../standard_library/merkle_trees.md | 0 .../standard_library/options.md | 0 .../standard_library/recursion.md | 0 .../standard_library/zeroed.md | 0 .../version-v0.19.0-sidebars.json | 141 --------- .../version-v0.19.2-sidebars.json | 288 ++++++++++++++++++ docs/versions.json | 1 + 82 files changed, 1125 insertions(+), 561 deletions(-) delete mode 100644 docs/versioned_docs/version-v0.19.0/noir_js/reference/01_noirjs.md delete mode 100644 docs/versioned_docs/version-v0.19.0/noir_js/reference/02_bb_backend.md rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/examples/merkle-proof.mdx (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/getting_started/00_nargo_installation.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/getting_started/01_hello_world.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/getting_started/02_breakdown.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/index.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/01_functions.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/02_control_flow.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/03_ops.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/04_assert.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/05_unconstrained.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/06_generics.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/07_mutability.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/08_lambdas.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/09_comments.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/10_distinct.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/11_shadowing.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/00_fields.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/01_integers.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/02_booleans.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/03_strings.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/04_arrays.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/05_slices.mdx (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/06_vectors.mdx (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/07_tuples.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/08_structs.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/09_references.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/language_concepts/data_types/10_function_types.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/migration_notes.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/modules_packages_crates/crates_and_packages.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/modules_packages_crates/dependencies.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/modules_packages_crates/modules.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/modules_packages_crates/workspaces.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/nargo/01_commands.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/nargo/02_testing.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/nargo/03_solidity_verifier.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/nargo/04_language_server.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/noir_js/getting_started/01_tiny_noir_app.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/noir_js/noir_js.md (94%) create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/.nojekyll create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/classes/BarretenbergBackend.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/index.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/interfaces/Backend.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/BackendOptions.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/CompiledCircuit.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/ProofData.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/typedoc-sidebar.cjs create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/.nojekyll create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/classes/Noir.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/and.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/blake2s256.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/ecdsa_secp256k1_verify.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/ecdsa_secp256r1_verify.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/keccak256.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/sha256.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/xor.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/index.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/CompiledCircuit.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallHandler.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallInput.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallOutput.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ProofData.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/WitnessMap.md create mode 100644 docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/typedoc-sidebar.cjs rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/black_box_fns.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/cryptographic_primitives.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/cryptographic_primitives/00_hashes.mdx (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/cryptographic_primitives/01_scalar.mdx (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/cryptographic_primitives/02_schnorr.mdx (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/cryptographic_primitives/03_ecdsa_sig_verification.mdx (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/cryptographic_primitives/04_ec_primitives.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/cryptographic_primitives/05_eddsa.mdx (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/logging.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/merkle_trees.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/options.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/recursion.md (100%) rename docs/versioned_docs/{version-v0.19.0 => version-v0.19.2}/standard_library/zeroed.md (100%) delete mode 100644 docs/versioned_sidebars/version-v0.19.0-sidebars.json create mode 100644 docs/versioned_sidebars/version-v0.19.2-sidebars.json diff --git a/docs/versioned_docs/version-v0.19.0/noir_js/reference/01_noirjs.md b/docs/versioned_docs/version-v0.19.0/noir_js/reference/01_noirjs.md deleted file mode 100644 index 0d6d5abbbff..00000000000 --- a/docs/versioned_docs/version-v0.19.0/noir_js/reference/01_noirjs.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: Noir -description: Reference to noir_js library and the Noir class -keywords: [Noir project, javascript, typescript, node.js, browser, react, class, reference] ---- - -## Table of Contents - -- [constructor](#constructor) -- [init](#init) -- [generateFinalProof](#generatefinalproof) -- [verifyFinalProof](#verifyfinalproof) - -## `constructor` - -The `constructor` is a method used to create and initialize objects created within the `Noir` class. In the `Noir` class constructor, you need to pass two parameters: `circuit` and `backend`. - -### Syntax - -```js -constructor(circuit, backend); -``` - -### Parameters - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `circuit` | Object | A circuit represented in a `json` format, containing the ABI and bytecode. Typically obtained by running [`nargo compile`](../../nargo/01_commands.md) | -| `backend` | Object | A backend instance, before initialization. | - -### Usage - -```js -const noir = new Noir(circuit, backend); -``` - -## `init` - -This async method should be called after class instantiation. It will run processes on the ACVM, instantiate your backend, etc. - -### Syntax - -```js -async init() -``` - -### Parameters - -This method takes no parameters - -### Usage - -```js -await noirInstance.init(); -``` - -## `execute` - -This async method allows to execute a circuit to get its witness and return value. [`generateFinalProof`](#generatefinalproof) calls it for you, but you can call it directly (i.e. to feed directly to a backend, or to get the return value). - -You can optionally provide a foreignCallHandler, to handle functions that should run outside of the prover (e.g. `std::println`) - -### Syntax - -```js -async execute(inputs, foreignCallHandler) -``` - -### Parameters - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------ | -| `inputs` | Object | An object containing the inputs to your circuit. | -| `foreignCallHandler` (optional) | Function | A function handling the foreign call from your circuit | - -### Returns - -| Return value | Type | Description | -| ------------ | --------------------- | --------------------------------------------------- | -| `witness` | Promise | The witness | -| `returnValue` | Promise | The return value | - -### Usage - -```js -const { witness, returnValue } = await noir.execute(inputs) -const { witness, returnValue } = await noir.execute(inputs, (name, args) => console.log(`Received foreign call ${name} with arguments ${args}`)) -``` - -## `generateFinalProof` - -This async method generates a witness and a proof given an object as input. - -### Syntax - -```js -async generateFinalproof(input) -``` - -### Parameters - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------ | -| `input` | Object | An object containing the inputs to your circuit. | - -### Returns - -| Return value | Type | Description | -| ------------ | --------------------- | --------------------------------------------------- | -| `proof` | Promise | An array with the byte representation of the proof. | - -### Usage - -```js -// consider the Standard Noir Example given with nargo init -const input = { x: 1, y: 2 }; -noirInstance.generateProof(input); -``` - -## `verifyFinalProof` - -This async method instantiates the verification key and verifies your proof. - -### Syntax - -```js -async verifyFinalProof(proof) -``` - -### Parameters - -| Parameter | Type | Description | -| --------- | ---------- | --------------------------------------------------------------------------------------------- | -| `proof` | Uint8Array | The Uint8Array representation of your proof, usually obtained by calling `generateFinalProof` | - -### Returns - -| Return value | Type | Description | -| ------------ | ------------------ | -------------------------------------------- | -| `verified` | Promise | A boolean for whether the proof was verified | - -### Usage - -```js -const proof = noirInstance.generateProof(input); -noirInstance.verifyFinalProof(proof); -``` diff --git a/docs/versioned_docs/version-v0.19.0/noir_js/reference/02_bb_backend.md b/docs/versioned_docs/version-v0.19.0/noir_js/reference/02_bb_backend.md deleted file mode 100644 index 21c2ff32b57..00000000000 --- a/docs/versioned_docs/version-v0.19.0/noir_js/reference/02_bb_backend.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -title: BarretenbergBackend -description: Reference documentation for the barretenberg_backend library and the BarretenbergBackend class -keywords: - [ - BarretenbergBackend, - Barretenberg, - javascript, - typescript, - node.js, - browser, - class, - reference, - noir_js, - ] ---- - -## Table of Contents - -- [constructor](#constructor) -- [generateFinalProof](#generatefinalproof) -- [generateIntermediateProof](#generateintermediateproof) -- [generateProof](#generateproof) -- [generateIntermediateProofArtifacts](#generateintermediateproofartifacts) -- [verifyFinalProof](#verifyfinalproof) -- [verifyIntermediateProof](#verifyintermediateproof) -- [verifyProof](#verifyproof) -- [destroy](#destroy) - -## `constructor` - -The `constructor` is a method used to create and initialize objects created within the `BarretenbergBackend` class. In this class, you should pass at least one argument for the `circuit`. - -### Syntax - -```js -constructor(acirCircuit, (numberOfThreads = 1)); -``` - -### Parameters - -| Parameter | Type | Description | -| ----------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `acirCircuit` | Object | A circuit represented in a `json` format, containing the ABI and bytecode Tipically obtained by running [`nargo compile`](../../nargo/01_commands.md). This is the same circuit expected to be passed to [the Noir class](01_noirjs.md) | -| `numberOfThreads` | Number (optional) | The number of threads to be used by the backend. Defaults to 1. | - -### Usage - -```js -const backend = new BarretenbergBackend(acirCircuit); -``` - -## `generateFinalProof` - -An async wrapper around the [generateProof](#generateproof) method that passes a `false` flag. Usually called by the Noir class. - -### Syntax - -```js -async generateFinalProof(decompressedWitness) -``` - -### Parameters - -| Parameter | Type | Description | -| --------------------- | ------ | -------------------------------------------------------- | -| `decompressedWitness` | Object | The decompressed witness for generating the final proof. | - -### Returns - -| Return value | Type | Description | -| ------------ | -------------------- | --------------------------------------------------------- | -| `proof` | Promise | An array with the byte representation of the final proof. | - -### Usage - -```js -const finalProof = await backend.generateFinalProof(decompressedWitness); -``` - -## `generateIntermediateProof` - -An async wrapper around the [generateProof](#generateproof) method that passes a `true` flag. It's not currently being used by the Noir class, but developers can call this method directly to use Noir's recursive features. - -### Syntax - -```js -async generateIntermediateProof(witness) -``` - -### Parameters - -| Parameter | Type | Description | -| --------- | ------ | -------------------------------------------------- | -| `witness` | Object | The witness for generating the intermediate proof. | - -### Returns - -| Return value | Type | Description | -| ------------ | -------------------- | --------------------------------------------------------------- | -| `proof` | Promise | An array with the byte representation of the intermediate proof | - -### Usage - -```js -const intermediateProof = await backend.generateIntermediateProof(witness); -``` - -## `generateProof` - -This async method generates a proof. Takes the witness generated by ACVM, and a boolean that evaluates to `true` when the proof _is_ meant to be verified in another circuit. Not currently used by the Noir class. - -### Syntax - -```js -async generateProof(decompressedWitness, makeEasyToVerifyInCircuit) -``` - -### Parameters - -| Parameter | Type | Description | -| --------------------------- | ------- | ---------------------------------------------------------------------------------------------- | -| `decompressedWitness` | Object | The decompressed witness for generating the proof. | -| `makeEasyToVerifyInCircuit` | Boolean | A flag indicating whether to generate proof components for easy verification within a circuit. | - -### Returns - -| Return value | Type | Description | -| ------------ | -------------------- | -------------------------------------------------- | -| `proof` | Promise | An array with the byte representation of the proof | - -### Usage - -```js -const proof = await backend.generateProof(decompressedWitness, makeEasyToVerifyInCircuit); -``` - -## `generateIntermediateProofArtifacts` - -This async method returns the artifacts needed to verify the intermediate proof in another circuit. It's not currently being used by the Noir class, but developers can call this method directly to use Noir's recursive features. - -### Syntax - -```js -async generateIntermediateProofArtifacts(proof, numOfPublicInputs = 0) -``` - -### Parameters - -| Parameter | Type | Description | -| ------------------- | ----------------- | ---------------------------------------------------------------- | -| `proof` | Object | The proof object. | -| `numOfPublicInputs` | Number (optional) | The number of public inputs in the inner proof, defaulting to 0. | - -### Returns - -| Return value | Type | Description | -| --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `proofAsFields` | string[] | An array of strings with the hexadecimal representation of the [Fields](../../language_concepts/data_types/00_fields.md) that make up a proof | -| `vkAsFields` | string[] | An array of strings with the hexadecimal representation of the [Fields](../../language_concepts/data_types/00_fields.md) that make up the verification key | -| `vkHash` | string | A pedersen hash of the verification key | - -### Usage - -```js -const artifacts = await backend.generateIntermediateProofArtifacts(proof, numOfPublicInputs); -``` - -## `verifyFinalProof` - -An async wrapper around [verifyProof](#verifyproof) that sets the `false` flag. Usually called by the Noir class. - -### Syntax - -```js -async verifyFinalProof(proof) -``` - -### Parameters - -| Parameter | Type | Description | -| --------- | ------ | --------------------------- | -| `proof` | Object | The proof object to verify. | - -### Returns - -| Return value | Type | Description | -| ------------ | ------------------ | -------------------------------------------- | -| `verified` | Promise | A boolean for whether the proof was verified | - -### Usage - -```js -const isValidFinal = await backend.verifyFinalProof(proof); -``` - -## `verifyIntermediateProof` - -An async wrapper around [verifyProof](#verifyproof) that sets the `true` flag. It's not currently being used by the Noir class, but developers can call this method directly to use Noir's recursive features. - -### Syntax - -```js -async verifyIntermediateProof(proof) -``` - -### Parameters - -| Parameter | Type | Description | -| --------- | ------ | ---------------------------------------- | -| `proof` | Object | The intermediate proof object to verify. | - -### Returns - -| Return value | Type | Description | -| ------------ | ------------------ | -------------------------------------------- | -| `verified` | Promise | A boolean for whether the proof was verified | - -### Usage - -```js -const isValidIntermediate = await backend.verifyIntermediateProof(proof); -``` - -## `verifyProof` - -This async method verifies a proof. Takes the proof, and a boolean that evaluates to `true` when the proof is intermediate. - -### Syntax - -```js -async verifyProof(proof, makeEasyToVerifyInCircuit) -``` - -### Parameters - -| Parameter | Type | Description | -| --------------------------- | ------- | ------------------------------------------------------------ | -| `proof` | Object | The proof object to verify | -| `makeEasyToVerifyInCircuit` | Boolean | A flag indicating whether the proof is intermediate or final | - -### Returns - -| Parameter | Type | Description | -| ---------- | ------------------ | -------------------------------------------- | -| `verified` | Promise\ | A boolean for whether the proof was verified | - -### Usage - -```js -const isValid = await backend.verifyProof(proof, makeEasyToVerifyInCircuit); -``` - -## `destroy` - -This method destroys the resources allocated in the [instantiate](#instantiate) method. Noir doesn't currently call this method, but it's highly recommended that developers do so in order to save resources. - -### Syntax - -```js -async destroy() -``` - -### Parameters - -This method takes no parameters. - -### Usage - -```js -await backend.destroy(); -``` diff --git a/docs/versioned_docs/version-v0.19.0/examples/merkle-proof.mdx b/docs/versioned_docs/version-v0.19.2/examples/merkle-proof.mdx similarity index 100% rename from docs/versioned_docs/version-v0.19.0/examples/merkle-proof.mdx rename to docs/versioned_docs/version-v0.19.2/examples/merkle-proof.mdx diff --git a/docs/versioned_docs/version-v0.19.0/getting_started/00_nargo_installation.md b/docs/versioned_docs/version-v0.19.2/getting_started/00_nargo_installation.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/getting_started/00_nargo_installation.md rename to docs/versioned_docs/version-v0.19.2/getting_started/00_nargo_installation.md diff --git a/docs/versioned_docs/version-v0.19.0/getting_started/01_hello_world.md b/docs/versioned_docs/version-v0.19.2/getting_started/01_hello_world.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/getting_started/01_hello_world.md rename to docs/versioned_docs/version-v0.19.2/getting_started/01_hello_world.md diff --git a/docs/versioned_docs/version-v0.19.0/getting_started/02_breakdown.md b/docs/versioned_docs/version-v0.19.2/getting_started/02_breakdown.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/getting_started/02_breakdown.md rename to docs/versioned_docs/version-v0.19.2/getting_started/02_breakdown.md diff --git a/docs/versioned_docs/version-v0.19.0/index.md b/docs/versioned_docs/version-v0.19.2/index.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/index.md rename to docs/versioned_docs/version-v0.19.2/index.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/01_functions.md b/docs/versioned_docs/version-v0.19.2/language_concepts/01_functions.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/01_functions.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/01_functions.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/02_control_flow.md b/docs/versioned_docs/version-v0.19.2/language_concepts/02_control_flow.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/02_control_flow.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/02_control_flow.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/03_ops.md b/docs/versioned_docs/version-v0.19.2/language_concepts/03_ops.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/03_ops.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/03_ops.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/04_assert.md b/docs/versioned_docs/version-v0.19.2/language_concepts/04_assert.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/04_assert.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/04_assert.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/05_unconstrained.md b/docs/versioned_docs/version-v0.19.2/language_concepts/05_unconstrained.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/05_unconstrained.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/05_unconstrained.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/06_generics.md b/docs/versioned_docs/version-v0.19.2/language_concepts/06_generics.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/06_generics.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/06_generics.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/07_mutability.md b/docs/versioned_docs/version-v0.19.2/language_concepts/07_mutability.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/07_mutability.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/07_mutability.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/08_lambdas.md b/docs/versioned_docs/version-v0.19.2/language_concepts/08_lambdas.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/08_lambdas.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/08_lambdas.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/09_comments.md b/docs/versioned_docs/version-v0.19.2/language_concepts/09_comments.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/09_comments.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/09_comments.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/10_distinct.md b/docs/versioned_docs/version-v0.19.2/language_concepts/10_distinct.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/10_distinct.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/10_distinct.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/11_shadowing.md b/docs/versioned_docs/version-v0.19.2/language_concepts/11_shadowing.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/11_shadowing.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/11_shadowing.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/00_fields.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/00_fields.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/00_fields.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/00_fields.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/01_integers.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/01_integers.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/01_integers.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/01_integers.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/02_booleans.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/02_booleans.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/02_booleans.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/02_booleans.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/03_strings.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/03_strings.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/03_strings.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/03_strings.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/04_arrays.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/04_arrays.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/04_arrays.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/04_arrays.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/05_slices.mdx b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/05_slices.mdx similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/05_slices.mdx rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/05_slices.mdx diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/06_vectors.mdx b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/06_vectors.mdx similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/06_vectors.mdx rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/06_vectors.mdx diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/07_tuples.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/07_tuples.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/07_tuples.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/07_tuples.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/08_structs.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/08_structs.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/08_structs.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/08_structs.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/09_references.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/09_references.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/09_references.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/09_references.md diff --git a/docs/versioned_docs/version-v0.19.0/language_concepts/data_types/10_function_types.md b/docs/versioned_docs/version-v0.19.2/language_concepts/data_types/10_function_types.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/language_concepts/data_types/10_function_types.md rename to docs/versioned_docs/version-v0.19.2/language_concepts/data_types/10_function_types.md diff --git a/docs/versioned_docs/version-v0.19.0/migration_notes.md b/docs/versioned_docs/version-v0.19.2/migration_notes.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/migration_notes.md rename to docs/versioned_docs/version-v0.19.2/migration_notes.md diff --git a/docs/versioned_docs/version-v0.19.0/modules_packages_crates/crates_and_packages.md b/docs/versioned_docs/version-v0.19.2/modules_packages_crates/crates_and_packages.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/modules_packages_crates/crates_and_packages.md rename to docs/versioned_docs/version-v0.19.2/modules_packages_crates/crates_and_packages.md diff --git a/docs/versioned_docs/version-v0.19.0/modules_packages_crates/dependencies.md b/docs/versioned_docs/version-v0.19.2/modules_packages_crates/dependencies.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/modules_packages_crates/dependencies.md rename to docs/versioned_docs/version-v0.19.2/modules_packages_crates/dependencies.md diff --git a/docs/versioned_docs/version-v0.19.0/modules_packages_crates/modules.md b/docs/versioned_docs/version-v0.19.2/modules_packages_crates/modules.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/modules_packages_crates/modules.md rename to docs/versioned_docs/version-v0.19.2/modules_packages_crates/modules.md diff --git a/docs/versioned_docs/version-v0.19.0/modules_packages_crates/workspaces.md b/docs/versioned_docs/version-v0.19.2/modules_packages_crates/workspaces.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/modules_packages_crates/workspaces.md rename to docs/versioned_docs/version-v0.19.2/modules_packages_crates/workspaces.md diff --git a/docs/versioned_docs/version-v0.19.0/nargo/01_commands.md b/docs/versioned_docs/version-v0.19.2/nargo/01_commands.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/nargo/01_commands.md rename to docs/versioned_docs/version-v0.19.2/nargo/01_commands.md diff --git a/docs/versioned_docs/version-v0.19.0/nargo/02_testing.md b/docs/versioned_docs/version-v0.19.2/nargo/02_testing.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/nargo/02_testing.md rename to docs/versioned_docs/version-v0.19.2/nargo/02_testing.md diff --git a/docs/versioned_docs/version-v0.19.0/nargo/03_solidity_verifier.md b/docs/versioned_docs/version-v0.19.2/nargo/03_solidity_verifier.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/nargo/03_solidity_verifier.md rename to docs/versioned_docs/version-v0.19.2/nargo/03_solidity_verifier.md diff --git a/docs/versioned_docs/version-v0.19.0/nargo/04_language_server.md b/docs/versioned_docs/version-v0.19.2/nargo/04_language_server.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/nargo/04_language_server.md rename to docs/versioned_docs/version-v0.19.2/nargo/04_language_server.md diff --git a/docs/versioned_docs/version-v0.19.0/noir_js/getting_started/01_tiny_noir_app.md b/docs/versioned_docs/version-v0.19.2/noir_js/getting_started/01_tiny_noir_app.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/noir_js/getting_started/01_tiny_noir_app.md rename to docs/versioned_docs/version-v0.19.2/noir_js/getting_started/01_tiny_noir_app.md diff --git a/docs/versioned_docs/version-v0.19.0/noir_js/noir_js.md b/docs/versioned_docs/version-v0.19.2/noir_js/noir_js.md similarity index 94% rename from docs/versioned_docs/version-v0.19.0/noir_js/noir_js.md rename to docs/versioned_docs/version-v0.19.2/noir_js/noir_js.md index 23ea550e156..f895b22eaf8 100644 --- a/docs/versioned_docs/version-v0.19.0/noir_js/noir_js.md +++ b/docs/versioned_docs/version-v0.19.2/noir_js/noir_js.md @@ -33,4 +33,4 @@ To install its JavaScript library, run this in your project: npm i @noir-lang/backend_barretenberg ``` -For more details on how to instantiate and use the libraries, refer to the [Full Noir App Guide](./getting_started/01_tiny_noir_app.md) and [Reference](./reference/01_noirjs.md) sections. +For more details on how to instantiate and use the libraries, refer to the [Full Noir App Guide](./getting_started/01_tiny_noir_app.md) and [Reference](./reference/noir_js/classes/Noir.md) sections. diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/.nojekyll b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/.nojekyll new file mode 100644 index 00000000000..e2ac6616add --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/classes/BarretenbergBackend.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/classes/BarretenbergBackend.md new file mode 100644 index 00000000000..5cbe9421b92 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/classes/BarretenbergBackend.md @@ -0,0 +1,185 @@ +# BarretenbergBackend + +## Implements + +- [`Backend`](../interfaces/Backend.md) + +## Constructors + +### new BarretenbergBackend(acirCircuit, options) + +```ts +new BarretenbergBackend(acirCircuit, options): BarretenbergBackend +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `acirCircuit` | [`CompiledCircuit`](../type-aliases/CompiledCircuit.md) | +| `options` | [`BackendOptions`](../type-aliases/BackendOptions.md) | + +#### Returns + +[`BarretenbergBackend`](BarretenbergBackend.md) + +## Methods + +### destroy() + +```ts +destroy(): Promise +``` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Backend`](../interfaces/Backend.md).[`destroy`](../interfaces/Backend.md#destroy) + +#### Description + +Destroys the backend + +*** + +### generateFinalProof() + +```ts +generateFinalProof(decompressedWitness): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `decompressedWitness` | `Uint8Array` | + +#### Returns + +`Promise`\<[`ProofData`](../type-aliases/ProofData.md)\> + +#### Implementation of + +[`Backend`](../interfaces/Backend.md).[`generateFinalProof`](../interfaces/Backend.md#generatefinalproof) + +#### Description + +Generates a final proof (not meant to be verified in another circuit) + +*** + +### generateIntermediateProof() + +```ts +generateIntermediateProof(witness): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `witness` | `Uint8Array` | + +#### Returns + +`Promise`\<[`ProofData`](../type-aliases/ProofData.md)\> + +#### Implementation of + +[`Backend`](../interfaces/Backend.md).[`generateIntermediateProof`](../interfaces/Backend.md#generateintermediateproof) + +#### Example + +```typescript +const intermediateProof = await backend.generateIntermediateProof(witness); +``` + +*** + +### generateIntermediateProofArtifacts() + +```ts +generateIntermediateProofArtifacts(proofData, numOfPublicInputs): Promise +``` + +#### Parameters + +| Parameter | Type | Default value | +| :------ | :------ | :------ | +| `proofData` | [`ProofData`](../type-aliases/ProofData.md) | `undefined` | +| `numOfPublicInputs` | `number` | `0` | + +#### Returns + +`Promise`\<`object`\> + +#### Implementation of + +[`Backend`](../interfaces/Backend.md).[`generateIntermediateProofArtifacts`](../interfaces/Backend.md#generateintermediateproofartifacts) + +#### Example + +```typescript +const artifacts = await backend.generateIntermediateProofArtifacts(proof, numOfPublicInputs); +``` + +*** + +### verifyFinalProof() + +```ts +verifyFinalProof(proofData): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `proofData` | [`ProofData`](../type-aliases/ProofData.md) | + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[`Backend`](../interfaces/Backend.md).[`verifyFinalProof`](../interfaces/Backend.md#verifyfinalproof) + +#### Description + +Verifies a final proof + +*** + +### verifyIntermediateProof() + +```ts +verifyIntermediateProof(proofData): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `proofData` | [`ProofData`](../type-aliases/ProofData.md) | + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[`Backend`](../interfaces/Backend.md).[`verifyIntermediateProof`](../interfaces/Backend.md#verifyintermediateproof) + +#### Example + +```typescript +const isValidIntermediate = await backend.verifyIntermediateProof(proof); +``` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/index.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/index.md new file mode 100644 index 00000000000..3680ba3ca77 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/index.md @@ -0,0 +1,27 @@ +# Backend Barretenberg + +## Exports + +### Classes + +| Class | Description | +| :------ | :------ | +| [BarretenbergBackend](classes/BarretenbergBackend.md) | - | + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [Backend](interfaces/Backend.md) | - | + +### Type Aliases + +| Type alias | Description | +| :------ | :------ | +| [BackendOptions](type-aliases/BackendOptions.md) | - | +| [CompiledCircuit](type-aliases/CompiledCircuit.md) | - | +| [ProofData](type-aliases/ProofData.md) | - | + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/interfaces/Backend.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/interfaces/Backend.md new file mode 100644 index 00000000000..3eb9645c8d2 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/interfaces/Backend.md @@ -0,0 +1,132 @@ +# Backend + +## Methods + +### destroy() + +```ts +destroy(): Promise +``` + +#### Returns + +`Promise`\<`void`\> + +#### Description + +Destroys the backend + +*** + +### generateFinalProof() + +```ts +generateFinalProof(decompressedWitness): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `decompressedWitness` | `Uint8Array` | + +#### Returns + +`Promise`\<[`ProofData`](../type-aliases/ProofData.md)\> + +#### Description + +Generates a final proof (not meant to be verified in another circuit) + +*** + +### generateIntermediateProof() + +```ts +generateIntermediateProof(decompressedWitness): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `decompressedWitness` | `Uint8Array` | + +#### Returns + +`Promise`\<[`ProofData`](../type-aliases/ProofData.md)\> + +#### Description + +Generates an intermediate proof (meant to be verified in another circuit) + +*** + +### generateIntermediateProofArtifacts() + +```ts +generateIntermediateProofArtifacts(proofData, numOfPublicInputs): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `proofData` | [`ProofData`](../type-aliases/ProofData.md) | +| `numOfPublicInputs` | `number` | + +#### Returns + +`Promise`\<`object`\> + +#### Description + +Retrieves the artifacts from a proof in the Field format + +*** + +### verifyFinalProof() + +```ts +verifyFinalProof(proofData): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `proofData` | [`ProofData`](../type-aliases/ProofData.md) | + +#### Returns + +`Promise`\<`boolean`\> + +#### Description + +Verifies a final proof + +*** + +### verifyIntermediateProof() + +```ts +verifyIntermediateProof(proofData): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `proofData` | [`ProofData`](../type-aliases/ProofData.md) | + +#### Returns + +`Promise`\<`boolean`\> + +#### Description + +Verifies an intermediate proof + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/BackendOptions.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/BackendOptions.md new file mode 100644 index 00000000000..266ade75d17 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/BackendOptions.md @@ -0,0 +1,19 @@ +# BackendOptions + +```ts +type BackendOptions: object; +``` + +## Description + +An options object, currently only used to specify the number of threads to use. + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `threads` | `number` | **Description**

Number of threads | + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/CompiledCircuit.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/CompiledCircuit.md new file mode 100644 index 00000000000..34e0dd04205 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/CompiledCircuit.md @@ -0,0 +1,20 @@ +# CompiledCircuit + +```ts +type CompiledCircuit: object; +``` + +## Description + +The representation of a compiled circuit + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `abi` | `Abi` | **Description**

ABI representation of the circuit | +| `bytecode` | `string` | **Description**

The bytecode of the circuit | + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/ProofData.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/ProofData.md new file mode 100644 index 00000000000..4aeff73d3e4 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/type-aliases/ProofData.md @@ -0,0 +1,20 @@ +# ProofData + +```ts +type ProofData: object; +``` + +## Description + +The representation of a proof + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `proof` | `Uint8Array` | **Description**

An byte array representing the proof | +| `publicInputs` | `Uint8Array`[] | **Description**

Public inputs of a proof | + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/typedoc-sidebar.cjs b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/typedoc-sidebar.cjs new file mode 100644 index 00000000000..04e662c845f --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/backend_barretenberg/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Classes","items":[{"type":"doc","id":"noir_js/reference/backend_barretenberg/classes/BarretenbergBackend","label":"BarretenbergBackend"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"noir_js/reference/backend_barretenberg/interfaces/Backend","label":"Backend"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"noir_js/reference/backend_barretenberg/type-aliases/BackendOptions","label":"BackendOptions"},{"type":"doc","id":"noir_js/reference/backend_barretenberg/type-aliases/CompiledCircuit","label":"CompiledCircuit"},{"type":"doc","id":"noir_js/reference/backend_barretenberg/type-aliases/ProofData","label":"ProofData"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/.nojekyll b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/.nojekyll new file mode 100644 index 00000000000..e2ac6616add --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/classes/Noir.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/classes/Noir.md new file mode 100644 index 00000000000..a8a0bb451c1 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/classes/Noir.md @@ -0,0 +1,131 @@ +# Noir + +## Constructors + +### new Noir(circuit, backend) + +```ts +new Noir(circuit, backend?): Noir +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `circuit` | [`CompiledCircuit`](../type-aliases/CompiledCircuit.md) | +| `backend`? | `Backend` | + +#### Returns + +[`Noir`](Noir.md) + +## Methods + +### destroy() + +```ts +destroy(): Promise +``` + +#### Returns + +`Promise`\<`void`\> + +#### Description + +Destroys the underlying backend instance. + +#### Example + +```typescript +await noir.destroy(); +``` + +*** + +### execute() + +```ts +execute(inputs, foreignCallHandler?): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `inputs` | `InputMap` | +| `foreignCallHandler`? | [`ForeignCallHandler`](../type-aliases/ForeignCallHandler.md) | + +#### Returns + +`Promise`\<`object`\> + +#### Description + +Allows to execute a circuit to get its witness and return value. + +#### Example + +```typescript +async execute(inputs) +``` + +*** + +### generateFinalProof() + +```ts +generateFinalProof(inputs): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `inputs` | `InputMap` | + +#### Returns + +`Promise`\<[`ProofData`](../type-aliases/ProofData.md)\> + +#### Description + +Generates a witness and a proof given an object as input. + +#### Example + +```typescript +async generateFinalproof(input) +``` + +*** + +### verifyFinalProof() + +```ts +verifyFinalProof(proofData): Promise +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `proofData` | [`ProofData`](../type-aliases/ProofData.md) | + +#### Returns + +`Promise`\<`boolean`\> + +#### Description + +Instantiates the verification key and verifies a proof. + +#### Example + +```typescript +async verifyFinalProof(proof) +``` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/and.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/and.md new file mode 100644 index 00000000000..c783283e396 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/and.md @@ -0,0 +1,22 @@ +# and() + +```ts +and(lhs, rhs): string +``` + +Performs a bitwise AND operation between `lhs` and `rhs` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `lhs` | `string` | | +| `rhs` | `string` | | + +## Returns + +`string` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/blake2s256.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/blake2s256.md new file mode 100644 index 00000000000..7882d0da8d5 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/blake2s256.md @@ -0,0 +1,21 @@ +# blake2s256() + +```ts +blake2s256(inputs): Uint8Array +``` + +Calculates the Blake2s256 hash of the input bytes + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `inputs` | `Uint8Array` | | + +## Returns + +`Uint8Array` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/ecdsa_secp256k1_verify.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/ecdsa_secp256k1_verify.md new file mode 100644 index 00000000000..0ba5783f0d5 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/ecdsa_secp256k1_verify.md @@ -0,0 +1,29 @@ +# ecdsa\_secp256k1\_verify() + +```ts +ecdsa_secp256k1_verify( + hashed_msg, + public_key_x_bytes, + public_key_y_bytes, + signature): boolean +``` + +Calculates the Blake2s256 hash of the input bytes and represents these as a single field element. +Verifies a ECDSA signature over the secp256k1 curve. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `hashed_msg` | `Uint8Array` | | +| `public_key_x_bytes` | `Uint8Array` | | +| `public_key_y_bytes` | `Uint8Array` | | +| `signature` | `Uint8Array` | | + +## Returns + +`boolean` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/ecdsa_secp256r1_verify.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/ecdsa_secp256r1_verify.md new file mode 100644 index 00000000000..0b20ff68957 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/ecdsa_secp256r1_verify.md @@ -0,0 +1,28 @@ +# ecdsa\_secp256r1\_verify() + +```ts +ecdsa_secp256r1_verify( + hashed_msg, + public_key_x_bytes, + public_key_y_bytes, + signature): boolean +``` + +Verifies a ECDSA signature over the secp256r1 curve. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `hashed_msg` | `Uint8Array` | | +| `public_key_x_bytes` | `Uint8Array` | | +| `public_key_y_bytes` | `Uint8Array` | | +| `signature` | `Uint8Array` | | + +## Returns + +`boolean` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/keccak256.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/keccak256.md new file mode 100644 index 00000000000..d10f155ce86 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/keccak256.md @@ -0,0 +1,21 @@ +# keccak256() + +```ts +keccak256(inputs): Uint8Array +``` + +Calculates the Keccak256 hash of the input bytes + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `inputs` | `Uint8Array` | | + +## Returns + +`Uint8Array` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/sha256.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/sha256.md new file mode 100644 index 00000000000..6ba4ecac022 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/sha256.md @@ -0,0 +1,21 @@ +# sha256() + +```ts +sha256(inputs): Uint8Array +``` + +Calculates the SHA256 hash of the input bytes + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `inputs` | `Uint8Array` | | + +## Returns + +`Uint8Array` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/xor.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/xor.md new file mode 100644 index 00000000000..8d762b895d3 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/functions/xor.md @@ -0,0 +1,22 @@ +# xor() + +```ts +xor(lhs, rhs): string +``` + +Performs a bitwise XOR operation between `lhs` and `rhs` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `lhs` | `string` | | +| `rhs` | `string` | | + +## Returns + +`string` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/index.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/index.md new file mode 100644 index 00000000000..58902c17b99 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/index.md @@ -0,0 +1,36 @@ +# Noir JS + +## Exports + +### Classes + +| Class | Description | +| :------ | :------ | +| [Noir](classes/Noir.md) | - | + +### Type Aliases + +| Type alias | Description | +| :------ | :------ | +| [CompiledCircuit](type-aliases/CompiledCircuit.md) | - | +| [ForeignCallHandler](type-aliases/ForeignCallHandler.md) | A callback which performs an foreign call and returns the response. | +| [ForeignCallInput](type-aliases/ForeignCallInput.md) | - | +| [ForeignCallOutput](type-aliases/ForeignCallOutput.md) | - | +| [ProofData](type-aliases/ProofData.md) | - | +| [WitnessMap](type-aliases/WitnessMap.md) | - | + +### Functions + +| Function | Description | +| :------ | :------ | +| [and](functions/and.md) | Performs a bitwise AND operation between `lhs` and `rhs` | +| [blake2s256](functions/blake2s256.md) | Calculates the Blake2s256 hash of the input bytes | +| [ecdsa\_secp256k1\_verify](functions/ecdsa_secp256k1_verify.md) | Calculates the Blake2s256 hash of the input bytes and represents these as a single field element. | +| [ecdsa\_secp256r1\_verify](functions/ecdsa_secp256r1_verify.md) | Verifies a ECDSA signature over the secp256r1 curve. | +| [keccak256](functions/keccak256.md) | Calculates the Keccak256 hash of the input bytes | +| [sha256](functions/sha256.md) | Calculates the SHA256 hash of the input bytes | +| [xor](functions/xor.md) | Performs a bitwise XOR operation between `lhs` and `rhs` | + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/CompiledCircuit.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/CompiledCircuit.md new file mode 100644 index 00000000000..34e0dd04205 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/CompiledCircuit.md @@ -0,0 +1,20 @@ +# CompiledCircuit + +```ts +type CompiledCircuit: object; +``` + +## Description + +The representation of a compiled circuit + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `abi` | `Abi` | **Description**

ABI representation of the circuit | +| `bytecode` | `string` | **Description**

The bytecode of the circuit | + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallHandler.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallHandler.md new file mode 100644 index 00000000000..812b8b16481 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallHandler.md @@ -0,0 +1,24 @@ +# ForeignCallHandler + +```ts +type ForeignCallHandler: (name, inputs) => Promise; +``` + +A callback which performs an foreign call and returns the response. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | The identifier for the type of foreign call being performed. | +| `inputs` | [`ForeignCallInput`](ForeignCallInput.md)[] | An array of hex encoded inputs to the foreign call. | + +## Returns + +`Promise`\<[`ForeignCallOutput`](ForeignCallOutput.md)[]\> + +outputs - An array of hex encoded outputs containing the results of the foreign call. + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallInput.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallInput.md new file mode 100644 index 00000000000..dd95809186a --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallInput.md @@ -0,0 +1,9 @@ +# ForeignCallInput + +```ts +type ForeignCallInput: string[]; +``` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallOutput.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallOutput.md new file mode 100644 index 00000000000..b71fb78a946 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ForeignCallOutput.md @@ -0,0 +1,9 @@ +# ForeignCallOutput + +```ts +type ForeignCallOutput: string | string[]; +``` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ProofData.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ProofData.md new file mode 100644 index 00000000000..4aeff73d3e4 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/ProofData.md @@ -0,0 +1,20 @@ +# ProofData + +```ts +type ProofData: object; +``` + +## Description + +The representation of a proof + +## Type declaration + +| Member | Type | Description | +| :------ | :------ | :------ | +| `proof` | `Uint8Array` | **Description**

An byte array representing the proof | +| `publicInputs` | `Uint8Array`[] | **Description**

Public inputs of a proof | + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/WitnessMap.md b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/WitnessMap.md new file mode 100644 index 00000000000..258c46f9d0c --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/type-aliases/WitnessMap.md @@ -0,0 +1,9 @@ +# WitnessMap + +```ts +type WitnessMap: Map; +``` + +*** + +Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/) diff --git a/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/typedoc-sidebar.cjs b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/typedoc-sidebar.cjs new file mode 100644 index 00000000000..c18318850d0 --- /dev/null +++ b/docs/versioned_docs/version-v0.19.2/noir_js/reference/noir_js/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Classes","items":[{"type":"doc","id":"noir_js/reference/noir_js/classes/Noir","label":"Noir"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"noir_js/reference/noir_js/type-aliases/CompiledCircuit","label":"CompiledCircuit"},{"type":"doc","id":"noir_js/reference/noir_js/type-aliases/ForeignCallHandler","label":"ForeignCallHandler"},{"type":"doc","id":"noir_js/reference/noir_js/type-aliases/ForeignCallInput","label":"ForeignCallInput"},{"type":"doc","id":"noir_js/reference/noir_js/type-aliases/ForeignCallOutput","label":"ForeignCallOutput"},{"type":"doc","id":"noir_js/reference/noir_js/type-aliases/ProofData","label":"ProofData"},{"type":"doc","id":"noir_js/reference/noir_js/type-aliases/WitnessMap","label":"WitnessMap"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"noir_js/reference/noir_js/functions/and","label":"and"},{"type":"doc","id":"noir_js/reference/noir_js/functions/blake2s256","label":"blake2s256"},{"type":"doc","id":"noir_js/reference/noir_js/functions/ecdsa_secp256k1_verify","label":"ecdsa_secp256k1_verify"},{"type":"doc","id":"noir_js/reference/noir_js/functions/ecdsa_secp256r1_verify","label":"ecdsa_secp256r1_verify"},{"type":"doc","id":"noir_js/reference/noir_js/functions/keccak256","label":"keccak256"},{"type":"doc","id":"noir_js/reference/noir_js/functions/sha256","label":"sha256"},{"type":"doc","id":"noir_js/reference/noir_js/functions/xor","label":"xor"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/black_box_fns.md b/docs/versioned_docs/version-v0.19.2/standard_library/black_box_fns.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/black_box_fns.md rename to docs/versioned_docs/version-v0.19.2/standard_library/black_box_fns.md diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives.md b/docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives.md rename to docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives.md diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/00_hashes.mdx b/docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/00_hashes.mdx similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/00_hashes.mdx rename to docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/00_hashes.mdx diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/01_scalar.mdx b/docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/01_scalar.mdx similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/01_scalar.mdx rename to docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/01_scalar.mdx diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/02_schnorr.mdx b/docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/02_schnorr.mdx similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/02_schnorr.mdx rename to docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/02_schnorr.mdx diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/03_ecdsa_sig_verification.mdx b/docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/03_ecdsa_sig_verification.mdx similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/03_ecdsa_sig_verification.mdx rename to docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/03_ecdsa_sig_verification.mdx diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/04_ec_primitives.md b/docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/04_ec_primitives.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/04_ec_primitives.md rename to docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/04_ec_primitives.md diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/05_eddsa.mdx b/docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/05_eddsa.mdx similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/cryptographic_primitives/05_eddsa.mdx rename to docs/versioned_docs/version-v0.19.2/standard_library/cryptographic_primitives/05_eddsa.mdx diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/logging.md b/docs/versioned_docs/version-v0.19.2/standard_library/logging.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/logging.md rename to docs/versioned_docs/version-v0.19.2/standard_library/logging.md diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/merkle_trees.md b/docs/versioned_docs/version-v0.19.2/standard_library/merkle_trees.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/merkle_trees.md rename to docs/versioned_docs/version-v0.19.2/standard_library/merkle_trees.md diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/options.md b/docs/versioned_docs/version-v0.19.2/standard_library/options.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/options.md rename to docs/versioned_docs/version-v0.19.2/standard_library/options.md diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/recursion.md b/docs/versioned_docs/version-v0.19.2/standard_library/recursion.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/recursion.md rename to docs/versioned_docs/version-v0.19.2/standard_library/recursion.md diff --git a/docs/versioned_docs/version-v0.19.0/standard_library/zeroed.md b/docs/versioned_docs/version-v0.19.2/standard_library/zeroed.md similarity index 100% rename from docs/versioned_docs/version-v0.19.0/standard_library/zeroed.md rename to docs/versioned_docs/version-v0.19.2/standard_library/zeroed.md diff --git a/docs/versioned_sidebars/version-v0.19.0-sidebars.json b/docs/versioned_sidebars/version-v0.19.0-sidebars.json deleted file mode 100644 index a9ec39925d9..00000000000 --- a/docs/versioned_sidebars/version-v0.19.0-sidebars.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "sidebar": [ - { - "type": "doc", - "id": "index", - "label": "Noir" - }, - { - "type": "category", - "label": "Getting Started", - "items": [ - { - "type": "autogenerated", - "dirName": "getting_started" - } - ] - }, - { - "type": "category", - "label": "Examples", - "items": [ - { - "type": "autogenerated", - "dirName": "examples" - } - ] - }, - { - "type": "category", - "label": "Nargo", - "items": [ - { - "type": "autogenerated", - "dirName": "nargo" - } - ] - }, - { - "type": "category", - "label": "Language Concepts", - "items": [ - { - "type": "category", - "label": "Data Types", - "link": { - "type": "doc", - "id": "language_concepts/data_types" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "language_concepts/data_types" - } - ] - }, - "language_concepts/functions", - "language_concepts/control_flow", - "language_concepts/ops", - "language_concepts/assert", - "language_concepts/unconstrained", - "language_concepts/generics", - "language_concepts/mutability", - "language_concepts/lambdas", - "language_concepts/comments", - "language_concepts/distinct", - "language_concepts/shadowing" - ] - }, - { - "type": "category", - "label": "Noir Standard Library", - "items": [ - { - "type": "category", - "label": "Cryptographic Primitives", - "link": { - "type": "doc", - "id": "standard_library/cryptographic_primitives" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "standard_library/cryptographic_primitives" - } - ] - }, - "standard_library/recursion", - "standard_library/logging", - "standard_library/merkle_trees", - "standard_library/zeroed", - "standard_library/black_box_fns", - "standard_library/options" - ] - }, - { - "type": "category", - "label": "Modules, Packages and Crates", - "items": [ - { - "type": "autogenerated", - "dirName": "modules_packages_crates" - } - ] - }, - { - "type": "category", - "label": "NoirJS", - "link": { - "type": "doc", - "id": "noir_js/noir_js" - }, - "items": [ - { - "type": "category", - "label": "Guides", - "items": [ - { - "type": "autogenerated", - "dirName": "noir_js/getting_started" - } - ] - }, - { - "type": "category", - "label": "Reference", - "items": [ - { - "type": "autogenerated", - "dirName": "noir_js/reference" - } - ] - } - ] - }, - { - "type": "doc", - "id": "migration_notes", - "label": "Migration notes" - } - ] -} diff --git a/docs/versioned_sidebars/version-v0.19.2-sidebars.json b/docs/versioned_sidebars/version-v0.19.2-sidebars.json new file mode 100644 index 00000000000..6823055c5d3 --- /dev/null +++ b/docs/versioned_sidebars/version-v0.19.2-sidebars.json @@ -0,0 +1,288 @@ +{ + "sidebar": [ + { + "type": "doc", + "id": "index", + "label": "Noir" + }, + { + "type": "category", + "label": "Getting Started", + "items": [ + { + "type": "autogenerated", + "dirName": "getting_started" + } + ] + }, + { + "type": "category", + "label": "Examples", + "items": [ + { + "type": "autogenerated", + "dirName": "examples" + } + ] + }, + { + "type": "category", + "label": "Nargo", + "items": [ + { + "type": "autogenerated", + "dirName": "nargo" + } + ] + }, + { + "type": "category", + "label": "Language Concepts", + "items": [ + { + "type": "category", + "label": "Data Types", + "link": { + "type": "doc", + "id": "language_concepts/data_types" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "language_concepts/data_types" + } + ] + }, + "language_concepts/functions", + "language_concepts/control_flow", + "language_concepts/ops", + "language_concepts/assert", + "language_concepts/unconstrained", + "language_concepts/generics", + "language_concepts/mutability", + "language_concepts/lambdas", + "language_concepts/comments", + "language_concepts/distinct", + "language_concepts/shadowing" + ] + }, + { + "type": "category", + "label": "Noir Standard Library", + "items": [ + { + "type": "category", + "label": "Cryptographic Primitives", + "link": { + "type": "doc", + "id": "standard_library/cryptographic_primitives" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "standard_library/cryptographic_primitives" + } + ] + }, + "standard_library/recursion", + "standard_library/logging", + "standard_library/merkle_trees", + "standard_library/zeroed", + "standard_library/black_box_fns", + "standard_library/options" + ] + }, + { + "type": "category", + "label": "Modules, Packages and Crates", + "items": [ + { + "type": "autogenerated", + "dirName": "modules_packages_crates" + } + ] + }, + { + "type": "category", + "label": "NoirJS", + "link": { + "type": "doc", + "id": "noir_js/noir_js" + }, + "items": [ + { + "type": "category", + "label": "Guides", + "items": [ + { + "type": "autogenerated", + "dirName": "noir_js/getting_started" + } + ] + }, + { + "type": "category", + "label": "Reference", + "items": [ + { + "type": "category", + "label": "Noir JS", + "link": { + "type": "doc", + "id": "noir_js/reference/noir_js/index" + }, + "items": [ + { + "type": "category", + "label": "Classes", + "items": [ + { + "type": "doc", + "id": "noir_js/reference/noir_js/classes/Noir", + "label": "Noir" + } + ] + }, + { + "type": "category", + "label": "Type Aliases", + "items": [ + { + "type": "doc", + "id": "noir_js/reference/noir_js/type-aliases/CompiledCircuit", + "label": "CompiledCircuit" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/type-aliases/ForeignCallHandler", + "label": "ForeignCallHandler" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/type-aliases/ForeignCallInput", + "label": "ForeignCallInput" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/type-aliases/ForeignCallOutput", + "label": "ForeignCallOutput" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/type-aliases/ProofData", + "label": "ProofData" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/type-aliases/WitnessMap", + "label": "WitnessMap" + } + ] + }, + { + "type": "category", + "label": "Functions", + "items": [ + { + "type": "doc", + "id": "noir_js/reference/noir_js/functions/and", + "label": "and" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/functions/blake2s256", + "label": "blake2s256" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/functions/ecdsa_secp256k1_verify", + "label": "ecdsa_secp256k1_verify" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/functions/ecdsa_secp256r1_verify", + "label": "ecdsa_secp256r1_verify" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/functions/keccak256", + "label": "keccak256" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/functions/sha256", + "label": "sha256" + }, + { + "type": "doc", + "id": "noir_js/reference/noir_js/functions/xor", + "label": "xor" + } + ] + } + ] + }, + { + "type": "category", + "label": "Backend Barretenberg", + "link": { + "type": "doc", + "id": "noir_js/reference/backend_barretenberg/index" + }, + "items": [ + { + "type": "category", + "label": "Classes", + "items": [ + { + "type": "doc", + "id": "noir_js/reference/backend_barretenberg/classes/BarretenbergBackend", + "label": "BarretenbergBackend" + } + ] + }, + { + "type": "category", + "label": "Interfaces", + "items": [ + { + "type": "doc", + "id": "noir_js/reference/backend_barretenberg/interfaces/Backend", + "label": "Backend" + } + ] + }, + { + "type": "category", + "label": "Type Aliases", + "items": [ + { + "type": "doc", + "id": "noir_js/reference/backend_barretenberg/type-aliases/BackendOptions", + "label": "BackendOptions" + }, + { + "type": "doc", + "id": "noir_js/reference/backend_barretenberg/type-aliases/CompiledCircuit", + "label": "CompiledCircuit" + }, + { + "type": "doc", + "id": "noir_js/reference/backend_barretenberg/type-aliases/ProofData", + "label": "ProofData" + } + ] + } + ] + } + ] + } + ] + }, + { + "type": "doc", + "id": "migration_notes", + "label": "Migration notes" + } + ] +} diff --git a/docs/versions.json b/docs/versions.json index e1a95eeb06d..7e667390dbd 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,4 +1,5 @@ [ + "0.19.2", "0.17.0", "0.10.5" ] \ No newline at end of file