adding docs at 0.19.0

noir-lang · Nov 23, 2023 · 16619c6 · 16619c6
1 parent 03ab6a2
commit 16619c6
Show file tree

Hide file tree

Showing 106 changed files with 7,052 additions and 0 deletions.
diff --git a/docs/docs/noir_js/reference/backend_barretenberg/.nojekyll b/docs/docs/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.
diff --git a/docs/docs/noir_js/reference/backend_barretenberg/classes/BarretenbergBackend.md b/docs/docs/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<void>
+```
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`Backend`](../interfaces/Backend.md).[`destroy`](../interfaces/Backend.md#destroy)
+
+#### Description
+
+Destroys the backend
+
+***
+
+### generateFinalProof()
+
+```ts
+generateFinalProof(decompressedWitness): Promise<ProofData>
+```
+
+#### 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<ProofData>
+```
+
+#### 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<object>
+```
+
+#### 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<boolean>
+```
+
+#### 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<boolean>
+```
+
+#### 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/docs/noir_js/reference/backend_barretenberg/index.md b/docs/docs/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/docs/noir_js/reference/backend_barretenberg/interfaces/Backend.md b/docs/docs/noir_js/reference/backend_barretenberg/interfaces/Backend.md
@@ -0,0 +1,132 @@
+# Backend
+
+## Methods
+
+### destroy()
+
+```ts
+destroy(): Promise<void>
+```
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Description
+
+Destroys the backend
+
+***
+
+### generateFinalProof()
+
+```ts
+generateFinalProof(decompressedWitness): Promise<ProofData>
+```
+
+#### 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<ProofData>
+```
+
+#### 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<object>
+```
+
+#### 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<boolean>
+```
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `proofData` | [`ProofData`](../type-aliases/ProofData.md) |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Description
+
+Verifies a final proof
+
+***
+
+### verifyIntermediateProof()
+
+```ts
+verifyIntermediateProof(proofData): Promise<boolean>
+```
+
+#### 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/docs/noir_js/reference/backend_barretenberg/type-aliases/BackendOptions.md b/docs/docs/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**<br /><br />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/docs/noir_js/reference/backend_barretenberg/type-aliases/CompiledCircuit.md b/docs/docs/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**<br /><br />ABI representation of the circuit |
+| `bytecode` | `string` | **Description**<br /><br />The bytecode of the circuit |
+
+***
+
+Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/)
Original file line number	Diff line number	Diff line change
		@@ -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.