From e7a7426d12e8bb594f23ab3abea7c8099ec1edda Mon Sep 17 00:00:00 2001 From: Florian Date: Thu, 11 May 2023 11:24:15 +0200 Subject: [PATCH 1/6] rename circuit to provable --- docs/zkapps/how-to-write-a-zkapp.mdx | 8 ++++---- .../tutorials/05-common-types-and-functions.mdx | 12 ++++++------ .../src/LedgerContract.ts | 4 ++-- .../zkapps/05-common-types-and-functions/src/main.ts | 6 +++--- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/zkapps/how-to-write-a-zkapp.mdx b/docs/zkapps/how-to-write-a-zkapp.mdx index dc53cd98c..30380d66b 100644 --- a/docs/zkapps/how-to-write-a-zkapp.mdx +++ b/docs/zkapps/how-to-write-a-zkapp.mdx @@ -150,10 +150,10 @@ if (foo) { } ``` -Instead, use SnarkyJS’ built-in `Circuit.if()` method, which is a ternary operator: +Instead, use SnarkyJS’ built-in `Provable.if()` method, which is a ternary operator: ```ts -const x = Circuit.if(new Bool(foo), a, b); // behaves like `foo ? a : b` +const x = Provable.if(new Bool(foo), a, b); // behaves like `foo ? a : b` ``` ##### Functions @@ -277,7 +277,7 @@ Under the hood, every `@method` defines a zk-SNARK circuit. From the cryptograph ::: - + :::tip @@ -293,7 +293,7 @@ Therefore, when executing your code and trying to read the value of `x` to turn This is why we have a special function for logging stuff from inside your method: ```ts -Circuit.log(x); +Provable.log(x); ``` The API is like that of `console.log`, but it will automatically handle printing SnarkyJS data types in a nice format. During SmartContract compilation, it will simply do nothing. diff --git a/docs/zkapps/tutorials/05-common-types-and-functions.mdx b/docs/zkapps/tutorials/05-common-types-and-functions.mdx index 35dae3353..23702ddf5 100644 --- a/docs/zkapps/tutorials/05-common-types-and-functions.mdx +++ b/docs/zkapps/tutorials/05-common-types-and-functions.mdx @@ -194,10 +194,10 @@ points8 Fields: {"points":[{"x":"0","y":"0"},{"x":"1","y":"10"},{"x":"2","y":"20 There are two functions which help do control flow within SnarkyJS: -- [Circuit.if](../snarkyjs-reference/classes/Circuit#if) -- [Circuit.switch](../snarkyjs-reference/classes/Circuit#switch) +- [Provable.if](../snarkyjs-reference/classes/Provable#if) +- [Provable.switch](../snarkyjs-reference/classes/Provable#switch) -`Circuit.if` is similar to a ternary in JavaScript. `Circuit.switch` is similar to a switch case statement in JavaScript. +`Provable.if` is similar to a ternary in JavaScript. `Provable.switch` is similar to a switch case statement in JavaScript. With these, you can write conditionals inside SnarkyJS. @@ -209,7 +209,7 @@ const input2 = Int64.from(-15); const inputSum = input1.add(input2); -const inputSumAbs = Circuit.if( +const inputSumAbs = CiProvablercuit.if( inputSum.isPositive(), inputSum, inputSum.mul(Int64.minusOne) @@ -233,7 +233,7 @@ const input3largest = input3 .isPositive() .and(input3.sub(input2).isPositive()); -const largest = Circuit.switch( +const largest = Provable.switch( [input1largest, input2largest, input3largest], Int64, [input1, input2, input3] @@ -250,7 +250,7 @@ inputSumAbs: 5 largest: 22 ``` -Note that when using `Circuit.if`, like in a JS ternary, both branches are executed. Unlike normal programming, because SnarkyJS under the hood is creating a zk circuit, there is no primitive for if statements where only one branch is executed. +Note that when using `Provable.if`, like in a JS ternary, both branches are executed. Unlike normal programming, because SnarkyJS under the hood is creating a zk circuit, there is no primitive for if statements where only one branch is executed. ## Assertions and Constraints diff --git a/examples/zkapps/05-common-types-and-functions/src/LedgerContract.ts b/examples/zkapps/05-common-types-and-functions/src/LedgerContract.ts index c9b2e7853..c95f8b906 100644 --- a/examples/zkapps/05-common-types-and-functions/src/LedgerContract.ts +++ b/examples/zkapps/05-common-types-and-functions/src/LedgerContract.ts @@ -8,7 +8,7 @@ import { Poseidon, PublicKey, Signature, - Circuit, + Provable, } from 'snarkyjs'; class MerkleWitness20 extends MerkleWitness(20) {} @@ -59,7 +59,7 @@ export class LedgerContract extends SmartContract { const recipientAccountNew = rootSenderAfter.equals(rootRecipientBeforeEmpty); // check requirements on the recipient state before receiving - const recipientAccountPassesRequirements = Circuit.if( + const recipientAccountPassesRequirements = Provable.if( recipientAccountNew, (() => { // new account diff --git a/examples/zkapps/05-common-types-and-functions/src/main.ts b/examples/zkapps/05-common-types-and-functions/src/main.ts index d79ca6a15..4b4206a8c 100644 --- a/examples/zkapps/05-common-types-and-functions/src/main.ts +++ b/examples/zkapps/05-common-types-and-functions/src/main.ts @@ -11,7 +11,7 @@ import { Signature, Poseidon, Field, - Circuit, + Provable, MerkleWitness, MerkleTree, AccountUpdate, @@ -121,7 +121,7 @@ const input2 = Int64.from(-15); const inputSum = input1.add(input2); -const inputSumAbs = Circuit.if( +const inputSumAbs = Provable.if( inputSum.isPositive(), inputSum, inputSum.mul(Int64.minusOne) @@ -145,7 +145,7 @@ const input3largest = input3 .isPositive() .and(input3.sub(input2).isPositive()); -const largest = Circuit.switch( +const largest = Provable.switch( [input1largest, input2largest, input3largest], Int64, [input1, input2, input3] From cfb6d5bb140055eaee17cefd95ca062a024d8e0b Mon Sep 17 00:00:00 2001 From: github-actions Date: Mon, 22 May 2023 13:52:31 +0000 Subject: [PATCH 2/6] Build and publish new SnarkyJS API reference docs --- docs/zkapps/snarkyjs-reference/README.md | 191 +++++---- .../classes/AccountUpdate.md | 122 +++--- .../zkapps/snarkyjs-reference/classes/Bool.md | 68 ++-- .../snarkyjs-reference/classes/Character.md | 44 +-- .../snarkyjs-reference/classes/Circuit.md | 371 +++++------------- .../classes/CircuitString.md | 58 +-- .../classes/CircuitValue.md | 34 +- .../snarkyjs-reference/classes/Field.md | 120 +++--- .../snarkyjs-reference/classes/Group.md | 50 +-- .../snarkyjs-reference/classes/Int64.md | 70 ++-- .../snarkyjs-reference/classes/Keypair.md | 55 ++- .../snarkyjs-reference/classes/Ledger.md | 54 +-- .../snarkyjs-reference/classes/MerkleMap.md | 14 +- .../classes/MerkleMapWitness.md | 40 +- .../snarkyjs-reference/classes/MerkleTree.md | 24 +- .../snarkyjs-reference/classes/PrivateKey.md | 48 +-- .../snarkyjs-reference/classes/Proof.md | 26 +- .../snarkyjs-reference/classes/Scalar.md | 36 +- .../snarkyjs-reference/classes/SelfProof.md | 26 +- .../zkapps/snarkyjs-reference/classes/Sign.md | 50 +-- .../snarkyjs-reference/classes/Signature.md | 46 +-- .../classes/SmartContract.md | 80 ++-- .../snarkyjs-reference/classes/Token.md | 12 +- .../snarkyjs-reference/classes/TokenSymbol.md | 28 +- .../classes/Types.PublicKey.md | 56 +-- .../snarkyjs-reference/classes/UInt32.md | 98 ++--- .../snarkyjs-reference/classes/UInt64.md | 100 ++--- .../classes/VerificationKey.md | 24 +- .../interfaces/Mina.TransactionId.md | 6 +- .../interfaces/Permissions.md | 26 +- .../snarkyjs-reference/interfaces/Provable.md | 141 ------- .../interfaces/ProvablePure.md | 22 +- .../snarkyjs-reference/modules/Encryption.md | 4 +- .../modules/Experimental.md | 16 +- .../zkapps/snarkyjs-reference/modules/Mina.md | 66 ++-- sidebars.js | 5 - 36 files changed, 1005 insertions(+), 1226 deletions(-) delete mode 100644 docs/zkapps/snarkyjs-reference/interfaces/Provable.md diff --git a/docs/zkapps/snarkyjs-reference/README.md b/docs/zkapps/snarkyjs-reference/README.md index 22de79326..5f2d8d3e8 100644 --- a/docs/zkapps/snarkyjs-reference/README.md +++ b/docs/zkapps/snarkyjs-reference/README.md @@ -46,7 +46,6 @@ ### Interfaces - [Permissions](interfaces/Permissions.md) -- [Provable](interfaces/Provable.md) - [ProvablePure](interfaces/ProvablePure.md) ### Type Aliases @@ -57,6 +56,7 @@ - [FlexibleProvablePure](README.md#flexibleprovablepure) - [InferProvable](README.md#inferprovable) - [JsonProof](README.md#jsonproof) +- [Provable](README.md#provable) - [ProvableExtended](README.md#provableextended) - [Reducer](README.md#reducer) - [State](README.md#state) @@ -71,6 +71,7 @@ - [Empty](README.md#empty-1) - [Permissions](README.md#permissions) - [Poseidon](README.md#poseidon) +- [Provable](README.md#provable-1) - [TokenId](README.md#tokenid) - [Undefined](README.md#undefined-1) - [Void](README.md#void-1) @@ -97,7 +98,7 @@ - [matrixProp](README.md#matrixprop) - [method](README.md#method) - [prop](README.md#prop) -- [provable](README.md#provable) +- [provable](README.md#provable-2) - [provablePure](README.md#provablepure) - [public\_](README.md#public_) - [sendZkapp](README.md#sendzkapp) @@ -123,7 +124,7 @@ Re-exports [PublicKey](classes/Types.PublicKey.md) #### Defined in -[lib/zkapp.ts:1508](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1508) +[lib/zkapp.ts:1502](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1502) ___ @@ -133,15 +134,15 @@ ___ #### Defined in -[lib/proof_system.ts:80](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L80) +[lib/proof_system.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L73) -[lib/proof_system.ts:81](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L81) +[lib/proof_system.ts:74](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L74) ___ ### FlexibleProvable -Ƭ **FlexibleProvable**<`T`\>: [`Provable`](interfaces/Provable.md)<`T`\> \| [`Struct`](README.md#struct)<`T`\> +Ƭ **FlexibleProvable**<`T`\>: [`Provable`](README.md#provable-1)<`T`\> \| [`Struct`](README.md#struct)<`T`\> #### Type parameters @@ -151,7 +152,7 @@ ___ #### Defined in -[lib/circuit_value.ts:77](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L77) +[lib/circuit_value.ts:60](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L60) ___ @@ -167,13 +168,13 @@ ___ #### Defined in -[lib/circuit_value.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L78) +[lib/circuit_value.ts:61](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L61) ___ ### InferProvable -Ƭ **InferProvable**<`A`\>: `A` extends `Constructor` ? `A` extends [`Provable`](interfaces/Provable.md)<`U`\> ? `U` : `A` extends `Struct`<`U`\> ? `U` : `InferProvableBase`<`A`\> : `InferProvableBase`<`A`\> +Ƭ **InferProvable**<`A`\>: `A` extends `Constructor` ? `A` extends `Provable`<`U`\> ? `U` : `A` extends `Struct`<`U`\> ? `U` : `InferProvableBase`<`A`\> : `InferProvableBase`<`A`\> #### Type parameters @@ -202,13 +203,35 @@ ___ #### Defined in -[lib/proof_system.ts:187](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L187) +[lib/proof_system.ts:180](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L180) + +___ + +### Provable + +Ƭ **Provable**<`T`\>: `Provable_`<`T`\> + +`Provable` is the general circuit type interface. It describes how a type `T` is made up of field elements and auxiliary (non-field element) data. + +You will find this as the required input type in a few places in SnarkyJS. One convenient way to create a `Provable` is using `Struct`. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[lib/provable.ts:35](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L35) + +[lib/provable.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L37) ___ ### ProvableExtended -Ƭ **ProvableExtended**<`T`, `TJson`\>: [`Provable`](interfaces/Provable.md)<`T`\> & `ProvableExtension`<`T`, `TJson`\> +Ƭ **ProvableExtended**<`T`, `TJson`\>: [`Provable`](README.md#provable-1)<`T`\> & `ProvableExtension`<`T`, `TJson`\> #### Type parameters @@ -219,7 +242,7 @@ ___ #### Defined in -[lib/circuit_value.ts:67](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L67) +[lib/circuit_value.ts:50](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L50) ___ @@ -241,9 +264,9 @@ ___ #### Defined in -[lib/zkapp.ts:1236](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1236) +[lib/zkapp.ts:1230](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1230) -[lib/zkapp.ts:1580](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1580) +[lib/zkapp.ts:1574](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1574) ___ @@ -273,9 +296,9 @@ Gettable and settable state that can be checked for equality. #### Defined in -[lib/state.ts:73](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L73) +[lib/state.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L73) -[lib/state.ts:20](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L20) +[lib/state.ts:20](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L20) ___ @@ -291,9 +314,9 @@ ___ #### Defined in -[lib/circuit_value.ts:459](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L459) +[lib/circuit_value.ts:357](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L357) -[lib/circuit_value.ts:72](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L72) +[lib/circuit_value.ts:55](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L55) ___ @@ -309,7 +332,7 @@ UNKNOWN: The transaction has either been snarked, reached finality through conse #### Defined in -[lib/fetch.ts:650](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L650) +[lib/fetch.ts:650](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L650) ___ @@ -319,9 +342,9 @@ ___ #### Defined in -[lib/proof_system.ts:77](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L77) +[lib/proof_system.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L70) -[lib/proof_system.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L78) +[lib/proof_system.ts:71](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L71) ___ @@ -331,9 +354,9 @@ ___ #### Defined in -[lib/proof_system.ts:82](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L82) +[lib/proof_system.ts:75](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L75) -[lib/proof_system.ts:83](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L83) +[lib/proof_system.ts:76](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L76) ___ @@ -363,9 +386,9 @@ transaction. #### Defined in -[lib/account_update.ts:1935](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1935) +[lib/account_update.ts:1940](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1940) -[lib/account_update.ts:1939](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1939) +[lib/account_update.ts:1944](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1944) ## Variables @@ -375,9 +398,9 @@ transaction. #### Defined in -[lib/proof_system.ts:80](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L80) +[lib/proof_system.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L73) -[lib/proof_system.ts:81](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L81) +[lib/proof_system.ts:74](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L74) ___ @@ -403,9 +426,9 @@ ___ #### Defined in -[lib/account_update.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L163) +[lib/account_update.ts:163](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L163) -[lib/account_update.ts:235](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L235) +[lib/account_update.ts:235](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L235) ___ @@ -425,7 +448,37 @@ ___ #### Defined in -[lib/hash.ts:43](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L43) +[lib/hash.ts:39](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L39) + +___ + +### Provable + +• **Provable**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `Array` | (`elementType`: `A`, `length`: `number`) => `InferredProvable`<`A`[]\> | +| `asProver` | (`f`: () => `void`) => `void` | +| `assertEqual` | (`type`: [`FlexibleProvable`](README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => `void`(`x`: `T`, `y`: `T`) => `void` | +| `constraintSystem` | (`f`: () => `T`) => { `digest`: `string` ; `gates`: `Gate`[] ; `publicInputSize`: `number` ; `result`: `T` ; `rows`: `number` } | +| `equal` | (`type`: [`FlexibleProvable`](README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => [`Bool`](classes/Bool.md)(`x`: `T`, `y`: `T`) => [`Bool`](classes/Bool.md) | +| `if` | (`condition`: [`Bool`](classes/Bool.md), `type`: [`FlexibleProvable`](README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => `T`(`condition`: [`Bool`](classes/Bool.md), `x`: `T`, `y`: `T`) => `T` | +| `inCheckedComputation` | () => `boolean` | +| `inProver` | () => `boolean` | +| `log` | (...`args`: `any`) => `void` | +| `runAndCheck` | (`f`: () => `void`) => `void` | +| `runUnchecked` | (`f`: () => `void`) => `void` | +| `switch` | (`mask`: [`Bool`](classes/Bool.md)[], `type`: `A`, `values`: `T`[]) => `T` | +| `witness` | (`type`: `S`, `compute`: () => `T`) => `T` | + +#### Defined in + +[lib/provable.ts:35](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L35) + +[lib/provable.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L37) ___ @@ -453,7 +506,7 @@ ___ #### Defined in -[lib/account_update.ts:602](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L602) +[lib/account_update.ts:602](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L602) ___ @@ -463,9 +516,9 @@ ___ #### Defined in -[lib/proof_system.ts:77](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L77) +[lib/proof_system.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L70) -[lib/proof_system.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L78) +[lib/proof_system.ts:71](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L71) ___ @@ -475,9 +528,9 @@ ___ #### Defined in -[lib/proof_system.ts:82](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L82) +[lib/proof_system.ts:75](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L75) -[lib/proof_system.ts:83](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L83) +[lib/proof_system.ts:76](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L76) ___ @@ -487,9 +540,9 @@ ___ #### Defined in -[lib/account_update.ts:1935](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1935) +[lib/account_update.ts:1940](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1940) -[lib/account_update.ts:1939](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1939) +[lib/account_update.ts:1944](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1944) ___ @@ -503,7 +556,7 @@ ___ #### Defined in -[snarky.d.ts:1299](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1299) +[snarky.d.ts:1216](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1216) ## Functions @@ -524,7 +577,7 @@ ___ #### Defined in -[lib/zkapp.ts:1515](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1515) +[lib/zkapp.ts:1509](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1509) ___ @@ -548,7 +601,7 @@ A circuit-compatible Merkle Witness. #### Defined in -[lib/merkle_tree.ts:236](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L236) +[lib/merkle_tree.ts:236](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L236) ___ @@ -576,7 +629,7 @@ ___ #### Defined in -[lib/zkapp.ts:1580](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1580) +[lib/zkapp.ts:1574](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1574) ___ @@ -596,13 +649,13 @@ ___ #### Defined in -[lib/state.ts:73](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L73) +[lib/state.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L73) ___ ### Struct -▸ **Struct**<`A`, `T`, `J`, `Pure`\>(`type`, `options?`): (`value`: `T`) => `T` & { `_isStruct`: ``true`` } & `Pure` extends ``true`` ? [`ProvablePure`](interfaces/ProvablePure.md)<`T`\> : [`Provable`](interfaces/Provable.md)<`T`\> & { `fromJSON`: (`x`: `J`) => `T` ; `toInput`: (`x`: `T`) => { `fields?`: [`Field`](classes/Field.md)[] ; `packed?`: [[`Field`](classes/Field.md), `number`][] } ; `toJSON`: (`x`: `T`) => `J` } +▸ **Struct**<`A`, `T`, `J`, `Pure`\>(`type`, `options?`): (`value`: `T`) => `T` & { `_isStruct`: ``true`` } & `Pure` extends ``true`` ? [`ProvablePure`](interfaces/ProvablePure.md)<`T`\> : [`Provable`](README.md#provable-1)<`T`\> & { `fromJSON`: (`x`: `J`) => `T` ; `toInput`: (`x`: `T`) => { `fields?`: [`Field`](classes/Field.md)[] ; `packed?`: [[`Field`](classes/Field.md), `number`][] } ; `toJSON`: (`x`: `T`) => `J` } `Struct` lets you declare composite types for use in snarkyjs circuits. @@ -688,13 +741,13 @@ From the circuit point of view, it simply doesn't exist! #### Returns -(`value`: `T`) => `T` & { `_isStruct`: ``true`` } & `Pure` extends ``true`` ? [`ProvablePure`](interfaces/ProvablePure.md)<`T`\> : [`Provable`](interfaces/Provable.md)<`T`\> & { `fromJSON`: (`x`: `J`) => `T` ; `toInput`: (`x`: `T`) => { `fields?`: [`Field`](classes/Field.md)[] ; `packed?`: [[`Field`](classes/Field.md), `number`][] } ; `toJSON`: (`x`: `T`) => `J` } +(`value`: `T`) => `T` & { `_isStruct`: ``true`` } & `Pure` extends ``true`` ? [`ProvablePure`](interfaces/ProvablePure.md)<`T`\> : [`Provable`](README.md#provable-1)<`T`\> & { `fromJSON`: (`x`: `J`) => `T` ; `toInput`: (`x`: `T`) => { `fields?`: [`Field`](classes/Field.md)[] ; `packed?`: [[`Field`](classes/Field.md), `number`][] } ; `toJSON`: (`x`: `T`) => `J` } Class which you can extend #### Defined in -[lib/circuit_value.ts:459](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L459) +[lib/circuit_value.ts:357](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L357) ___ @@ -717,7 +770,7 @@ Adds an account to the local cache, indexed by a GraphQL endpoint. #### Defined in -[lib/fetch.ts:351](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L351) +[lib/fetch.ts:351](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L351) ___ @@ -757,7 +810,7 @@ ___ #### Defined in -[lib/circuit_value.ts:364](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L364) +[lib/circuit_value.ts:262](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L262) ___ @@ -777,7 +830,7 @@ ___ #### Defined in -[lib/fetch.ts:498](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L498) +[lib/fetch.ts:498](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L498) ___ @@ -789,7 +842,7 @@ ___ | Name | Type | | :------ | :------ | -| `target` | `any` | +| `target` | typeof [`Circuit`](classes/Circuit.md) | | `propertyName` | `string` | | `_descriptor?` | `PropertyDescriptor` | @@ -799,7 +852,7 @@ ___ #### Defined in -[lib/circuit.ts:272](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L272) +[lib/circuit.ts:219](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L219) ___ @@ -833,7 +886,7 @@ Note that a method of the same name must still be defined on the class, just wit | Name | Type | | :------ | :------ | | `SmartContract` | `T` | -| `methodArguments` | `Record`<`string`, [`Provable`](interfaces/Provable.md)<`unknown`\>[]\> | +| `methodArguments` | `Record`<`string`, [`Provable`](README.md#provable-1)<`unknown`\>[]\> | #### Returns @@ -841,7 +894,7 @@ Note that a method of the same name must still be defined on the class, just wit #### Defined in -[lib/zkapp.ts:1566](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1566) +[lib/zkapp.ts:1560](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1560) ___ @@ -901,7 +954,7 @@ declareState(MyContract, { x: Field }); #### Defined in -[lib/state.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L163) +[lib/state.ts:163](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L163) ___ @@ -935,7 +988,7 @@ zkapp information on the specified account or an error is thrown #### Defined in -[lib/fetch.ts:131](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L131) +[lib/fetch.ts:131](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L131) ___ @@ -977,7 +1030,7 @@ A promise that resolves to an array of objects containing event data, block info #### Defined in -[lib/fetch.ts:820](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L820) +[lib/fetch.ts:820](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L820) ___ @@ -999,7 +1052,7 @@ Fetches the last block on the Mina network. #### Defined in -[lib/fetch.ts:394](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L394) +[lib/fetch.ts:394](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L394) ___ @@ -1022,7 +1075,7 @@ Fetches the status of a transaction. #### Defined in -[lib/fetch.ts:625](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L625) +[lib/fetch.ts:625](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L625) ___ @@ -1063,7 +1116,7 @@ ___ #### Defined in -[lib/circuit_value.ts:373](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L373) +[lib/circuit_value.ts:271](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L271) ___ @@ -1100,7 +1153,7 @@ You can use inside your zkApp class as: #### Defined in -[lib/zkapp.ts:98](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L98) +[lib/zkapp.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L94) ___ @@ -1122,7 +1175,7 @@ ___ #### Defined in -[lib/circuit_value.ts:264](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L264) +[lib/circuit_value.ts:247](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L247) ___ @@ -1201,7 +1254,7 @@ ___ #### Defined in -[lib/circuit.ts:224](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L224) +[lib/circuit.ts:185](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L185) ___ @@ -1226,7 +1279,7 @@ Sends a zkApp command (transaction) to the specified GraphQL endpoint. #### Defined in -[lib/fetch.ts:655](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L655) +[lib/fetch.ts:655](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L655) ___ @@ -1248,7 +1301,7 @@ Sets up a GraphQL endpoint to be used for fetching information from an Archive N #### Defined in -[lib/fetch.ts:100](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L100) +[lib/fetch.ts:100](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L100) ___ @@ -1268,7 +1321,7 @@ ___ #### Defined in -[lib/fetch.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L78) +[lib/fetch.ts:78](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L78) ___ @@ -1288,7 +1341,7 @@ ___ #### Defined in -[lib/fetch.ts:71](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L71) +[lib/fetch.ts:71](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L71) ___ @@ -1306,7 +1359,7 @@ ___ #### Defined in -[snarky.d.ts:1294](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1294) +[snarky.d.ts:1211](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1211) ___ @@ -1328,7 +1381,7 @@ ___ #### Defined in -[lib/zkapp.ts:1523](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1523) +[lib/zkapp.ts:1517](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1517) ___ @@ -1376,7 +1429,7 @@ you can use the following in the declaration of your zkapp: #### Defined in -[lib/state.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L87) +[lib/state.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L87) ___ @@ -1397,4 +1450,4 @@ ___ #### Defined in -[lib/proof_system.ts:157](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L157) +[lib/proof_system.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L150) diff --git a/docs/zkapps/snarkyjs-reference/classes/AccountUpdate.md b/docs/zkapps/snarkyjs-reference/classes/AccountUpdate.md index 85c33c2e9..b7c533cc4 100644 --- a/docs/zkapps/snarkyjs-reference/classes/AccountUpdate.md +++ b/docs/zkapps/snarkyjs-reference/classes/AccountUpdate.md @@ -98,7 +98,7 @@ be authorized by either a [Signature](Signature.md) or [Proof](Proof.md). #### Defined in -[lib/account_update.ts:684](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L684) +[lib/account_update.ts:684](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L684) ## Properties @@ -108,7 +108,7 @@ be authorized by either a [Signature](Signature.md) or [Proof](Proof.md). #### Defined in -[lib/account_update.ts:665](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L665) +[lib/account_update.ts:665](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L665) ___ @@ -129,7 +129,7 @@ Types.AccountUpdate.authorization #### Defined in -[lib/account_update.ts:662](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L662) +[lib/account_update.ts:662](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L662) ___ @@ -143,7 +143,7 @@ Types.AccountUpdate.body #### Defined in -[lib/account_update.ts:661](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L661) +[lib/account_update.ts:661](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L661) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[lib/account_update.ts:668](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L668) +[lib/account_update.ts:668](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L668) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[lib/account_update.ts:667](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L667) +[lib/account_update.ts:667](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L667) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[lib/account_update.ts:655](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L655) +[lib/account_update.ts:655](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L655) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[lib/account_update.ts:680](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L680) +[lib/account_update.ts:680](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L680) ___ @@ -203,7 +203,7 @@ was created. Can be modified by applications to add richer information. #### Defined in -[lib/account_update.ts:660](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L660) +[lib/account_update.ts:660](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L660) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[lib/account_update.ts:663](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L663) +[lib/account_update.ts:663](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L663) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -[lib/account_update.ts:666](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L666) +[lib/account_update.ts:666](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L666) ___ @@ -233,7 +233,7 @@ ___ #### Defined in -[lib/account_update.ts:678](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L678) +[lib/account_update.ts:678](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L678) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[lib/account_update.ts:682](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L682) +[lib/account_update.ts:682](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L682) ___ @@ -306,7 +306,7 @@ StaticChildren(AnyChildren, StaticChildren(1)) #### Defined in -[lib/account_update.ts:1393](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1393) +[lib/account_update.ts:1398](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1398) ___ @@ -330,7 +330,7 @@ ___ #### Defined in -[lib/account_update.ts:1278](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1278) +[lib/account_update.ts:1283](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1283) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[lib/account_update.ts:1014](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1014) +[lib/account_update.ts:1019](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1019) ___ @@ -358,7 +358,7 @@ ___ #### Defined in -[lib/account_update.ts:1257](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1257) +[lib/account_update.ts:1262](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1262) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[lib/account_update.ts:1258](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1258) +[lib/account_update.ts:1263](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1263) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[lib/account_update.ts:1277](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1277) +[lib/account_update.ts:1282](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1282) ## Accessors @@ -425,7 +425,7 @@ ___ #### Defined in -[lib/account_update.ts:875](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L875) +[lib/account_update.ts:875](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L875) ___ @@ -439,7 +439,7 @@ ___ #### Defined in -[lib/account_update.ts:958](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L958) +[lib/account_update.ts:958](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L958) ___ @@ -453,7 +453,7 @@ ___ #### Defined in -[lib/account_update.ts:815](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L815) +[lib/account_update.ts:815](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L815) ___ @@ -475,7 +475,7 @@ use `this.account.tokenSymbol` #### Defined in -[lib/account_update.ts:822](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L822) +[lib/account_update.ts:822](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L822) ___ @@ -538,7 +538,7 @@ ___ #### Defined in -[lib/account_update.ts:890](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L890) +[lib/account_update.ts:890](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L890) ___ @@ -568,7 +568,7 @@ ___ #### Defined in -[lib/account_update.ts:1407](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1407) +[lib/account_update.ts:1412](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1412) ## Methods @@ -592,7 +592,7 @@ approves it. #### Defined in -[lib/account_update.ts:867](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L867) +[lib/account_update.ts:867](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L867) ___ @@ -606,7 +606,7 @@ ___ #### Defined in -[lib/account_update.ts:1074](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1074) +[lib/account_update.ts:1079](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1079) ___ @@ -620,7 +620,7 @@ ___ #### Defined in -[lib/account_update.ts:1103](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1103) +[lib/account_update.ts:1108](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1108) ___ @@ -648,7 +648,7 @@ be (can be) authorized by a signature. #### Defined in -[lib/account_update.ts:977](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L977) +[lib/account_update.ts:977](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L977) ___ @@ -670,7 +670,7 @@ ___ #### Defined in -[lib/account_update.ts:832](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L832) +[lib/account_update.ts:832](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L832) ___ @@ -694,7 +694,7 @@ ___ #### Defined in -[lib/account_update.ts:983](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L983) +[lib/account_update.ts:988](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L988) ___ @@ -708,7 +708,7 @@ ___ #### Defined in -[lib/account_update.ts:1063](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1063) +[lib/account_update.ts:1068](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1068) ___ @@ -725,7 +725,7 @@ default [AccountUpdate](AccountUpdate.md). #### Defined in -[lib/account_update.ts:1442](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1442) +[lib/account_update.ts:1447](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1447) ___ @@ -739,7 +739,7 @@ ___ #### Defined in -[lib/account_update.ts:1091](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1091) +[lib/account_update.ts:1096](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1096) ___ @@ -762,7 +762,7 @@ ___ #### Defined in -[lib/account_update.ts:721](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L721) +[lib/account_update.ts:721](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L721) ___ @@ -792,7 +792,7 @@ Constrain a property to lie between lower and upper bounds. #### Defined in -[lib/account_update.ts:918](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L918) +[lib/account_update.ts:918](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L918) ___ @@ -821,7 +821,7 @@ Fix a property to a certain value. #### Defined in -[lib/account_update.ts:945](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L945) +[lib/account_update.ts:945](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L945) ___ @@ -844,7 +844,7 @@ Attach account update to the current transaction #### Defined in -[lib/account_update.ts:1147](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1147) +[lib/account_update.ts:1152](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1152) ___ @@ -866,7 +866,7 @@ Clones the [AccountUpdate](AccountUpdate.md). #### Defined in -[lib/account_update.ts:702](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L702) +[lib/account_update.ts:702](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L702) ___ @@ -893,7 +893,7 @@ becomes part of the proof. #### Defined in -[lib/account_update.ts:1128](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1128) +[lib/account_update.ts:1133](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1133) ___ @@ -928,7 +928,7 @@ be (can be) authorized by a signature. #### Defined in -[lib/account_update.ts:1194](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1194) +[lib/account_update.ts:1199](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1199) ▸ `Static` **createSigned**(`signer`, `tokenId?`): [`AccountUpdate`](AccountUpdate.md) @@ -949,7 +949,7 @@ in favor of calling this function with a `PublicKey` as `signer` #### Defined in -[lib/account_update.ts:1198](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1198) +[lib/account_update.ts:1203](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1203) ___ @@ -970,7 +970,7 @@ ___ #### Defined in -[lib/account_update.ts:1097](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1097) +[lib/account_update.ts:1102](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1102) ___ @@ -991,7 +991,7 @@ ___ #### Defined in -[lib/account_update.ts:1107](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1107) +[lib/account_update.ts:1112](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1112) ___ @@ -1005,7 +1005,7 @@ ___ #### Defined in -[lib/account_update.ts:1100](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1100) +[lib/account_update.ts:1105](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1105) ___ @@ -1019,7 +1019,7 @@ ___ #### Defined in -[lib/account_update.ts:1116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1116) +[lib/account_update.ts:1121](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1121) ___ @@ -1040,7 +1040,7 @@ ___ #### Defined in -[lib/account_update.ts:1279](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1279) +[lib/account_update.ts:1284](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1284) ___ @@ -1060,7 +1060,7 @@ ___ #### Defined in -[lib/account_update.ts:1069](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1069) +[lib/account_update.ts:1074](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1074) ___ @@ -1089,7 +1089,7 @@ they [AccountUpdate](AccountUpdate.md) for the account which pays the fee #### Defined in -[lib/account_update.ts:1226](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1226) +[lib/account_update.ts:1231](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1231) ▸ `Static` **fundNewAccount**(`feePayer`, `options?`): [`AccountUpdate`](AccountUpdate.md) @@ -1115,7 +1115,7 @@ feePayerUpdate.send({ to: receiverAddress, amount: initialBalance }); #### Defined in -[lib/account_update.ts:1238](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1238) +[lib/account_update.ts:1243](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1243) ___ @@ -1135,7 +1135,7 @@ ___ #### Defined in -[lib/account_update.ts:1010](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1010) +[lib/account_update.ts:1015](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1015) ___ @@ -1160,7 +1160,7 @@ ___ #### Defined in -[lib/account_update.ts:1019](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1019) +[lib/account_update.ts:1024](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1024) ___ @@ -1185,7 +1185,7 @@ ___ #### Defined in -[lib/account_update.ts:1027](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1027) +[lib/account_update.ts:1032](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1032) ___ @@ -1212,7 +1212,7 @@ ___ #### Defined in -[lib/account_update.ts:894](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L894) +[lib/account_update.ts:894](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L894) ___ @@ -1233,7 +1233,7 @@ ___ #### Defined in -[lib/account_update.ts:1001](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1001) +[lib/account_update.ts:1006](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1006) ___ @@ -1253,7 +1253,7 @@ ___ #### Defined in -[lib/account_update.ts:1259](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1259) +[lib/account_update.ts:1264](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1264) ___ @@ -1273,7 +1273,7 @@ ___ #### Defined in -[lib/account_update.ts:1066](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1066) +[lib/account_update.ts:1071](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1071) ___ @@ -1295,7 +1295,7 @@ Disattach an account update from where it's currently located in the transaction #### Defined in -[lib/account_update.ts:1167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1167) +[lib/account_update.ts:1172](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1172) ___ @@ -1329,7 +1329,7 @@ ___ #### Defined in -[lib/account_update.ts:1287](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1287) +[lib/account_update.ts:1292](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1292) ___ @@ -1352,7 +1352,7 @@ ___ #### Defined in -[lib/account_update.ts:1303](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1303) +[lib/account_update.ts:1308](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1308) ___ @@ -1390,4 +1390,4 @@ accountUpdate's children, which also get witnessed #### Defined in -[lib/account_update.ts:1348](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1348) +[lib/account_update.ts:1353](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1353) diff --git a/docs/zkapps/snarkyjs-reference/classes/Bool.md b/docs/zkapps/snarkyjs-reference/classes/Bool.md index 8ade9afb6..14b7a86db 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Bool.md +++ b/docs/zkapps/snarkyjs-reference/classes/Bool.md @@ -59,7 +59,7 @@ #### Defined in -[snarky.d.ts:553](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L553) +[snarky.d.ts:632](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L632) ## Properties @@ -75,7 +75,7 @@ #### Defined in -[snarky.d.ts:643](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L643) +[snarky.d.ts:722](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L722) ## Methods @@ -98,7 +98,7 @@ this [Bool](Bool.md) and `y` are also true. #### Defined in -[snarky.d.ts:570](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L570) +[snarky.d.ts:649](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L649) ___ @@ -121,7 +121,7 @@ Proves that this [Bool](Bool.md) is equal to `y`. #### Defined in -[snarky.d.ts:583](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L583) +[snarky.d.ts:662](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L662) ___ @@ -143,7 +143,7 @@ Proves that this [Bool](Bool.md) is `false`. #### Defined in -[snarky.d.ts:593](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L593) +[snarky.d.ts:672](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L672) ___ @@ -165,7 +165,7 @@ Proves that this [Bool](Bool.md) is `true`. #### Defined in -[snarky.d.ts:588](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L588) +[snarky.d.ts:667](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L667) ___ @@ -187,7 +187,7 @@ Returns true if this [Bool](Bool.md) is equal to `y`. #### Defined in -[snarky.d.ts:599](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L599) +[snarky.d.ts:678](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L678) ___ @@ -203,7 +203,7 @@ a new [Bool](Bool.md) that is the negation of this [Bool](Bool.md). #### Defined in -[snarky.d.ts:563](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L563) +[snarky.d.ts:642](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L642) ___ @@ -226,7 +226,7 @@ this [Bool](Bool.md) or `y` is true. #### Defined in -[snarky.d.ts:577](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L577) +[snarky.d.ts:656](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L656) ___ @@ -242,7 +242,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:604](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L604) +[snarky.d.ts:683](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L683) ___ @@ -259,7 +259,7 @@ This can only be called on non-witness values. #### Defined in -[snarky.d.ts:626](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L626) +[snarky.d.ts:705](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L705) ___ @@ -275,7 +275,7 @@ Converts a [Bool](Bool.md) to a [Field](Field.md). `false` becomes 0 and `true` #### Defined in -[snarky.d.ts:558](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L558) +[snarky.d.ts:637](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L637) ___ @@ -291,7 +291,7 @@ Serializes this [Bool](Bool.md) into [Field](Field.md) elements. #### Defined in -[snarky.d.ts:609](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L609) +[snarky.d.ts:688](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L688) ___ @@ -308,7 +308,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:620](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L620) +[snarky.d.ts:699](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L699) ___ @@ -325,7 +325,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:615](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L615) +[snarky.d.ts:694](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L694) ___ @@ -348,7 +348,7 @@ Boolean AND operation. #### Defined in -[snarky.d.ts:661](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L661) +[snarky.d.ts:740](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L740) ___ @@ -371,7 +371,7 @@ Asserts if both [Bool](Bool.md) are equal. #### Defined in -[snarky.d.ts:671](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L671) +[snarky.d.ts:750](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L750) ___ @@ -391,7 +391,7 @@ ___ #### Defined in -[snarky.d.ts:713](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L713) +[snarky.d.ts:792](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L792) ___ @@ -413,7 +413,7 @@ Counts all elements of type [Bool](Bool.md). #### Defined in -[snarky.d.ts:681](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L681) +[snarky.d.ts:760](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L760) ___ @@ -436,7 +436,7 @@ Checks two [Bool](Bool.md) for equality. #### Defined in -[snarky.d.ts:676](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L676) +[snarky.d.ts:755](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L755) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[snarky.d.ts:718](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L718) +[snarky.d.ts:797](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L797) ___ @@ -478,7 +478,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:700](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L700) +[snarky.d.ts:779](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L779) ___ @@ -501,7 +501,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:711](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L711) +[snarky.d.ts:790](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L790) ___ @@ -523,7 +523,7 @@ Boolean negation. #### Defined in -[snarky.d.ts:656](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L656) +[snarky.d.ts:735](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L735) ___ @@ -546,7 +546,7 @@ Boolean OR operation. #### Defined in -[snarky.d.ts:666](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L666) +[snarky.d.ts:745](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L745) ___ @@ -567,7 +567,7 @@ ___ #### Defined in -[snarky.d.ts:719](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L719) +[snarky.d.ts:798](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L798) ___ @@ -581,7 +581,7 @@ ___ #### Defined in -[snarky.d.ts:723](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L723) +[snarky.d.ts:802](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L802) ___ @@ -597,7 +597,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:686](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L686) +[snarky.d.ts:765](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L765) ___ @@ -619,7 +619,7 @@ Static method to serialize a [Bool](Bool.md) into its auxiliary data. #### Defined in -[snarky.d.ts:696](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L696) +[snarky.d.ts:775](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L775) ___ @@ -639,7 +639,7 @@ ___ #### Defined in -[snarky.d.ts:717](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L717) +[snarky.d.ts:796](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L796) ___ @@ -661,7 +661,7 @@ Serializes a [Bool](Bool.md) into an array of [Field](Field.md) elements. #### Defined in -[snarky.d.ts:641](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L641) +[snarky.d.ts:720](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L720) ___ @@ -683,7 +683,7 @@ Static method to serialize a [Bool](Bool.md) into an array of [Field](Field.md) #### Defined in -[snarky.d.ts:691](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L691) +[snarky.d.ts:770](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L770) ___ @@ -707,7 +707,7 @@ ___ #### Defined in -[snarky.d.ts:716](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L716) +[snarky.d.ts:795](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L795) ___ @@ -730,4 +730,4 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:706](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L706) +[snarky.d.ts:785](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L785) diff --git a/docs/zkapps/snarkyjs-reference/classes/Character.md b/docs/zkapps/snarkyjs-reference/classes/Character.md index 6638c3c1e..9cf6ca2da 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Character.md +++ b/docs/zkapps/snarkyjs-reference/classes/Character.md @@ -61,7 +61,7 @@ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) ## Properties @@ -71,7 +71,7 @@ #### Defined in -[lib/string.ts:11](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L11) +[lib/string.ts:11](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L11) ## Methods @@ -95,7 +95,7 @@ #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[lib/string.ts:13](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L13) +[lib/string.ts:13](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L13) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[lib/string.ts:17](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L17) +[lib/string.ts:17](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L17) ___ @@ -201,7 +201,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -219,7 +219,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -233,7 +233,7 @@ ___ #### Defined in -[lib/string.ts:21](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L21) +[lib/string.ts:21](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L21) ___ @@ -257,7 +257,7 @@ ___ #### Defined in -[lib/string.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L33) +[lib/string.ts:33](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L33) ___ @@ -288,7 +288,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -319,7 +319,7 @@ ___ #### Defined in -[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) +[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) ___ @@ -350,7 +350,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -370,7 +370,7 @@ ___ #### Defined in -[lib/string.ts:26](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L26) +[lib/string.ts:26](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L26) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -437,7 +437,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -468,7 +468,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -499,7 +499,7 @@ ___ #### Defined in -[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) +[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) ___ @@ -530,4 +530,4 @@ ___ #### Defined in -[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) +[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) diff --git a/docs/zkapps/snarkyjs-reference/classes/Circuit.md b/docs/zkapps/snarkyjs-reference/classes/Circuit.md index 226df425a..fa0afc37d 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Circuit.md +++ b/docs/zkapps/snarkyjs-reference/classes/Circuit.md @@ -8,11 +8,11 @@ ### Properties +- [\_main](Circuit.md#_main) - [array](Circuit.md#array) - [asProver](Circuit.md#asprover) - [assertEqual](Circuit.md#assertequal) - [constraintSystem](Circuit.md#constraintsystem) -- [constraintSystemFromKeypair](Circuit.md#constraintsystemfromkeypair) - [equal](Circuit.md#equal) - [if](Circuit.md#if) - [inCheckedComputation](Circuit.md#incheckedcomputation) @@ -21,7 +21,6 @@ - [runAndCheck](Circuit.md#runandcheck) - [runUnchecked](Circuit.md#rununchecked) - [switch](Circuit.md#switch) -- [toFields](Circuit.md#tofields) - [witness](Circuit.md#witness) ### Methods @@ -38,21 +37,27 @@ ## Properties +### \_main + +▪ `Static` **\_main**: `CircuitData`<`any`, `any`\> + +#### Defined in + +[lib/circuit.ts:13](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L13) + +___ + ### array -▪ `Static` **array**: (`elementType`: `A`, `length`: `number`) => `InferredProvable`<`A`[]\> = `SnarkyCircuit.array` +▪ `Static` **array**: (`elementType`: `A`, `length`: `number`) => `InferredProvable`<`A`[]\> = `Provable.Array` #### Type declaration ▸ <`A`\>(`elementType`, `length`): `InferredProvable`<`A`[]\> -Creates a [Provable](../interfaces/Provable.md) for a generic array. - -**`Example`** +**`Deprecated`** -```ts -const ProvableArray = Circuit.array(Field, 5); -``` +use [Array](../README.md#array) ##### Type parameters @@ -73,27 +78,21 @@ const ProvableArray = Circuit.array(Field, 5); #### Defined in -[lib/circuit.ts:141](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L141) +[lib/circuit.ts:103](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L103) ___ ### asProver -▪ `Static` **asProver**: (`f`: () => `void`) => `void` = `SnarkyCircuit.asProver` +▪ `Static` **asProver**: (`f`: () => `void`) => `void` = `Provable.asProver` #### Type declaration ▸ (`f`): `void` -Runs code as a prover. +**`Deprecated`** -**`Example`** - -```ts -Circuit.asProver(() => { - // Your prover code here -}); -``` +use [asProver](../README.md#asprover) ##### Parameters @@ -107,28 +106,21 @@ Circuit.asProver(() => { #### Defined in -[lib/circuit.ts:93](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L93) +[lib/circuit.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L87) ___ ### assertEqual -▪ `Static` **assertEqual**: (`ctor`: { `toFields`: (`x`: `T`) => [`Field`](Field.md)[] }, `x`: `T`, `y`: `T`) => `void`(`x`: `T`, `y`: `T`) => `void` = `SnarkyCircuit.assertEqual` +▪ `Static` **assertEqual**: (`type`: [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => `void`(`x`: `T`, `y`: `T`) => `void` = `Provable.assertEqual` #### Type declaration -▸ <`T`\>(`ctor`, `x`, `y`): `void` - -Asserts that two values are equal. +▸ <`T`\>(`type`, `x`, `y`): `void` -**`Example`** +**`Deprecated`** -```ts -class MyStruct extends Struct({ a: Field, b: Bool }) {}; -const a: MyStruct = { a: Field(0), b: Bool(false) }; -const b: MyStruct = { a: Field(1), b: Bool(true) }; -Circuit.assertEqual(MyStruct, a, b); -``` +use [assertEqual](../README.md#assertequal) ##### Type parameters @@ -140,8 +132,7 @@ Circuit.assertEqual(MyStruct, a, b); | Name | Type | | :------ | :------ | -| `ctor` | `Object` | -| `ctor.toFields` | (`x`: `T`) => [`Field`](Field.md)[] | +| `type` | [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\> | | `x` | `T` | | `y` | `T` | @@ -151,22 +142,15 @@ Circuit.assertEqual(MyStruct, a, b); ▸ <`T`\>(`x`, `y`): `void` -Asserts that two values are equal. - -**`Example`** +**`Deprecated`** -```ts -class MyStruct extends Struct({ a: Field, b: Bool }) {}; -const a: MyStruct = { a: Field(0), b: Bool(false) }; -const b: MyStruct = { a: Field(1), b: Bool(true) }; -Circuit.assertEqual(MyStruct, a, b); -``` +use [assertEqual](../README.md#assertequal) ##### Type parameters -| Name | -| :------ | -| `T` | +| Name | Type | +| :------ | :------ | +| `T` | extends `ToFieldable` | ##### Parameters @@ -181,26 +165,21 @@ Circuit.assertEqual(MyStruct, a, b); #### Defined in -[lib/circuit.ts:152](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L152) +[lib/circuit.ts:107](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L107) ___ ### constraintSystem -▪ `Static` **constraintSystem**: (`f`: () => `T`) => { `digest`: `string` ; `gates`: `Gate`[] ; `publicInputSize`: `number` ; `result`: `T` ; `rows`: `number` } = `SnarkyCircuit.constraintSystem` +▪ `Static` **constraintSystem**: (`f`: () => `T`) => { `digest`: `string` ; `gates`: `Gate`[] ; `publicInputSize`: `number` ; `result`: `T` ; `rows`: `number` } = `Provable.constraintSystem` #### Type declaration ▸ <`T`\>(`f`): `Object` -Returns information about the constraint system in the callback function. - -**`Example`** +**`Deprecated`** -```ts -const result = Circuit.constraintSystem(circuit); -console.log(result); -``` +use [constraintSystem](../README.md#constraintsystem) ##### Type parameters @@ -228,62 +207,21 @@ console.log(result); #### Defined in -[lib/circuit.ts:122](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L122) - -___ - -### constraintSystemFromKeypair - -▪ `Static` **constraintSystemFromKeypair**: (`keypair`: [`Keypair`](Keypair.md)) => `Gate`[] = `SnarkyCircuit.constraintSystemFromKeypair` - -#### Type declaration - -▸ (`keypair`): `Gate`[] - -Returns a low-level JSON representation of the `Circuit` from its [Keypair](Keypair.md): -a list of gates, each of which represents a row in a table, with certain coefficients and wires to other (row, column) pairs - -**`Example`** - -```ts -const keypair = await Circuit.generateKeypair(); -const jsonRepresentation = Circuit.constraintSystemFromKeypair(keypair); -``` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `keypair` | [`Keypair`](Keypair.md) | - -##### Returns - -`Gate`[] - -#### Defined in - -[lib/circuit.ts:132](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L132) +[lib/circuit.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L99) ___ ### equal -▪ `Static` **equal**: (`ctor`: { `toFields`: (`x`: `T`) => [`Field`](Field.md)[] }, `x`: `T`, `y`: `T`) => [`Bool`](Bool.md)(`x`: `T`, `y`: `T`) => [`Bool`](Bool.md) = `SnarkyCircuit.equal` +▪ `Static` **equal**: (`type`: [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => [`Bool`](Bool.md)(`x`: `T`, `y`: `T`) => [`Bool`](Bool.md) = `Provable.equal` #### Type declaration -▸ <`T`\>(`ctor`, `x`, `y`): [`Bool`](Bool.md) +▸ <`T`\>(`type`, `x`, `y`): [`Bool`](Bool.md) -Checks if two elements are equal. +**`Deprecated`** -**`Example`** - -```ts -class MyStruct extends Struct({ a: Field, b: Bool }) {}; -const a: MyStruct = { a: Field(0), b: Bool(false) }; -const b: MyStruct = { a: Field(1), b: Bool(true) }; -const isEqual = Circuit.equal(MyStruct, a, b); -``` +use [equal](../README.md#equal) ##### Type parameters @@ -295,8 +233,7 @@ const isEqual = Circuit.equal(MyStruct, a, b); | Name | Type | | :------ | :------ | -| `ctor` | `Object` | -| `ctor.toFields` | (`x`: `T`) => [`Field`](Field.md)[] | +| `type` | [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\> | | `x` | `T` | | `y` | `T` | @@ -306,22 +243,15 @@ const isEqual = Circuit.equal(MyStruct, a, b); ▸ <`T`\>(`x`, `y`): [`Bool`](Bool.md) -Checks if two elements are equal. +**`Deprecated`** -**`Example`** - -```ts -class MyStruct extends Struct({ a: Field, b: Bool }) {}; -const a: MyStruct = { a: Field(0), b: Bool(false) }; -const b: MyStruct = { a: Field(1), b: Bool(true) }; -const isEqual = Circuit.equal(MyStruct, a, b); -``` +use [equal](../README.md#equal) ##### Type parameters -| Name | -| :------ | -| `T` | +| Name | Type | +| :------ | :------ | +| `T` | extends `ToFieldable` | ##### Parameters @@ -336,26 +266,21 @@ const isEqual = Circuit.equal(MyStruct, a, b); #### Defined in -[lib/circuit.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L163) +[lib/circuit.ts:111](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L111) ___ ### if -▪ `Static` **if**: (`b`: `boolean` \| [`Bool`](Bool.md), `ctor`: [`ProvablePure`](../interfaces/ProvablePure.md)<`T`\>, `x`: `T`, `y`: `T`) => `T`(`b`: `boolean` \| [`Bool`](Bool.md), `x`: `T`, `y`: `T`) => `T` = `SnarkyCircuit.if` +▪ `Static` **if**: (`condition`: [`Bool`](Bool.md), `type`: [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => `T`(`condition`: [`Bool`](Bool.md), `x`: `T`, `y`: `T`) => `T` = `Provable.if` #### Type declaration -▸ <`T`\>(`b`, `ctor`, `x`, `y`): `T` +▸ <`T`\>(`condition`, `type`, `x`, `y`): `T` -Circuit-compatible if-statement. +**`Deprecated`** -**`Example`** - -```ts -const condition = Bool(true); -const result = Circuit.if(condition, Field(1), Field(2)); // Returns Field(1) -``` +use [if](../README.md#if) ##### Type parameters @@ -367,8 +292,8 @@ const result = Circuit.if(condition, Field(1), Field(2)); // Returns Field(1) | Name | Type | | :------ | :------ | -| `b` | `boolean` \| [`Bool`](Bool.md) | -| `ctor` | [`ProvablePure`](../interfaces/ProvablePure.md)<`T`\> | +| `condition` | [`Bool`](Bool.md) | +| `type` | [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\> | | `x` | `T` | | `y` | `T` | @@ -376,28 +301,23 @@ const result = Circuit.if(condition, Field(1), Field(2)); // Returns Field(1) `T` -▸ <`T`\>(`b`, `x`, `y`): `T` +▸ <`T`\>(`condition`, `x`, `y`): `T` -Circuit-compatible if-statement. +**`Deprecated`** -**`Example`** - -```ts -const condition = Bool(true); -const result = Circuit.if(condition, Field(1), Field(2)); // Returns Field(1) -``` +use [if](../README.md#if) ##### Type parameters -| Name | -| :------ | -| `T` | +| Name | Type | +| :------ | :------ | +| `T` | extends `ToFieldable` | ##### Parameters | Name | Type | | :------ | :------ | -| `b` | `boolean` \| [`Bool`](Bool.md) | +| `condition` | [`Bool`](Bool.md) | | `x` | `T` | | `y` | `T` | @@ -407,27 +327,21 @@ const result = Circuit.if(condition, Field(1), Field(2)); // Returns Field(1) #### Defined in -[lib/circuit.ts:172](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L172) +[lib/circuit.ts:115](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L115) ___ ### inCheckedComputation -▪ `Static` **inCheckedComputation**: () => `boolean` = `SnarkyCircuit.inCheckedComputation` +▪ `Static` **inCheckedComputation**: () => `boolean` = `Provable.inCheckedComputation` #### Type declaration ▸ (): `boolean` -Checks if the circuit is in checked computation mode. +**`Deprecated`** -**`Example`** - -```ts -if (Circuit.inCheckedComputation()) { - // Checked computation-specific code -} -``` +use [inCheckedComputation](../README.md#incheckedcomputation) ##### Returns @@ -435,27 +349,21 @@ if (Circuit.inCheckedComputation()) { #### Defined in -[lib/circuit.ts:212](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L212) +[lib/circuit.ts:127](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L127) ___ ### inProver -▪ `Static` **inProver**: () => `boolean` = `SnarkyCircuit.inProver` +▪ `Static` **inProver**: () => `boolean` = `Provable.inProver` #### Type declaration ▸ (): `boolean` -Checks if the circuit is in prover mode. +**`Deprecated`** -**`Example`** - -```ts -if (Circuit.inProver()) { - // Prover-specific code -} -``` +use [inProver](../README.md#inprover) ##### Returns @@ -463,26 +371,21 @@ if (Circuit.inProver()) { #### Defined in -[lib/circuit.ts:202](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L202) +[lib/circuit.ts:123](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L123) ___ ### log -▪ `Static` **log**: (...`args`: `any`) => `void` = `SnarkyCircuit.log` +▪ `Static` **log**: (...`args`: `any`) => `void` = `Provable.log` #### Type declaration ▸ (`...args`): `void` -Interface to log elements within a circuit. Similar to `console.log()`. +**`Deprecated`** -**`Example`** - -```ts -const element = Field(42); -Circuit.log(element); -``` +use [log](../README.md#log) ##### Parameters @@ -496,27 +399,21 @@ Circuit.log(element); #### Defined in -[lib/circuit.ts:221](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L221) +[lib/circuit.ts:131](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L131) ___ ### runAndCheck -▪ `Static` **runAndCheck**: (`f`: () => `void`) => `void` = `SnarkyCircuit.runAndCheck` +▪ `Static` **runAndCheck**: (`f`: () => `void`) => `void` = `Provable.runAndCheck` #### Type declaration ▸ (`f`): `void` -Runs provable code quickly, without creating a proof, but still checking whether constraints are satisfied. +**`Deprecated`** -**`Example`** - -```ts -Circuit.runAndCheck(() => { - // Your code to check here -}); -``` +use [runAndCheck](../README.md#runandcheck) ##### Parameters @@ -530,27 +427,21 @@ Circuit.runAndCheck(() => { #### Defined in -[lib/circuit.ts:103](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L103) +[lib/circuit.ts:91](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L91) ___ ### runUnchecked -▪ `Static` **runUnchecked**: (`f`: () => `void`) => `void` = `SnarkyCircuit.runUnchecked` +▪ `Static` **runUnchecked**: (`f`: () => `void`) => `void` = `Provable.runUnchecked` #### Type declaration ▸ (`f`): `void` -Runs provable code quickly, without creating a proof, and not checking whether constraints are satisfied. - -**`Example`** +**`Deprecated`** -```ts -Circuit.runUnchecked(() => { - // Your code to run here -}); -``` +use [runUnchecked](../README.md#rununchecked) ##### Parameters @@ -564,28 +455,21 @@ Circuit.runUnchecked(() => { #### Defined in -[lib/circuit.ts:113](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L113) +[lib/circuit.ts:95](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L95) ___ ### switch -▪ `Static` **switch**: (`mask`: [`Bool`](Bool.md)[], `type`: `A`, `values`: `T`[]) => `T` = `SnarkyCircuit.switch` +▪ `Static` **switch**: (`mask`: [`Bool`](Bool.md)[], `type`: `A`, `values`: `T`[]) => `T` = `Provable.switch` #### Type declaration ▸ <`T`, `A`\>(`mask`, `type`, `values`): `T` -Generalization of `Circuit.if` for choosing between more than two different cases. -It takes a "mask", which is an array of `Bool`s that contains only one `true` element, a type/constructor, and an array of values of that type. -The result is that value which corresponds to the true element of the mask. - -**`Example`** +**`Deprecated`** -```ts -let x = Circuit.switch([Bool(false), Bool(true)], Field, [Field(1), Field(2)]); -x.assertEquals(2); -``` +use [switch](../README.md#switch) ##### Type parameters @@ -608,74 +492,21 @@ x.assertEquals(2); #### Defined in -[lib/circuit.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L183) - -___ - -### toFields - -▪ `Static` **toFields**: (`a`: `A`) => [`Field`](Field.md)[] = `SnarkyCircuit.toFields` - -#### Type declaration - -▸ <`A`\>(`a`): [`Field`](Field.md)[] - -Serializes an element into [Field](Field.md) elements. - -**`Example`** - -```ts -const element = Field(42); -const fields = Circuit.toFields(element); -``` - -##### Type parameters - -| Name | -| :------ | -| `A` | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | `A` | - -##### Returns - -[`Field`](Field.md)[] - -#### Defined in - -[lib/circuit.ts:192](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L192) +[lib/circuit.ts:119](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L119) ___ ### witness -▪ `Static` **witness**: (`ctor`: `S`, `f`: () => `T`) => `T` = `SnarkyCircuit.witness` +▪ `Static` **witness**: (`type`: `S`, `compute`: () => `T`) => `T` = `Provable.witness` #### Type declaration -▸ <`T`, `S`\>(`ctor`, `f`): `T` - -Create a new witness. A witness, or variable, is a value that is provided as input -by the prover. This provides a flexible way to introduce values from outside into the circuit. -However, note that nothing about how the value was created is part of the proof - `Circuit.witness` -behaves exactly like user input. So, make sure that after receiving the witness you make any assertions -that you want to associate with it. +▸ <`T`, `S`\>(`type`, `compute`): `T` -**`Example`** +**`Deprecated`** -Example for re-implementing `Field.inv` with the help of `witness`: -```ts -let invX = Circuit.witness(Field, () => { - // compute the inverse of `x` outside the circuit, however you like! - return Field.inv(x)); -} -// prove that `invX` is really the inverse of `x`: -invX.mul(x).assertEquals(1); -``` +use [witness](../README.md#witness) ##### Type parameters @@ -688,8 +519,8 @@ invX.mul(x).assertEquals(1); | Name | Type | | :------ | :------ | -| `ctor` | `S` | -| `f` | () => `T` | +| `type` | `S` | +| `compute` | () => `T` | ##### Returns @@ -697,7 +528,7 @@ invX.mul(x).assertEquals(1); #### Defined in -[lib/circuit.ts:83](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L83) +[lib/circuit.ts:83](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L83) ## Methods @@ -710,7 +541,7 @@ Generates a proving key and a verification key for this circuit. **`Example`** ```ts -const keypair = await Circuit.generateKeypair(); +const keypair = await MyCircuit.generateKeypair(); ``` #### Returns @@ -719,7 +550,7 @@ const keypair = await Circuit.generateKeypair(); #### Defined in -[lib/circuit.ts:25](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L25) +[lib/circuit.ts:22](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L22) ___ @@ -732,8 +563,8 @@ Proves a statement using the private input, public input, and the [Keypair](Keyp **`Example`** ```ts -const keypair = await Circuit.generateKeypair(); -const proof = await Circuit.prove(privateInput, publicInput, keypair); +const keypair = await MyCircuit.generateKeypair(); +const proof = await MyCircuit.prove(privateInput, publicInput, keypair); ``` #### Parameters @@ -750,22 +581,22 @@ const proof = await Circuit.prove(privateInput, publicInput, keypair); #### Defined in -[lib/circuit.ts:39](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L39) +[lib/circuit.ts:39](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L39) ___ ### verify -▸ `Static` **verify**(`publicInput`, `vk`, `proof`): `Promise`<`boolean`\> +▸ `Static` **verify**(`publicInput`, `verificationKey`, `proof`): `Promise`<`boolean`\> Verifies a proof using the public input, the proof, and the initial [Keypair](Keypair.md) of the circuit. **`Example`** ```ts -const keypair = await Circuit.generateKeypair(); -const proof = await Circuit.prove(privateInput, publicInput, keypair); -const isValid = await Circuit.verify(publicInput, keypair.vk, proof); +const keypair = await MyCircuit.generateKeypair(); +const proof = await MyCircuit.prove(privateInput, publicInput, keypair); +const isValid = await MyCircuit.verify(publicInput, keypair.vk, proof); ``` #### Parameters @@ -773,7 +604,7 @@ const isValid = await Circuit.verify(publicInput, keypair.vk, proof); | Name | Type | | :------ | :------ | | `publicInput` | `any`[] | -| `vk` | `VerificationKey` | +| `verificationKey` | `VerificationKey` | | `proof` | `Proof` | #### Returns @@ -782,4 +613,4 @@ const isValid = await Circuit.verify(publicInput, keypair.vk, proof); #### Defined in -[lib/circuit.ts:54](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L54) +[lib/circuit.ts:63](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L63) diff --git a/docs/zkapps/snarkyjs-reference/classes/CircuitString.md b/docs/zkapps/snarkyjs-reference/classes/CircuitString.md index c500e8360..d644ecb87 100644 --- a/docs/zkapps/snarkyjs-reference/classes/CircuitString.md +++ b/docs/zkapps/snarkyjs-reference/classes/CircuitString.md @@ -68,7 +68,7 @@ #### Defined in -[lib/string.ts:45](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L45) +[lib/string.ts:45](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L45) ## Properties @@ -78,7 +78,7 @@ #### Defined in -[lib/string.ts:40](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L40) +[lib/string.ts:40](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L40) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[lib/string.ts:39](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L39) +[lib/string.ts:39](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L39) ## Methods @@ -111,7 +111,7 @@ within the `maxLength` of this string (the other string can have a different max #### Defined in -[lib/string.ts:88](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L88) +[lib/string.ts:88](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L88) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[lib/string.ts:58](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L58) +[lib/string.ts:58](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L58) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -194,7 +194,7 @@ returns true if `str` is found in this `CircuitString` #### Defined in -[lib/string.ts:124](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L124) +[lib/string.ts:124](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L124) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[lib/string.ts:80](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L80) +[lib/string.ts:80](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L80) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[lib/string.ts:77](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L77) +[lib/string.ts:77](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L77) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -[lib/string.ts:53](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L53) +[lib/string.ts:53](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L53) ___ @@ -275,7 +275,7 @@ ___ #### Defined in -[lib/string.ts:128](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L128) +[lib/string.ts:128](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L128) ___ @@ -293,7 +293,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -329,7 +329,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -343,7 +343,7 @@ ___ #### Defined in -[lib/string.ts:132](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L132) +[lib/string.ts:132](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L132) ___ @@ -374,7 +374,7 @@ ___ #### Defined in -[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) +[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) ___ @@ -394,7 +394,7 @@ ___ #### Defined in -[lib/string.ts:49](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L49) +[lib/string.ts:49](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L49) ___ @@ -425,7 +425,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) +[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) ___ @@ -487,7 +487,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -507,7 +507,7 @@ ___ #### Defined in -[lib/string.ts:139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L139) +[lib/string.ts:139](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L139) ___ @@ -525,7 +525,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -543,7 +543,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -574,7 +574,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -605,7 +605,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -636,7 +636,7 @@ ___ #### Defined in -[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) +[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) ___ @@ -667,4 +667,4 @@ ___ #### Defined in -[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) +[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) diff --git a/docs/zkapps/snarkyjs-reference/classes/CircuitValue.md b/docs/zkapps/snarkyjs-reference/classes/CircuitValue.md index 73e75eefe..d3df8b007 100644 --- a/docs/zkapps/snarkyjs-reference/classes/CircuitValue.md +++ b/docs/zkapps/snarkyjs-reference/classes/CircuitValue.md @@ -67,7 +67,7 @@ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) ## Methods @@ -87,7 +87,7 @@ #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) +[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) ___ @@ -217,7 +217,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) +[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) ___ @@ -271,7 +271,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -299,7 +299,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -353,7 +353,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) +[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) ___ @@ -407,4 +407,4 @@ ___ #### Defined in -[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) +[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) diff --git a/docs/zkapps/snarkyjs-reference/classes/Field.md b/docs/zkapps/snarkyjs-reference/classes/Field.md index 50c954ad9..92ed41654 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Field.md +++ b/docs/zkapps/snarkyjs-reference/classes/Field.md @@ -86,7 +86,7 @@ Coerces anything field-like to a [Field](Field.md). #### Defined in -[snarky.d.ts:61](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L61) +[snarky.d.ts:140](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L140) ## Properties @@ -98,7 +98,7 @@ The field order as a `bigint`. #### Defined in -[snarky.d.ts:432](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L432) +[snarky.d.ts:511](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L511) ___ @@ -114,7 +114,7 @@ The number -1 as a [[`Field`]]. #### Defined in -[snarky.d.ts:428](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L428) +[snarky.d.ts:507](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L507) ___ @@ -130,7 +130,7 @@ The number 1 as a [[`Field`]]. #### Defined in -[snarky.d.ts:416](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L416) +[snarky.d.ts:495](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L495) ___ @@ -146,7 +146,7 @@ The number 0 as a [[`Field`]]. #### Defined in -[snarky.d.ts:422](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L422) +[snarky.d.ts:501](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L501) ## Methods @@ -173,7 +173,7 @@ let sum = a.add(5) #### Defined in -[snarky.d.ts:94](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L94) +[snarky.d.ts:173](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L173) ___ @@ -199,7 +199,7 @@ Field(0).assertBool(); #### Defined in -[snarky.d.ts:356](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L356) +[snarky.d.ts:435](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L435) ___ @@ -229,7 +229,7 @@ Field(0).assertBoolean(); #### Defined in -[snarky.d.ts:368](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L368) +[snarky.d.ts:447](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L447) ___ @@ -257,7 +257,7 @@ Field(1).assertEquals(1); #### Defined in -[snarky.d.ts:346](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L346) +[snarky.d.ts:425](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L425) ___ @@ -284,7 +284,7 @@ Field(1).assertGt(0); #### Defined in -[snarky.d.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L230) +[snarky.d.ts:309](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L309) ___ @@ -311,7 +311,7 @@ Field(1).assertGte(0); #### Defined in -[snarky.d.ts:243](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L243) +[snarky.d.ts:322](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L322) ___ @@ -342,7 +342,7 @@ Field(1).assertGt(0); #### Defined in -[snarky.d.ts:325](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L325) +[snarky.d.ts:404](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L404) ___ @@ -373,7 +373,7 @@ Field(1).assertGte(0); #### Defined in -[snarky.d.ts:336](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L336) +[snarky.d.ts:415](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L415) ___ @@ -400,7 +400,7 @@ Field(1).assertLessThan(2); #### Defined in -[snarky.d.ts:207](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L207) +[snarky.d.ts:286](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L286) ___ @@ -427,7 +427,7 @@ Field(1).assertLessThanOrEqual(2); #### Defined in -[snarky.d.ts:217](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L217) +[snarky.d.ts:296](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L296) ___ @@ -458,7 +458,7 @@ Field(1).assertLessThan(2); #### Defined in -[snarky.d.ts:304](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L304) +[snarky.d.ts:383](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L383) ___ @@ -489,7 +489,7 @@ Field(1).assertLte(2); #### Defined in -[snarky.d.ts:314](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L314) +[snarky.d.ts:393](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L393) ___ @@ -511,7 +511,7 @@ Divides this [Field](Field.md) element through another coercible to a field. #### Defined in -[snarky.d.ts:109](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L109) +[snarky.d.ts:188](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L188) ___ @@ -538,7 +538,7 @@ Field(2).equals(2); // Bool(true) #### Defined in -[snarky.d.ts:391](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L391) +[snarky.d.ts:470](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L470) ___ @@ -560,7 +560,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:469](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L469) +[snarky.d.ts:548](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L548) ___ @@ -587,7 +587,7 @@ Field(2).greaterThan(1); // Bool(true) #### Defined in -[snarky.d.ts:185](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L185) +[snarky.d.ts:264](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L264) ___ @@ -614,7 +614,7 @@ Field(2).greaterThanOrEqual(1); // Bool(true) #### Defined in -[snarky.d.ts:195](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L195) +[snarky.d.ts:274](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L274) ___ @@ -645,7 +645,7 @@ Field(2).gt(1); // Bool(true) #### Defined in -[snarky.d.ts:280](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L280) +[snarky.d.ts:359](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L359) ___ @@ -676,7 +676,7 @@ Field(2).gte(1); // Bool(true) #### Defined in -[snarky.d.ts:291](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L291) +[snarky.d.ts:370](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L370) ___ @@ -699,7 +699,7 @@ A [Field](Field.md) element that is equivalent to one divided by this element. #### Defined in -[snarky.d.ts:84](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L84) +[snarky.d.ts:163](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L163) ___ @@ -715,7 +715,7 @@ Checks whether this is a hard-coded constant in the Circuit. #### Defined in -[snarky.d.ts:401](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L401) +[snarky.d.ts:480](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L480) ___ @@ -729,7 +729,7 @@ ___ #### Defined in -[snarky.d.ts:370](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L370) +[snarky.d.ts:449](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L449) ___ @@ -756,7 +756,7 @@ Field(2).lessThan(3); // Bool(true) #### Defined in -[snarky.d.ts:165](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L165) +[snarky.d.ts:244](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L244) ___ @@ -783,7 +783,7 @@ Field(2).lessThanOrEqual(3); // Bool(true) #### Defined in -[snarky.d.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L175) +[snarky.d.ts:254](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L254) ___ @@ -814,7 +814,7 @@ Field(2).lt(3); // Bool(true) #### Defined in -[snarky.d.ts:258](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L258) +[snarky.d.ts:337](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L337) ___ @@ -845,7 +845,7 @@ Field(2).lte(3); // Bool(true) #### Defined in -[snarky.d.ts:269](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L269) +[snarky.d.ts:348](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L348) ___ @@ -867,7 +867,7 @@ Multiplies this [Field](Field.md) element with another coercible to a field. #### Defined in -[snarky.d.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L104) +[snarky.d.ts:183](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L183) ___ @@ -889,7 +889,7 @@ negOne.assertEquals(-1); #### Defined in -[snarky.d.ts:72](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L72) +[snarky.d.ts:151](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L151) ___ @@ -909,7 +909,7 @@ ___ #### Defined in -[snarky.d.ts:396](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L396) +[snarky.d.ts:475](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L475) ___ @@ -923,7 +923,7 @@ ___ #### Defined in -[snarky.d.ts:394](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L394) +[snarky.d.ts:473](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L473) ___ @@ -939,7 +939,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:149](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L149) +[snarky.d.ts:228](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L228) ___ @@ -959,7 +959,7 @@ x.square().sqrt().assertEquals(x); #### Defined in -[snarky.d.ts:128](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L128) +[snarky.d.ts:207](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L207) ___ @@ -980,7 +980,7 @@ x2.assertEquals(x.mul(x)); #### Defined in -[snarky.d.ts:119](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L119) +[snarky.d.ts:198](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L198) ___ @@ -1002,7 +1002,7 @@ Subtracts another [Field](Field.md)-like element from this one. #### Defined in -[snarky.d.ts:99](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L99) +[snarky.d.ts:178](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L178) ___ @@ -1019,7 +1019,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L139) +[snarky.d.ts:218](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L218) ___ @@ -1035,7 +1035,7 @@ Little endian binary representation of the field element. #### Defined in -[snarky.d.ts:375](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L375) +[snarky.d.ts:454](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L454) ▸ **toBits**(`length`): [`Bool`](Bool.md)[] @@ -1054,7 +1054,7 @@ Fails if the field element cannot fit in `length` bits. #### Defined in -[snarky.d.ts:381](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L381) +[snarky.d.ts:460](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L460) ___ @@ -1070,7 +1070,7 @@ Returns a constant. #### Defined in -[snarky.d.ts:406](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L406) +[snarky.d.ts:485](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L485) ___ @@ -1086,7 +1086,7 @@ Serializes this data structure into [Field](Field.md) elements. #### Defined in -[snarky.d.ts:154](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L154) +[snarky.d.ts:233](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L233) ___ @@ -1103,7 +1103,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:144](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L144) +[snarky.d.ts:223](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L223) ___ @@ -1120,7 +1120,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:134](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L134) +[snarky.d.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L213) ___ @@ -1140,7 +1140,7 @@ ___ #### Defined in -[snarky.d.ts:527](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L527) +[snarky.d.ts:606](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L606) ___ @@ -1163,7 +1163,7 @@ Fails if the field element cannot fit given too many bits. #### Defined in -[snarky.d.ts:503](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L503) +[snarky.d.ts:582](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L582) ___ @@ -1183,7 +1183,7 @@ ___ #### Defined in -[snarky.d.ts:532](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L532) +[snarky.d.ts:611](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L611) ___ @@ -1205,7 +1205,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:474](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L474) +[snarky.d.ts:553](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L553) ___ @@ -1228,7 +1228,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:525](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L525) +[snarky.d.ts:604](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L604) ___ @@ -1244,7 +1244,7 @@ A random field element. #### Defined in -[snarky.d.ts:437](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L437) +[snarky.d.ts:516](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L516) ___ @@ -1265,7 +1265,7 @@ ___ #### Defined in -[snarky.d.ts:533](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L533) +[snarky.d.ts:612](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L612) ___ @@ -1279,7 +1279,7 @@ ___ #### Defined in -[snarky.d.ts:537](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L537) +[snarky.d.ts:616](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L616) ___ @@ -1295,7 +1295,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:479](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L479) +[snarky.d.ts:558](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L558) ___ @@ -1317,7 +1317,7 @@ Static method to serialize a [Field](Field.md) into its auxiliary data. #### Defined in -[snarky.d.ts:488](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L488) +[snarky.d.ts:567](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L567) ___ @@ -1337,7 +1337,7 @@ ___ #### Defined in -[snarky.d.ts:531](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L531) +[snarky.d.ts:610](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L610) ___ @@ -1359,7 +1359,7 @@ Static method to serialize a [Field](Field.md) into an array of [Field](Field.md #### Defined in -[snarky.d.ts:484](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L484) +[snarky.d.ts:563](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L563) ___ @@ -1383,7 +1383,7 @@ ___ #### Defined in -[snarky.d.ts:530](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L530) +[snarky.d.ts:609](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L609) ___ @@ -1406,4 +1406,4 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:519](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L519) +[snarky.d.ts:598](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L598) diff --git a/docs/zkapps/snarkyjs-reference/classes/Group.md b/docs/zkapps/snarkyjs-reference/classes/Group.md index 6f74b95f3..97da6cc32 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Group.md +++ b/docs/zkapps/snarkyjs-reference/classes/Group.md @@ -53,7 +53,7 @@ Represents a point with x and y coordinates on an elliptic curve. #### Defined in -[snarky.d.ts:1024](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1024) +[snarky.d.ts:960](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L960) • **new Group**(`x`, `y`) @@ -66,7 +66,7 @@ Represents a point with x and y coordinates on an elliptic curve. #### Defined in -[snarky.d.ts:1028](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1028) +[snarky.d.ts:964](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L964) ## Properties @@ -76,7 +76,7 @@ Represents a point with x and y coordinates on an elliptic curve. #### Defined in -[snarky.d.ts:985](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L985) +[snarky.d.ts:921](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L921) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[snarky.d.ts:986](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L986) +[snarky.d.ts:922](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L922) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[snarky.d.ts:1033](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1033) +[snarky.d.ts:969](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L969) ## Methods @@ -118,7 +118,7 @@ Adds two [Group](Group.md) elements together. #### Defined in -[snarky.d.ts:991](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L991) +[snarky.d.ts:927](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L927) ___ @@ -141,7 +141,7 @@ Asserts that two [Group](Group.md) elements are equal. #### Defined in -[snarky.d.ts:1012](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1012) +[snarky.d.ts:948](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L948) ___ @@ -163,7 +163,7 @@ Checks if two [Group](Group.md) elements are equal. #### Defined in -[snarky.d.ts:1017](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1017) +[snarky.d.ts:953](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L953) ___ @@ -179,7 +179,7 @@ Negates this [Group](Group.md) elements and returns a new instance. #### Defined in -[snarky.d.ts:1001](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1001) +[snarky.d.ts:937](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L937) ___ @@ -201,7 +201,7 @@ Scales this [Group](Group.md) element using a [Scalar](Scalar.md). #### Defined in -[snarky.d.ts:1006](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1006) +[snarky.d.ts:942](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L942) ___ @@ -223,7 +223,7 @@ Subtracts one [Group](Group.md) element from the other. #### Defined in -[snarky.d.ts:996](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L996) +[snarky.d.ts:932](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L932) ___ @@ -244,7 +244,7 @@ Returns the JSON representation of this [Group](Group.md) element. #### Defined in -[snarky.d.ts:1022](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1022) +[snarky.d.ts:958](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L958) ___ @@ -267,7 +267,7 @@ Adds two [Group](Group.md) elements together. #### Defined in -[snarky.d.ts:1037](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1037) +[snarky.d.ts:973](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L973) ___ @@ -290,7 +290,7 @@ Asserts that two [Group](Group.md) elements are equal. #### Defined in -[snarky.d.ts:1056](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1056) +[snarky.d.ts:992](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L992) ___ @@ -310,7 +310,7 @@ ___ #### Defined in -[snarky.d.ts:1094](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1094) +[snarky.d.ts:1030](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1030) ___ @@ -333,7 +333,7 @@ Checks if two [Group](Group.md) elements are equal. #### Defined in -[snarky.d.ts:1061](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1061) +[snarky.d.ts:997](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L997) ___ @@ -355,7 +355,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:1073](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1073) +[snarky.d.ts:1009](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1009) ___ @@ -380,7 +380,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:1087](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1087) +[snarky.d.ts:1023](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1023) ___ @@ -402,7 +402,7 @@ Negates a [Group](Group.md) elements and returns a new instance. #### Defined in -[snarky.d.ts:1045](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1045) +[snarky.d.ts:981](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L981) ___ @@ -425,7 +425,7 @@ Scales this [Group](Group.md) element using a [Scalar](Scalar.md). #### Defined in -[snarky.d.ts:1050](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1050) +[snarky.d.ts:986](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L986) ___ @@ -441,7 +441,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:1077](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1077) +[snarky.d.ts:1013](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1013) ___ @@ -464,7 +464,7 @@ Subtracts one [Group](Group.md) element from the other. #### Defined in -[snarky.d.ts:1041](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1041) +[snarky.d.ts:977](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L977) ___ @@ -486,7 +486,7 @@ Static method to serialize a [Group](Group.md) into its auxiliary data. #### Defined in -[snarky.d.ts:1069](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1069) +[snarky.d.ts:1005](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1005) ___ @@ -508,7 +508,7 @@ Static method to serialize a [Group](Group.md) into an array of [Field](Field.md #### Defined in -[snarky.d.ts:1065](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1065) +[snarky.d.ts:1001](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1001) ___ @@ -536,4 +536,4 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:1082](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1082) +[snarky.d.ts:1018](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1018) diff --git a/docs/zkapps/snarkyjs-reference/classes/Int64.md b/docs/zkapps/snarkyjs-reference/classes/Int64.md index 003668cdb..4ce5512be 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Int64.md +++ b/docs/zkapps/snarkyjs-reference/classes/Int64.md @@ -80,7 +80,7 @@ A 64 bit signed integer with values ranging from -18,446,744,073,709,551,615 to #### Defined in -[lib/int.ts:785](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L785) +[lib/int.ts:790](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L790) ## Properties @@ -94,7 +94,7 @@ BalanceChange.magnitude #### Defined in -[lib/int.ts:762](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L762) +[lib/int.ts:767](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L767) ___ @@ -108,7 +108,7 @@ BalanceChange.sgn #### Defined in -[lib/int.ts:763](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L763) +[lib/int.ts:768](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L768) ## Accessors @@ -124,7 +124,7 @@ Static method to create a [Int64](Int64.md) with value `-1`. #### Defined in -[lib/int.ts:861](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L861) +[lib/int.ts:865](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L865) ___ @@ -140,7 +140,7 @@ Static method to create a [Int64](Int64.md) with value `1`. #### Defined in -[lib/int.ts:855](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L855) +[lib/int.ts:859](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L859) ___ @@ -156,7 +156,7 @@ Static method to create a [Int64](Int64.md) with value `0`. #### Defined in -[lib/int.ts:849](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L849) +[lib/int.ts:853](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L853) ## Methods @@ -178,7 +178,7 @@ Addition with overflow checking. #### Defined in -[lib/int.ts:895](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L895) +[lib/int.ts:899](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L899) ___ @@ -205,7 +205,7 @@ Asserts that two values are equal. #### Defined in -[lib/int.ts:949](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L949) +[lib/int.ts:953](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L953) ___ @@ -230,7 +230,7 @@ Integer division. #### Defined in -[lib/int.ts:920](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L920) +[lib/int.ts:924](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L924) ___ @@ -256,7 +256,7 @@ Checks if two values are equal. #### Defined in -[lib/int.ts:942](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L942) +[lib/int.ts:946](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L946) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[lib/int.ts:838](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L838) +[lib/int.ts:842](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L842) ___ @@ -290,7 +290,7 @@ Checks if the value is postive. #### Defined in -[lib/int.ts:959](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L959) +[lib/int.ts:963](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L963) ___ @@ -315,7 +315,7 @@ Integer remainder. #### Defined in -[lib/int.ts:932](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L932) +[lib/int.ts:936](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L936) ___ @@ -337,7 +337,7 @@ Multiplication with overflow checking. #### Defined in -[lib/int.ts:909](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L909) +[lib/int.ts:913](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L913) ___ @@ -355,7 +355,7 @@ Negates the value. #### Defined in -[lib/int.ts:888](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L888) +[lib/int.ts:892](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L892) ___ @@ -377,7 +377,7 @@ Subtraction with underflow checking. #### Defined in -[lib/int.ts:902](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L902) +[lib/int.ts:906](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L906) ___ @@ -395,7 +395,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -411,7 +411,7 @@ Returns the [Field](Field.md) value. #### Defined in -[lib/int.ts:868](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L868) +[lib/int.ts:872](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L872) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -447,7 +447,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -463,7 +463,7 @@ Turns the [Int64](Int64.md) into a string. #### Defined in -[lib/int.ts:832](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L832) +[lib/int.ts:837](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L837) ___ @@ -494,7 +494,7 @@ ___ #### Defined in -[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) +[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) ___ @@ -518,7 +518,7 @@ Check the range if the argument is a constant. #### Defined in -[lib/int.ts:822](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L822) +[lib/int.ts:827](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L827) ___ @@ -540,7 +540,7 @@ Static method to create a [Int64](Int64.md) from a [Field](Field.md). #### Defined in -[lib/int.ts:874](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L874) +[lib/int.ts:878](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L878) ___ @@ -564,7 +564,7 @@ Does check if the [Field](Field.md) is within range. #### Defined in -[lib/int.ts:794](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L794) +[lib/int.ts:799](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L799) ___ @@ -595,7 +595,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -626,7 +626,7 @@ ___ #### Defined in -[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) +[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) ___ @@ -657,7 +657,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -681,7 +681,7 @@ Creates a new [Int64](Int64.md) from a [Field](Field.md). #### Defined in -[lib/int.ts:812](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L812) +[lib/int.ts:817](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L817) ___ @@ -699,7 +699,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -717,7 +717,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -748,7 +748,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -779,7 +779,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -810,7 +810,7 @@ ___ #### Defined in -[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) +[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) ___ @@ -841,4 +841,4 @@ ___ #### Defined in -[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) +[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) diff --git a/docs/zkapps/snarkyjs-reference/classes/Keypair.md b/docs/zkapps/snarkyjs-reference/classes/Keypair.md index a7c73219e..131420595 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Keypair.md +++ b/docs/zkapps/snarkyjs-reference/classes/Keypair.md @@ -1,25 +1,72 @@ # Class: Keypair -Contains a proving key and [VerificationKey](VerificationKey.md) which can be used to verify proofs. - ## Table of contents ### Constructors - [constructor](Keypair.md#constructor) +### Properties + +- [value](Keypair.md#value) + ### Methods +- [constraintSystem](Keypair.md#constraintsystem) - [verificationKey](Keypair.md#verificationkey) ## Constructors ### constructor -• **new Keypair**() +• **new Keypair**(`value`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `unknown` | + +#### Defined in + +[lib/circuit.ts:137](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L137) + +## Properties + +### value + +• **value**: `unknown` + +#### Defined in + +[lib/circuit.ts:135](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L135) ## Methods +### constraintSystem + +▸ **constraintSystem**(): `Gate`[] + +Returns a low-level JSON representation of the [Circuit](Circuit.md) from its [Keypair](Keypair.md): +a list of gates, each of which represents a row in a table, with certain coefficients and wires to other (row, column) pairs + +**`Example`** + +```ts +const keypair = await MyCircuit.generateKeypair(); +const json = MyCircuit.constraintSystemFromKeypair(keypair); +``` + +#### Returns + +`Gate`[] + +#### Defined in + +[lib/circuit.ts:156](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L156) + +___ + ### verificationKey ▸ **verificationKey**(): `VerificationKey` @@ -30,4 +77,4 @@ Contains a proving key and [VerificationKey](VerificationKey.md) which can be us #### Defined in -[snarky.d.ts:1135](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1135) +[lib/circuit.ts:141](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L141) diff --git a/docs/zkapps/snarkyjs-reference/classes/Ledger.md b/docs/zkapps/snarkyjs-reference/classes/Ledger.md index 30972eb2e..514516d68 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Ledger.md +++ b/docs/zkapps/snarkyjs-reference/classes/Ledger.md @@ -63,7 +63,7 @@ Represents the Mina ledger. #### Defined in -[snarky.d.ts:1257](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1257) +[snarky.d.ts:1174](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1174) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[snarky.d.ts:1246](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1246) +[snarky.d.ts:1163](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1163) ## Methods @@ -108,7 +108,7 @@ Adds an account and its balance to the ledger. #### Defined in -[snarky.d.ts:1162](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1162) +[snarky.d.ts:1079](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1079) ___ @@ -132,7 +132,7 @@ Applies a JSON transaction to the ledger. #### Defined in -[snarky.d.ts:1167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1167) +[snarky.d.ts:1084](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1084) ___ @@ -155,7 +155,7 @@ Returns an account. #### Defined in -[snarky.d.ts:1176](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1176) +[snarky.d.ts:1093](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1093) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[snarky.d.ts:1237](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1237) +[snarky.d.ts:1154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1154) ___ @@ -198,7 +198,7 @@ Creates a fresh ledger. #### Defined in -[snarky.d.ts:1155](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1155) +[snarky.d.ts:1072](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1072) ___ @@ -219,7 +219,7 @@ ___ #### Defined in -[snarky.d.ts:1225](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1225) +[snarky.d.ts:1142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1142) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[snarky.d.ts:1223](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1223) +[snarky.d.ts:1140](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1140) ___ @@ -261,7 +261,7 @@ ___ #### Defined in -[snarky.d.ts:1224](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1224) +[snarky.d.ts:1141](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1141) ___ @@ -277,7 +277,7 @@ Returns a dummy signature. #### Defined in -[snarky.d.ts:1207](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1207) +[snarky.d.ts:1124](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1124) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -[snarky.d.ts:1232](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1232) +[snarky.d.ts:1149](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1149) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -[snarky.d.ts:1231](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1231) +[snarky.d.ts:1148](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1148) ___ @@ -337,7 +337,7 @@ ___ #### Defined in -[snarky.d.ts:1242](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1242) +[snarky.d.ts:1159](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1159) ___ @@ -357,7 +357,7 @@ ___ #### Defined in -[snarky.d.ts:1243](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1243) +[snarky.d.ts:1160](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1160) ___ @@ -377,7 +377,7 @@ ___ #### Defined in -[snarky.d.ts:1244](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1244) +[snarky.d.ts:1161](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1161) ___ @@ -397,7 +397,7 @@ ___ #### Defined in -[snarky.d.ts:1235](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1235) +[snarky.d.ts:1152](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1152) ___ @@ -417,7 +417,7 @@ ___ #### Defined in -[snarky.d.ts:1234](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1234) +[snarky.d.ts:1151](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1151) ___ @@ -437,7 +437,7 @@ ___ #### Defined in -[snarky.d.ts:1230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1230) +[snarky.d.ts:1147](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1147) ___ @@ -458,7 +458,7 @@ ___ #### Defined in -[snarky.d.ts:1229](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1229) +[snarky.d.ts:1146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1146) ___ @@ -478,7 +478,7 @@ ___ #### Defined in -[snarky.d.ts:1228](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1228) +[snarky.d.ts:1145](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1145) ___ @@ -498,7 +498,7 @@ ___ #### Defined in -[snarky.d.ts:1227](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1227) +[snarky.d.ts:1144](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1144) ___ @@ -522,7 +522,7 @@ Signs a transaction as the fee payer. #### Defined in -[snarky.d.ts:1212](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1212) +[snarky.d.ts:1129](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1129) ___ @@ -547,7 +547,7 @@ Signs a [Field](Field.md) element. #### Defined in -[snarky.d.ts:1198](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1198) +[snarky.d.ts:1115](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1115) ___ @@ -572,7 +572,7 @@ Signs an account update. #### Defined in -[snarky.d.ts:1217](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1217) +[snarky.d.ts:1134](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1134) ___ @@ -600,7 +600,7 @@ Returns the commitment of a JSON transaction. #### Defined in -[snarky.d.ts:1181](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1181) +[snarky.d.ts:1098](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1098) ___ @@ -628,4 +628,4 @@ Returns the public input of a zkApp transaction. #### Defined in -[snarky.d.ts:1190](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1190) +[snarky.d.ts:1107](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1107) diff --git a/docs/zkapps/snarkyjs-reference/classes/MerkleMap.md b/docs/zkapps/snarkyjs-reference/classes/MerkleMap.md index 028288abd..811718ace 100644 --- a/docs/zkapps/snarkyjs-reference/classes/MerkleMap.md +++ b/docs/zkapps/snarkyjs-reference/classes/MerkleMap.md @@ -28,7 +28,7 @@ Creates a new, empty Merkle Map. #### Defined in -[lib/merkle_map.ts:19](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L19) +[lib/merkle_map.ts:19](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L19) ## Properties @@ -38,7 +38,7 @@ Creates a new, empty Merkle Map. #### Defined in -[lib/merkle_map.ts:11](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L11) +[lib/merkle_map.ts:11](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L11) ## Methods @@ -58,7 +58,7 @@ Creates a new, empty Merkle Map. #### Defined in -[lib/merkle_map.ts:34](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L34) +[lib/merkle_map.ts:34](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L34) ___ @@ -82,7 +82,7 @@ The value stored at the key. #### Defined in -[lib/merkle_map.ts:70](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L70) +[lib/merkle_map.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L70) ___ @@ -100,7 +100,7 @@ The root of the Merkle Map. #### Defined in -[lib/merkle_map.ts:81](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L81) +[lib/merkle_map.ts:81](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L81) ___ @@ -124,7 +124,7 @@ A MerkleMapWitness, which can be used to assert changes to the MerkleMap, and th #### Defined in -[lib/merkle_map.ts:90](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L90) +[lib/merkle_map.ts:90](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L90) ___ @@ -147,4 +147,4 @@ Sets a key of the merkle map to a given value. #### Defined in -[lib/merkle_map.ts:58](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L58) +[lib/merkle_map.ts:58](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L58) diff --git a/docs/zkapps/snarkyjs-reference/classes/MerkleMapWitness.md b/docs/zkapps/snarkyjs-reference/classes/MerkleMapWitness.md index 135c347f4..134af9307 100644 --- a/docs/zkapps/snarkyjs-reference/classes/MerkleMapWitness.md +++ b/docs/zkapps/snarkyjs-reference/classes/MerkleMapWitness.md @@ -60,7 +60,7 @@ #### Defined in -[lib/merkle_map.ts:121](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L121) +[lib/merkle_map.ts:121](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L121) ## Properties @@ -70,7 +70,7 @@ #### Defined in -[lib/merkle_map.ts:118](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L118) +[lib/merkle_map.ts:118](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L118) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[lib/merkle_map.ts:119](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L119) +[lib/merkle_map.ts:119](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L119) ## Methods @@ -104,7 +104,7 @@ ___ #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -128,7 +128,7 @@ A tuple of the computed merkle root, and the key that is connected to the path u #### Defined in -[lib/merkle_map.ts:132](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L132) +[lib/merkle_map.ts:132](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L132) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -255,7 +255,7 @@ ___ #### Defined in -[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) +[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) +[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) ___ @@ -348,7 +348,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -384,7 +384,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -415,7 +415,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -446,7 +446,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -477,7 +477,7 @@ ___ #### Defined in -[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) +[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) ___ @@ -508,4 +508,4 @@ ___ #### Defined in -[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) +[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) diff --git a/docs/zkapps/snarkyjs-reference/classes/MerkleTree.md b/docs/zkapps/snarkyjs-reference/classes/MerkleTree.md index 92932e475..8116c3699 100644 --- a/docs/zkapps/snarkyjs-reference/classes/MerkleTree.md +++ b/docs/zkapps/snarkyjs-reference/classes/MerkleTree.md @@ -51,7 +51,7 @@ Creates a new, empty [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). #### Defined in -[lib/merkle_tree.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L37) +[lib/merkle_tree.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L37) ## Properties @@ -63,7 +63,7 @@ The height of Merkle Tree. #### Defined in -[lib/merkle_tree.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L37) +[lib/merkle_tree.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L37) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[lib/merkle_tree.ts:29](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L29) +[lib/merkle_tree.ts:29](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L29) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[lib/merkle_tree.ts:30](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L30) +[lib/merkle_tree.ts:30](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L30) ## Accessors @@ -101,7 +101,7 @@ Amount of leaf nodes. #### Defined in -[lib/merkle_tree.ts:145](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L145) +[lib/merkle_tree.ts:145](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L145) ## Methods @@ -123,7 +123,7 @@ Fills all leaves of the tree. #### Defined in -[lib/merkle_tree.ts:135](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L135) +[lib/merkle_tree.ts:135](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L135) ___ @@ -148,7 +148,7 @@ The data of the node. #### Defined in -[lib/merkle_tree.ts:50](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L50) +[lib/merkle_tree.ts:50](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L50) ___ @@ -166,7 +166,7 @@ The root of the Merkle Tree. #### Defined in -[lib/merkle_tree.ts:58](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L58) +[lib/merkle_tree.ts:58](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L58) ___ @@ -190,7 +190,7 @@ The witness that belongs to the leaf. #### Defined in -[lib/merkle_tree.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L96) +[lib/merkle_tree.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L96) ___ @@ -213,7 +213,7 @@ Sets the value of a leaf node at a given index to a given value. #### Defined in -[lib/merkle_tree.ts:73](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L73) +[lib/merkle_tree.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L73) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -[lib/merkle_tree.ts:63](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L63) +[lib/merkle_tree.ts:63](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L63) ___ @@ -259,4 +259,4 @@ True if the witness for the leaf node is valid. #### Defined in -[lib/merkle_tree.ts:118](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L118) +[lib/merkle_tree.ts:118](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L118) diff --git a/docs/zkapps/snarkyjs-reference/classes/PrivateKey.md b/docs/zkapps/snarkyjs-reference/classes/PrivateKey.md index 72713b52a..f3980813f 100644 --- a/docs/zkapps/snarkyjs-reference/classes/PrivateKey.md +++ b/docs/zkapps/snarkyjs-reference/classes/PrivateKey.md @@ -61,7 +61,7 @@ A signing key. You can generate one via [random](PrivateKey.md#random). #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) ## Properties @@ -71,7 +71,7 @@ A signing key. You can generate one via [random](PrivateKey.md#random). #### Defined in -[lib/signature.ts:18](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L18) +[lib/signature.ts:18](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L18) ## Methods @@ -95,7 +95,7 @@ A signing key. You can generate one via [random](PrivateKey.md#random). #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -155,7 +155,7 @@ a base58 encoded string #### Defined in -[lib/signature.ts:64](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L64) +[lib/signature.ts:64](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L64) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -227,7 +227,7 @@ a [PublicKey](Types.PublicKey.md). #### Defined in -[lib/signature.ts:46](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L46) +[lib/signature.ts:46](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L46) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) +[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) ___ @@ -282,7 +282,7 @@ a [PrivateKey](PrivateKey.md). #### Defined in -[lib/signature.ts:55](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L55) +[lib/signature.ts:55](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L55) ___ @@ -306,7 +306,7 @@ a [PrivateKey](PrivateKey.md). #### Defined in -[lib/signature.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L37) +[lib/signature.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L37) ___ @@ -337,7 +337,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) +[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -419,7 +419,7 @@ a new [PrivateKey](PrivateKey.md). #### Defined in -[lib/signature.ts:27](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L27) +[lib/signature.ts:27](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L27) ___ @@ -437,7 +437,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -455,7 +455,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -480,7 +480,7 @@ a base58 encoded string #### Defined in -[lib/signature.ts:73](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L73) +[lib/signature.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L73) ___ @@ -511,7 +511,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -542,7 +542,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -573,7 +573,7 @@ ___ #### Defined in -[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) +[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) ___ @@ -604,4 +604,4 @@ ___ #### Defined in -[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) +[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) diff --git a/docs/zkapps/snarkyjs-reference/classes/Proof.md b/docs/zkapps/snarkyjs-reference/classes/Proof.md index b320cac11..002d4ec2e 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Proof.md +++ b/docs/zkapps/snarkyjs-reference/classes/Proof.md @@ -62,7 +62,7 @@ #### Defined in -[lib/proof_system.ts:139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L139) +[lib/proof_system.ts:132](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L132) ## Properties @@ -72,7 +72,7 @@ #### Defined in -[lib/proof_system.ts:97](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L97) +[lib/proof_system.ts:90](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L90) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[lib/proof_system.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L96) +[lib/proof_system.ts:89](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L89) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[lib/proof_system.ts:94](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L94) +[lib/proof_system.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L87) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[lib/proof_system.ts:95](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L95) +[lib/proof_system.ts:88](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L88) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[lib/proof_system.ts:98](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L98) +[lib/proof_system.ts:91](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L91) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[lib/proof_system.ts:86](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L86) +[lib/proof_system.ts:79](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L79) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[lib/proof_system.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L87) +[lib/proof_system.ts:80](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L80) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[lib/proof_system.ts:88](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L88) +[lib/proof_system.ts:81](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L81) ## Methods @@ -168,7 +168,7 @@ ___ #### Defined in -[lib/proof_system.ts:106](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L106) +[lib/proof_system.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L99) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[lib/proof_system.ts:100](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L100) +[lib/proof_system.ts:93](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L93) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[lib/proof_system.ts:103](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L103) +[lib/proof_system.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L96) ___ @@ -229,4 +229,4 @@ ___ #### Defined in -[lib/proof_system.ts:115](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L115) +[lib/proof_system.ts:108](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L108) diff --git a/docs/zkapps/snarkyjs-reference/classes/Scalar.md b/docs/zkapps/snarkyjs-reference/classes/Scalar.md index b44cef5e8..d668dc025 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Scalar.md +++ b/docs/zkapps/snarkyjs-reference/classes/Scalar.md @@ -56,7 +56,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:906](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L906) +[snarky.d.ts:842](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L842) ___ @@ -79,7 +79,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:924](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L924) +[snarky.d.ts:860](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L860) ___ @@ -102,7 +102,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:918](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L918) +[snarky.d.ts:854](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L854) ___ @@ -119,7 +119,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:900](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L900) +[snarky.d.ts:836](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L836) ___ @@ -142,7 +142,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:912](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L912) +[snarky.d.ts:848](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L848) ___ @@ -162,7 +162,7 @@ Check out [toFieldsCompressed](Scalar.md#tofieldscompressed) for a user-friendly #### Defined in -[snarky.d.ts:886](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L886) +[snarky.d.ts:822](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L822) ___ @@ -178,7 +178,7 @@ Serializes this Scalar to a string #### Defined in -[snarky.d.ts:929](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L929) +[snarky.d.ts:865](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L865) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[snarky.d.ts:971](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L971) +[snarky.d.ts:907](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L907) ___ @@ -221,7 +221,7 @@ If the bigint is too large, it is reduced modulo the scalar field order. #### Defined in -[snarky.d.ts:970](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L970) +[snarky.d.ts:906](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L906) ___ @@ -243,7 +243,7 @@ Creates a data structure from an array of serialized [Bool](Bool.md). #### Defined in -[snarky.d.ts:950](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L950) +[snarky.d.ts:886](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L886) ___ @@ -265,7 +265,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:942](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L942) +[snarky.d.ts:878](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L878) ___ @@ -288,7 +288,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:965](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L965) +[snarky.d.ts:901](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L901) ___ @@ -305,7 +305,7 @@ Randomness can not be proven inside a circuit! #### Defined in -[snarky.d.ts:955](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L955) +[snarky.d.ts:891](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L891) ___ @@ -321,7 +321,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:946](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L946) +[snarky.d.ts:882](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L882) ___ @@ -343,7 +343,7 @@ Static method to serialize a [Scalar](Scalar.md) into its auxiliary data. #### Defined in -[snarky.d.ts:938](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L938) +[snarky.d.ts:874](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L874) ___ @@ -365,7 +365,7 @@ Static method to serialize a [Scalar](Scalar.md) into an array of [Field](Field. #### Defined in -[snarky.d.ts:934](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L934) +[snarky.d.ts:870](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L870) ___ @@ -395,7 +395,7 @@ is needed to represent all Scalars. However, for a random Scalar, the high bit w #### Defined in -[snarky.d.ts:894](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L894) +[snarky.d.ts:830](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L830) ___ @@ -418,4 +418,4 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:960](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L960) +[snarky.d.ts:896](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L896) diff --git a/docs/zkapps/snarkyjs-reference/classes/SelfProof.md b/docs/zkapps/snarkyjs-reference/classes/SelfProof.md index b913f8c45..f98c92140 100644 --- a/docs/zkapps/snarkyjs-reference/classes/SelfProof.md +++ b/docs/zkapps/snarkyjs-reference/classes/SelfProof.md @@ -66,7 +66,7 @@ #### Defined in -[lib/proof_system.ts:139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L139) +[lib/proof_system.ts:132](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L132) ## Properties @@ -80,7 +80,7 @@ #### Defined in -[lib/proof_system.ts:97](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L97) +[lib/proof_system.ts:90](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L90) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[lib/proof_system.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L96) +[lib/proof_system.ts:89](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L89) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[lib/proof_system.ts:94](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L94) +[lib/proof_system.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L87) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[lib/proof_system.ts:95](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L95) +[lib/proof_system.ts:88](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L88) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[lib/proof_system.ts:98](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L98) +[lib/proof_system.ts:91](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L91) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[lib/proof_system.ts:86](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L86) +[lib/proof_system.ts:79](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L79) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[lib/proof_system.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L87) +[lib/proof_system.ts:80](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L80) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[lib/proof_system.ts:88](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L88) +[lib/proof_system.ts:81](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L81) ## Methods @@ -208,7 +208,7 @@ ___ #### Defined in -[lib/proof_system.ts:106](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L106) +[lib/proof_system.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L99) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[lib/proof_system.ts:100](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L100) +[lib/proof_system.ts:93](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L93) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[lib/proof_system.ts:103](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L103) +[lib/proof_system.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L96) ___ @@ -281,4 +281,4 @@ ___ #### Defined in -[lib/proof_system.ts:115](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L115) +[lib/proof_system.ts:108](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L108) diff --git a/docs/zkapps/snarkyjs-reference/classes/Sign.md b/docs/zkapps/snarkyjs-reference/classes/Sign.md index 16de2f2b7..6aca67d46 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Sign.md +++ b/docs/zkapps/snarkyjs-reference/classes/Sign.md @@ -67,7 +67,7 @@ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) ## Properties @@ -77,7 +77,7 @@ #### Defined in -[lib/int.ts:711](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L711) +[lib/int.ts:715](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L715) ## Accessors @@ -91,7 +91,7 @@ #### Defined in -[lib/int.ts:716](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L716) +[lib/int.ts:720](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L720) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[lib/int.ts:713](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L713) +[lib/int.ts:717](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L717) ## Methods @@ -129,7 +129,7 @@ ___ #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -[lib/int.ts:745](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L745) +[lib/int.ts:749](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L749) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -[lib/int.ts:742](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L742) +[lib/int.ts:746](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L746) ___ @@ -219,7 +219,7 @@ ___ #### Defined in -[lib/int.ts:739](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L739) +[lib/int.ts:743](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L743) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -255,7 +255,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -273,7 +273,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -287,7 +287,7 @@ ___ #### Defined in -[lib/int.ts:748](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L748) +[lib/int.ts:752](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L752) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[lib/int.ts:719](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L719) +[lib/int.ts:723](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L723) ___ @@ -325,7 +325,7 @@ ___ #### Defined in -[lib/int.ts:723](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L723) +[lib/int.ts:727](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L727) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[lib/int.ts:734](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L734) +[lib/int.ts:738](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L738) ___ @@ -417,7 +417,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -435,7 +435,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -453,7 +453,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -484,7 +484,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -515,7 +515,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -539,7 +539,7 @@ ___ #### Defined in -[lib/int.ts:726](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L726) +[lib/int.ts:730](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L730) ___ @@ -563,4 +563,4 @@ ___ #### Defined in -[lib/int.ts:729](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L729) +[lib/int.ts:733](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L733) diff --git a/docs/zkapps/snarkyjs-reference/classes/Signature.md b/docs/zkapps/snarkyjs-reference/classes/Signature.md index a7e265ca0..d07f1676f 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Signature.md +++ b/docs/zkapps/snarkyjs-reference/classes/Signature.md @@ -60,7 +60,7 @@ A Schnorr [Signature](Signature.md) over the Pasta Curves. #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) ## Properties @@ -70,7 +70,7 @@ A Schnorr [Signature](Signature.md) over the Pasta Curves. #### Defined in -[lib/signature.ts:191](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L191) +[lib/signature.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L191) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[lib/signature.ts:192](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L192) +[lib/signature.ts:192](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L192) ## Methods @@ -104,7 +104,7 @@ ___ #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -162,7 +162,7 @@ Encodes a [Signature](Signature.md) in base58 format. #### Defined in -[lib/signature.ts:252](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L252) +[lib/signature.ts:252](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L252) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -241,7 +241,7 @@ a [Bool](Bool.md) #### Defined in -[lib/signature.ts:226](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L226) +[lib/signature.ts:226](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L226) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) +[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) ___ @@ -297,7 +297,7 @@ a [Signature](Signature.md) #### Defined in -[lib/signature.ts:198](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L198) +[lib/signature.ts:198](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L198) ___ @@ -319,7 +319,7 @@ Decodes a base58 encoded signature into a [Signature](Signature.md). #### Defined in -[lib/signature.ts:242](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L242) +[lib/signature.ts:242](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L242) ___ @@ -350,7 +350,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -381,7 +381,7 @@ ___ #### Defined in -[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) +[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) ___ @@ -412,7 +412,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -430,7 +430,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -448,7 +448,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -479,7 +479,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -510,7 +510,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -541,7 +541,7 @@ ___ #### Defined in -[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) +[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) ___ @@ -572,4 +572,4 @@ ___ #### Defined in -[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) +[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) diff --git a/docs/zkapps/snarkyjs-reference/classes/SmartContract.md b/docs/zkapps/snarkyjs-reference/classes/SmartContract.md index 9ddd18e7c..fa314cc0a 100644 --- a/docs/zkapps/snarkyjs-reference/classes/SmartContract.md +++ b/docs/zkapps/snarkyjs-reference/classes/SmartContract.md @@ -73,7 +73,7 @@ class YourSmartContract extends SmartContract { #### Defined in -[lib/zkapp.ts:638](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L638) +[lib/zkapp.ts:635](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L635) ## Properties @@ -90,7 +90,7 @@ class YourSmartContract extends SmartContract { #### Defined in -[lib/zkapp.ts:888](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L888) +[lib/zkapp.ts:882](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L882) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[lib/zkapp.ts:610](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L610) +[lib/zkapp.ts:607](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L607) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[lib/zkapp.ts:607](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L607) +[lib/zkapp.ts:604](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L604) ___ @@ -126,7 +126,7 @@ A list of event types that can be emitted using this.emitEvent()`. #### Defined in -[lib/zkapp.ts:999](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L999) +[lib/zkapp.ts:993](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L993) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[lib/zkapp.ts:608](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L608) +[lib/zkapp.ts:605](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L605) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[lib/zkapp.ts:623](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L623) +[lib/zkapp.ts:620](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L620) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[lib/zkapp.ts:612](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L612) +[lib/zkapp.ts:609](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L609) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[lib/zkapp.ts:611](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L611) +[lib/zkapp.ts:608](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L608) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[lib/zkapp.ts:622](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L622) +[lib/zkapp.ts:619](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L619) ___ @@ -193,7 +193,7 @@ ___ #### Defined in -[lib/zkapp.ts:624](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L624) +[lib/zkapp.ts:621](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L621) ## Accessors @@ -209,7 +209,7 @@ Current account of the [SmartContract](SmartContract.md). #### Defined in -[lib/zkapp.ts:919](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L919) +[lib/zkapp.ts:913](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L913) ___ @@ -230,7 +230,7 @@ Balance of this [SmartContract](SmartContract.md). #### Defined in -[lib/zkapp.ts:993](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L993) +[lib/zkapp.ts:987](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L987) ___ @@ -248,7 +248,7 @@ or `assertEquals()` (confusing, because the developer can't know the exact slot #### Defined in -[lib/zkapp.ts:933](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L933) +[lib/zkapp.ts:927](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L927) ___ @@ -264,7 +264,7 @@ Current network state of the [SmartContract](SmartContract.md). #### Defined in -[lib/zkapp.ts:925](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L925) +[lib/zkapp.ts:919](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L919) ___ @@ -280,7 +280,7 @@ Returns the current [AccountUpdate](AccountUpdate.md) associated to this [SmartC #### Defined in -[lib/zkapp.ts:845](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L845) +[lib/zkapp.ts:839](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L839) ___ @@ -301,7 +301,7 @@ A malicious prover could use any other public key without affecting the validity #### Defined in -[lib/zkapp.ts:898](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L898) +[lib/zkapp.ts:892](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L892) ___ @@ -326,7 +326,7 @@ Token of the [SmartContract](SmartContract.md). #### Defined in -[lib/zkapp.ts:939](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L939) +[lib/zkapp.ts:933](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L933) ___ @@ -348,7 +348,7 @@ use `this.account.tokenSymbol` #### Defined in -[lib/zkapp.ts:987](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L987) +[lib/zkapp.ts:981](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L981) ## Methods @@ -388,7 +388,7 @@ The account update that was approved (needed when passing in a Callback) #### Defined in -[lib/zkapp.ts:965](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L965) +[lib/zkapp.ts:959](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L959) ___ @@ -422,7 +422,7 @@ tx.sign([senderKey, zkAppKey]); #### Defined in -[lib/zkapp.ts:728](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L728) +[lib/zkapp.ts:725](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L725) ___ @@ -451,7 +451,7 @@ Emits an event. Events will be emitted as a part of the transaction and can be c #### Defined in -[lib/zkapp.ts:1005](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1005) +[lib/zkapp.ts:999](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L999) ___ @@ -491,13 +491,13 @@ A promise that resolves to an array of objects, each containing the event type a #### Defined in -[lib/zkapp.ts:1051](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1051) +[lib/zkapp.ts:1045](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1045) ___ ### init -▸ **init**(`zkappKey?`): `void` +▸ **init**(): `void` `SmartContract.init()` will be called only when a [SmartContract](SmartContract.md) will be first deployed, not for redeployment. This method can be overridden as follows @@ -511,19 +511,13 @@ class MyContract extends SmartContract { } ``` -#### Parameters - -| Name | Type | -| :------ | :------ | -| `zkappKey?` | [`PrivateKey`](PrivateKey.md) | - #### Returns `void` #### Defined in -[lib/zkapp.ts:798](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L798) +[lib/zkapp.ts:794](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L794) ___ @@ -539,7 +533,7 @@ Same as `SmartContract.self` but explicitly creates a new [AccountUpdate](Accoun #### Defined in -[lib/zkapp.ts:880](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L880) +[lib/zkapp.ts:874](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L874) ___ @@ -563,7 +557,7 @@ with the only difference being that quick mock proofs are filled in instead of r #### Defined in -[lib/zkapp.ts:821](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L821) +[lib/zkapp.ts:815](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L815) ___ @@ -585,7 +579,7 @@ ___ #### Defined in -[lib/zkapp.ts:977](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L977) +[lib/zkapp.ts:971](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L971) ___ @@ -609,7 +603,7 @@ use `this.account.permissions.set()` #### Defined in -[lib/zkapp.ts:1231](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1231) +[lib/zkapp.ts:1225](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1225) ___ @@ -640,7 +634,7 @@ use `this.account..set()` #### Defined in -[lib/zkapp.ts:1224](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1224) +[lib/zkapp.ts:1218](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1218) ___ @@ -664,7 +658,7 @@ ___ #### Defined in -[lib/zkapp.ts:827](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L827) +[lib/zkapp.ts:821](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L821) ___ @@ -685,7 +679,7 @@ authorization flow. #### Defined in -[lib/zkapp.ts:838](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L838) +[lib/zkapp.ts:832](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L832) ___ @@ -701,7 +695,7 @@ typeof `__class` #### Defined in -[lib/zkapp.ts:629](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L629) +[lib/zkapp.ts:626](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L626) ___ @@ -734,7 +728,7 @@ an object, keyed by method name, each entry containing: #### Defined in -[lib/zkapp.ts:1171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1171) +[lib/zkapp.ts:1165](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1165) ___ @@ -761,7 +755,7 @@ up to several minutes if your circuit is large or your hardware is not optimal f #### Defined in -[lib/zkapp.ts:665](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L665) +[lib/zkapp.ts:662](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L662) ___ @@ -781,7 +775,7 @@ the digest, as a hex string #### Defined in -[lib/zkapp.ts:707](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L707) +[lib/zkapp.ts:704](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L704) ___ @@ -801,4 +795,4 @@ ___ #### Defined in -[lib/zkapp.ts:1145](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1145) +[lib/zkapp.ts:1139](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1139) diff --git a/docs/zkapps/snarkyjs-reference/classes/Token.md b/docs/zkapps/snarkyjs-reference/classes/Token.md index 03050f11a..8c2f73e7e 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Token.md +++ b/docs/zkapps/snarkyjs-reference/classes/Token.md @@ -37,7 +37,7 @@ use `TokenId` instead of `Token.Id` and `TokenId.derive()` instead of `Token.get #### Defined in -[lib/account_update.ts:630](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L630) +[lib/account_update.ts:630](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L630) ## Properties @@ -47,7 +47,7 @@ use `TokenId` instead of `Token.Id` and `TokenId.derive()` instead of `Token.get #### Defined in -[lib/account_update.ts:627](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L627) +[lib/account_update.ts:627](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L627) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[lib/account_update.ts:628](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L628) +[lib/account_update.ts:628](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L628) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[lib/account_update.ts:629](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L629) +[lib/account_update.ts:629](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L629) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[lib/account_update.ts:621](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L621) +[lib/account_update.ts:621](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L621) ## Methods @@ -116,4 +116,4 @@ ___ #### Defined in -[lib/account_update.ts:623](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L623) +[lib/account_update.ts:623](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L623) diff --git a/docs/zkapps/snarkyjs-reference/classes/TokenSymbol.md b/docs/zkapps/snarkyjs-reference/classes/TokenSymbol.md index bd3b2f6ce..abcad20b2 100644 --- a/docs/zkapps/snarkyjs-reference/classes/TokenSymbol.md +++ b/docs/zkapps/snarkyjs-reference/classes/TokenSymbol.md @@ -54,7 +54,7 @@ Struct(TokenSymbolPure).constructor #### Defined in -[lib/circuit_value.ts:467](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L467) +[lib/circuit_value.ts:365](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L365) ## Properties @@ -68,7 +68,7 @@ Struct(TokenSymbolPure).field #### Defined in -[lib/hash.ts:141](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L141) +[lib/hash.ts:137](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L137) ___ @@ -82,7 +82,7 @@ Struct(TokenSymbolPure).symbol #### Defined in -[lib/hash.ts:141](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L141) +[lib/hash.ts:137](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L137) ___ @@ -96,7 +96,7 @@ Struct(TokenSymbolPure).\_isStruct #### Defined in -[lib/circuit_value.ts:467](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L467) +[lib/circuit_value.ts:365](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L365) ___ @@ -126,7 +126,7 @@ Struct(TokenSymbolPure).check #### Defined in -[snarky.d.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L37) +[snarky.d.ts:30](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L30) ___ @@ -160,7 +160,7 @@ Struct(TokenSymbolPure).fromFields #### Defined in -[snarky.d.ts:35](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L35) +[snarky.d.ts:28](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L28) ___ @@ -193,7 +193,7 @@ Struct(TokenSymbolPure).fromJSON #### Defined in -[lib/circuit_value.ts:475](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L475) +[lib/circuit_value.ts:373](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L373) ___ @@ -223,7 +223,7 @@ Struct(TokenSymbolPure).toAuxiliary #### Defined in -[snarky.d.ts:34](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L34) +[snarky.d.ts:27](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L27) ___ @@ -253,7 +253,7 @@ Struct(TokenSymbolPure).toFields #### Defined in -[snarky.d.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L33) +[snarky.d.ts:26](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L26) ___ @@ -288,7 +288,7 @@ Struct(TokenSymbolPure).toInput #### Defined in -[lib/circuit_value.ts:470](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L470) +[lib/circuit_value.ts:368](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L368) ___ @@ -318,7 +318,7 @@ Struct(TokenSymbolPure).toJSON #### Defined in -[lib/circuit_value.ts:474](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L474) +[lib/circuit_value.ts:372](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L372) ## Accessors @@ -337,7 +337,7 @@ Struct(TokenSymbolPure).toJSON #### Defined in -[lib/hash.ts:172](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L172) +[lib/hash.ts:168](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L168) ## Methods @@ -357,7 +357,7 @@ Struct(TokenSymbolPure).toJSON #### Defined in -[lib/hash.ts:176](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L176) +[lib/hash.ts:172](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L172) ___ @@ -375,4 +375,4 @@ Struct(TokenSymbolPure).sizeInFields #### Defined in -[snarky.d.ts:36](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L36) +[snarky.d.ts:29](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L29) diff --git a/docs/zkapps/snarkyjs-reference/classes/Types.PublicKey.md b/docs/zkapps/snarkyjs-reference/classes/Types.PublicKey.md index e26e838dd..6d7d46dc8 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Types.PublicKey.md +++ b/docs/zkapps/snarkyjs-reference/classes/Types.PublicKey.md @@ -68,7 +68,7 @@ You can derive a [PublicKey](Types.PublicKey.md) directly from a [PrivateKey](Pr #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) ## Properties @@ -78,7 +78,7 @@ You can derive a [PublicKey](Types.PublicKey.md) directly from a [PrivateKey](Pr #### Defined in -[lib/signature.ts:86](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L86) +[lib/signature.ts:86](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L86) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[lib/signature.ts:85](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L85) +[lib/signature.ts:85](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L85) ## Methods @@ -112,7 +112,7 @@ ___ #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -172,7 +172,7 @@ a [Bool](Bool.md) #### Defined in -[lib/signature.ts:143](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L143) +[lib/signature.ts:143](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L143) ___ @@ -190,7 +190,7 @@ a base58 encoded [PublicKey](Types.PublicKey.md) #### Defined in -[lib/signature.ts:160](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L160) +[lib/signature.ts:160](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L160) ___ @@ -208,7 +208,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -244,7 +244,7 @@ A [Group](Group.md) #### Defined in -[lib/signature.ts:92](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L92) +[lib/signature.ts:92](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L92) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -293,7 +293,7 @@ ___ #### Defined in -[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) +[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) ___ @@ -311,7 +311,7 @@ an empty [PublicKey](Types.PublicKey.md) #### Defined in -[lib/signature.ts:135](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L135) +[lib/signature.ts:135](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L135) ___ @@ -337,7 +337,7 @@ a [PublicKey](Types.PublicKey.md). #### Defined in -[lib/signature.ts:127](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L127) +[lib/signature.ts:127](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L127) ___ @@ -361,7 +361,7 @@ a [PublicKey](Types.PublicKey.md) #### Defined in -[lib/signature.ts:152](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L152) +[lib/signature.ts:152](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L152) ___ @@ -392,7 +392,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -416,7 +416,7 @@ a [PublicKey](Types.PublicKey.md). #### Defined in -[lib/signature.ts:110](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L110) +[lib/signature.ts:110](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L110) ___ @@ -451,7 +451,7 @@ a JSON string #### Defined in -[lib/signature.ts:182](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L182) +[lib/signature.ts:182](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L182) ___ @@ -482,7 +482,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -506,7 +506,7 @@ a [PublicKey](Types.PublicKey.md). #### Defined in -[lib/signature.ts:119](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L119) +[lib/signature.ts:119](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L119) ___ @@ -524,7 +524,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -542,7 +542,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -566,7 +566,7 @@ a base58 encoded [PublicKey](Types.PublicKey.md) #### Defined in -[lib/signature.ts:168](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L168) +[lib/signature.ts:168](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L168) ___ @@ -597,7 +597,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -628,7 +628,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -659,7 +659,7 @@ ___ #### Defined in -[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) +[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) ___ @@ -687,4 +687,4 @@ a JSON string #### Defined in -[lib/signature.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L175) +[lib/signature.ts:175](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L175) diff --git a/docs/zkapps/snarkyjs-reference/classes/UInt32.md b/docs/zkapps/snarkyjs-reference/classes/UInt32.md index 6aa9d567d..d091380e2 100644 --- a/docs/zkapps/snarkyjs-reference/classes/UInt32.md +++ b/docs/zkapps/snarkyjs-reference/classes/UInt32.md @@ -89,7 +89,7 @@ A 32 bit unsigned integer with values ranging from 0 to 4,294,967,295. #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) ## Properties @@ -99,7 +99,7 @@ A 32 bit unsigned integer with values ranging from 0 to 4,294,967,295. #### Defined in -[lib/int.ts:377](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L377) +[lib/int.ts:380](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L380) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -[lib/int.ts:378](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L378) +[lib/int.ts:381](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L381) ## Accessors @@ -125,7 +125,7 @@ Static method to create a [UInt32](UInt32.md) with value `0`. #### Defined in -[lib/int.ts:390](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L390) +[lib/int.ts:393](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L393) ___ @@ -141,7 +141,7 @@ Static method to create a [UInt32](UInt32.md) with value `0`. #### Defined in -[lib/int.ts:383](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L383) +[lib/int.ts:386](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L386) ## Methods @@ -163,7 +163,7 @@ Addition with overflow checking. #### Defined in -[lib/int.ts:529](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L529) +[lib/int.ts:532](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L532) ___ @@ -187,7 +187,7 @@ ___ #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -210,7 +210,7 @@ Asserts that a [UInt32](UInt32.md) is greater than another one. #### Defined in -[lib/int.ts:672](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L672) +[lib/int.ts:675](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L675) ___ @@ -233,7 +233,7 @@ Asserts that a [UInt32](UInt32.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:705](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L705) +[lib/int.ts:708](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L708) ___ @@ -260,7 +260,7 @@ Asserts that a [UInt32](UInt32.md) is greater than another one. #### Defined in -[lib/int.ts:665](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L665) +[lib/int.ts:668](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L668) ___ @@ -287,7 +287,7 @@ Asserts that a [UInt32](UInt32.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:698](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L698) +[lib/int.ts:701](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L701) ___ @@ -310,7 +310,7 @@ Asserts that a [UInt32](UInt32.md) is less than another one. #### Defined in -[lib/int.ts:640](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L640) +[lib/int.ts:643](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L643) ___ @@ -333,7 +333,7 @@ Asserts that a [UInt32](UInt32.md) is less than or equal to another one. #### Defined in -[lib/int.ts:598](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L598) +[lib/int.ts:601](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L601) ___ @@ -360,7 +360,7 @@ Asserts that a [UInt32](UInt32.md) is less than another one. #### Defined in -[lib/int.ts:633](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L633) +[lib/int.ts:636](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L636) ___ @@ -387,7 +387,7 @@ Asserts that a [UInt32](UInt32.md) is less than or equal to another one. #### Defined in -[lib/int.ts:591](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L591) +[lib/int.ts:594](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L594) ___ @@ -412,7 +412,7 @@ Integer division. #### Defined in -[lib/int.ts:506](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L506) +[lib/int.ts:509](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L509) ___ @@ -441,7 +441,7 @@ Integer division with remainder. #### Defined in -[lib/int.ts:464](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L464) +[lib/int.ts:467](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L467) ___ @@ -465,7 +465,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -487,7 +487,7 @@ Checks if a [UInt32](UInt32.md) is greater than another one. #### Defined in -[lib/int.ts:656](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L656) +[lib/int.ts:659](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L659) ___ @@ -509,7 +509,7 @@ Checks if a [UInt32](UInt32.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:688](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L688) +[lib/int.ts:691](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L691) ___ @@ -535,7 +535,7 @@ Checks if a [UInt32](UInt32.md) is greater than another one. #### Defined in -[lib/int.ts:649](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L649) +[lib/int.ts:652](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L652) ___ @@ -561,7 +561,7 @@ Checks if a [UInt32](UInt32.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:681](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L681) +[lib/int.ts:684](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L684) ___ @@ -579,7 +579,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -601,7 +601,7 @@ Checks if a [UInt32](UInt32.md) is less than another one. #### Defined in -[lib/int.ts:624](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L624) +[lib/int.ts:627](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L627) ___ @@ -623,7 +623,7 @@ Checks if a [UInt32](UInt32.md) is less than or equal to another one. #### Defined in -[lib/int.ts:568](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L568) +[lib/int.ts:571](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L571) ___ @@ -649,7 +649,7 @@ Checks if a [UInt32](UInt32.md) is less than another one. #### Defined in -[lib/int.ts:617](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L617) +[lib/int.ts:620](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L620) ___ @@ -675,7 +675,7 @@ Checks if a [UInt32](UInt32.md) is less than or equal to another one. #### Defined in -[lib/int.ts:547](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L547) +[lib/int.ts:550](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L550) ___ @@ -700,7 +700,7 @@ Integer remainder. #### Defined in -[lib/int.ts:515](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L515) +[lib/int.ts:518](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L518) ___ @@ -722,7 +722,7 @@ Multiplication with overflow checking. #### Defined in -[lib/int.ts:521](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L521) +[lib/int.ts:524](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L524) ___ @@ -744,7 +744,7 @@ Subtraction with underflow checking. #### Defined in -[lib/int.ts:537](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L537) +[lib/int.ts:540](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L540) ___ @@ -760,7 +760,7 @@ Turns the [UInt32](UInt32.md) into a BigInt. #### Defined in -[lib/int.ts:402](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L402) +[lib/int.ts:405](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L405) ___ @@ -778,7 +778,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -796,7 +796,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -814,7 +814,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -830,7 +830,7 @@ Turns the [UInt32](UInt32.md) into a string. #### Defined in -[lib/int.ts:396](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L396) +[lib/int.ts:399](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L399) ___ @@ -846,7 +846,7 @@ Turns the [UInt32](UInt32.md) into a [UInt64](UInt64.md). #### Defined in -[lib/int.ts:408](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L408) +[lib/int.ts:411](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L411) ___ @@ -862,7 +862,7 @@ Creates a [UInt32](UInt32.md) with a value of 4,294,967,295. #### Defined in -[lib/int.ts:456](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L456) +[lib/int.ts:459](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L459) ___ @@ -886,7 +886,7 @@ ___ #### Defined in -[lib/int.ts:413](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L413) +[lib/int.ts:416](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L416) ___ @@ -906,7 +906,7 @@ ___ #### Defined in -[lib/int.ts:434](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L434) +[lib/int.ts:437](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L437) ___ @@ -928,7 +928,7 @@ Creates a new [UInt32](UInt32.md). #### Defined in -[lib/int.ts:449](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L449) +[lib/int.ts:452](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L452) ___ @@ -959,7 +959,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -991,7 +991,7 @@ Decodes a JSON-like object into this structure. #### Defined in -[lib/int.ts:430](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L430) +[lib/int.ts:433](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L433) ___ @@ -1022,7 +1022,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -1040,7 +1040,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -1058,7 +1058,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -1089,7 +1089,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -1120,7 +1120,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -1144,7 +1144,7 @@ ___ #### Defined in -[lib/int.ts:417](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L417) +[lib/int.ts:420](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L420) ___ @@ -1170,4 +1170,4 @@ Encodes this structure into a JSON-like object. #### Defined in -[lib/int.ts:423](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L423) +[lib/int.ts:426](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L426) diff --git a/docs/zkapps/snarkyjs-reference/classes/UInt64.md b/docs/zkapps/snarkyjs-reference/classes/UInt64.md index e6b85420f..10e16e71c 100644 --- a/docs/zkapps/snarkyjs-reference/classes/UInt64.md +++ b/docs/zkapps/snarkyjs-reference/classes/UInt64.md @@ -90,7 +90,7 @@ A 64 bit unsigned integer with values ranging from 0 to 18,446,744,073,709,551,6 #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) ## Properties @@ -100,7 +100,7 @@ A 64 bit unsigned integer with values ranging from 0 to 18,446,744,073,709,551,6 #### Defined in -[lib/int.ts:14](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L14) +[lib/int.ts:16](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L16) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[lib/int.ts:15](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L15) +[lib/int.ts:17](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L17) ## Accessors @@ -126,7 +126,7 @@ Static method to create a [UInt64](UInt64.md) with value `1`. #### Defined in -[lib/int.ts:26](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L26) +[lib/int.ts:28](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L28) ___ @@ -142,7 +142,7 @@ Static method to create a [UInt64](UInt64.md) with value `0`. #### Defined in -[lib/int.ts:20](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L20) +[lib/int.ts:22](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L22) ## Methods @@ -164,7 +164,7 @@ Addition with overflow checking. #### Defined in -[lib/int.ts:190](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L190) +[lib/int.ts:192](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L192) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) +[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) ___ @@ -211,7 +211,7 @@ Asserts that a [UInt64](UInt64.md) is greater than another one. #### Defined in -[lib/int.ts:337](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L337) +[lib/int.ts:339](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L339) ___ @@ -234,7 +234,7 @@ Asserts that a [UInt64](UInt64.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:369](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L369) +[lib/int.ts:371](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L371) ___ @@ -261,7 +261,7 @@ Asserts that a [UInt64](UInt64.md) is greater than another one. #### Defined in -[lib/int.ts:330](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L330) +[lib/int.ts:332](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L332) ___ @@ -288,7 +288,7 @@ Asserts that a [UInt64](UInt64.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:362](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L362) +[lib/int.ts:364](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L364) ___ @@ -311,7 +311,7 @@ Asserts that a [UInt64](UInt64.md) is less than another one. #### Defined in -[lib/int.ts:305](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L305) +[lib/int.ts:307](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L307) ___ @@ -334,7 +334,7 @@ Asserts that a [UInt64](UInt64.md) is less than or equal to another one. #### Defined in -[lib/int.ts:261](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L261) +[lib/int.ts:263](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L263) ___ @@ -361,7 +361,7 @@ Asserts that a [UInt64](UInt64.md) is less than another one. #### Defined in -[lib/int.ts:298](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L298) +[lib/int.ts:300](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L300) ___ @@ -388,7 +388,7 @@ Asserts that a [UInt64](UInt64.md) is less than or equal to another one. #### Defined in -[lib/int.ts:254](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L254) +[lib/int.ts:256](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L256) ___ @@ -413,7 +413,7 @@ Integer division. #### Defined in -[lib/int.ts:164](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L164) +[lib/int.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L166) ___ @@ -442,7 +442,7 @@ Integer division with remainder. #### Defined in -[lib/int.ts:121](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L121) +[lib/int.ts:123](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L123) ___ @@ -466,7 +466,7 @@ ___ #### Defined in -[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) +[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) ___ @@ -488,7 +488,7 @@ Checks if a [UInt64](UInt64.md) is greater than another one. #### Defined in -[lib/int.ts:321](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L321) +[lib/int.ts:323](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L323) ___ @@ -510,7 +510,7 @@ Checks if a [UInt64](UInt64.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:353](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L353) +[lib/int.ts:355](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L355) ___ @@ -536,7 +536,7 @@ Checks if a [UInt64](UInt64.md) is greater than another one. #### Defined in -[lib/int.ts:314](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L314) +[lib/int.ts:316](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L316) ___ @@ -562,7 +562,7 @@ Checks if a [UInt64](UInt64.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:346](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L346) +[lib/int.ts:348](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L348) ___ @@ -580,7 +580,7 @@ ___ #### Defined in -[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) +[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) ___ @@ -602,7 +602,7 @@ Checks if a [UInt64](UInt64.md) is less than another one. #### Defined in -[lib/int.ts:288](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L288) +[lib/int.ts:290](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L290) ___ @@ -624,7 +624,7 @@ Checks if a [UInt64](UInt64.md) is less than or equal to another one. #### Defined in -[lib/int.ts:231](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L231) +[lib/int.ts:233](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L233) ___ @@ -650,7 +650,7 @@ Checks if a [UInt64](UInt64.md) is less than another one. #### Defined in -[lib/int.ts:280](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L280) +[lib/int.ts:282](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L282) ___ @@ -676,7 +676,7 @@ Checks if a [UInt64](UInt64.md) is less than or equal to another one. #### Defined in -[lib/int.ts:210](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L210) +[lib/int.ts:212](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L212) ___ @@ -701,7 +701,7 @@ Integer remainder. #### Defined in -[lib/int.ts:174](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L174) +[lib/int.ts:176](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L176) ___ @@ -723,7 +723,7 @@ Multiplication with overflow checking. #### Defined in -[lib/int.ts:181](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L181) +[lib/int.ts:183](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L183) ___ @@ -745,7 +745,7 @@ Subtraction with underflow checking. #### Defined in -[lib/int.ts:199](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L199) +[lib/int.ts:201](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L201) ___ @@ -761,7 +761,7 @@ Turns the [UInt64](UInt64.md) into a BigInt. #### Defined in -[lib/int.ts:40](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L40) +[lib/int.ts:42](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L42) ___ @@ -779,7 +779,7 @@ ___ #### Defined in -[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) +[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) ___ @@ -797,7 +797,7 @@ ___ #### Defined in -[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) +[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) ___ @@ -815,7 +815,7 @@ ___ #### Defined in -[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) +[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) ___ @@ -831,7 +831,7 @@ Turns the [UInt64](UInt64.md) into a string. #### Defined in -[lib/int.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L33) +[lib/int.ts:35](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L35) ___ @@ -847,7 +847,7 @@ Turns the [UInt64](UInt64.md) into a [UInt32](UInt32.md), asserting that it fits #### Defined in -[lib/int.ts:47](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L47) +[lib/int.ts:49](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L49) ___ @@ -866,7 +866,7 @@ UInt64.from(4294967296).toUInt32Clamped().toString(); // "4294967295" #### Defined in -[lib/int.ts:59](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L59) +[lib/int.ts:61](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L61) ___ @@ -882,7 +882,7 @@ Creates a [UInt64](UInt64.md) with a value of 18,446,744,073,709,551,615. #### Defined in -[lib/int.ts:112](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L112) +[lib/int.ts:114](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L114) ___ @@ -906,7 +906,7 @@ ___ #### Defined in -[lib/int.ts:68](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L68) +[lib/int.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L70) ___ @@ -926,7 +926,7 @@ ___ #### Defined in -[lib/int.ts:89](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L89) +[lib/int.ts:91](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L91) ___ @@ -948,7 +948,7 @@ Creates a new [UInt64](UInt64.md). #### Defined in -[lib/int.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L104) +[lib/int.ts:106](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L106) ___ @@ -979,7 +979,7 @@ ___ #### Defined in -[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) +[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) ___ @@ -1011,7 +1011,7 @@ Decodes a JSON-like object into this structure. #### Defined in -[lib/int.ts:85](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L85) +[lib/int.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L87) ___ @@ -1042,7 +1042,7 @@ ___ #### Defined in -[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) ___ @@ -1060,7 +1060,7 @@ ___ #### Defined in -[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) +[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) ___ @@ -1078,7 +1078,7 @@ ___ #### Defined in -[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) ___ @@ -1109,7 +1109,7 @@ ___ #### Defined in -[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) +[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) ___ @@ -1140,7 +1140,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) ___ @@ -1164,7 +1164,7 @@ ___ #### Defined in -[lib/int.ts:72](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L72) +[lib/int.ts:74](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L74) ___ @@ -1190,4 +1190,4 @@ Encodes this structure into a JSON-like object. #### Defined in -[lib/int.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L78) +[lib/int.ts:80](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L80) diff --git a/docs/zkapps/snarkyjs-reference/classes/VerificationKey.md b/docs/zkapps/snarkyjs-reference/classes/VerificationKey.md index 085934c68..6d9610c33 100644 --- a/docs/zkapps/snarkyjs-reference/classes/VerificationKey.md +++ b/docs/zkapps/snarkyjs-reference/classes/VerificationKey.md @@ -54,7 +54,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:467](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L467) +[lib/circuit_value.ts:365](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L365) ## Properties @@ -73,7 +73,7 @@ Struct({ #### Defined in -[lib/zkapp.ts:1487](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1487) +[lib/zkapp.ts:1481](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1481) ___ @@ -92,7 +92,7 @@ Struct({ #### Defined in -[lib/zkapp.ts:1487](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1487) +[lib/zkapp.ts:1481](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1481) ___ @@ -111,7 +111,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:467](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L467) +[lib/circuit_value.ts:365](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L365) ___ @@ -146,7 +146,7 @@ Struct({ #### Defined in -[snarky.d.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L37) +[snarky.d.ts:30](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L30) ___ @@ -185,7 +185,7 @@ Struct({ #### Defined in -[snarky.d.ts:35](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L35) +[snarky.d.ts:28](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L28) ___ @@ -223,7 +223,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:475](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L475) +[lib/circuit_value.ts:373](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L373) ___ @@ -258,7 +258,7 @@ Struct({ #### Defined in -[snarky.d.ts:34](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L34) +[snarky.d.ts:27](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L27) ___ @@ -293,7 +293,7 @@ Struct({ #### Defined in -[snarky.d.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L33) +[snarky.d.ts:26](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L26) ___ @@ -333,7 +333,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:470](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L470) +[lib/circuit_value.ts:368](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L368) ___ @@ -368,7 +368,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:474](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L474) +[lib/circuit_value.ts:372](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L372) ## Methods @@ -391,4 +391,4 @@ Struct({ #### Defined in -[snarky.d.ts:36](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L36) +[snarky.d.ts:29](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L29) diff --git a/docs/zkapps/snarkyjs-reference/interfaces/Mina.TransactionId.md b/docs/zkapps/snarkyjs-reference/interfaces/Mina.TransactionId.md index b9b320834..deaece53a 100644 --- a/docs/zkapps/snarkyjs-reference/interfaces/Mina.TransactionId.md +++ b/docs/zkapps/snarkyjs-reference/interfaces/Mina.TransactionId.md @@ -21,7 +21,7 @@ #### Defined in -[lib/mina.ts:62](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L62) +[lib/mina.ts:63](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L63) ## Methods @@ -35,7 +35,7 @@ #### Defined in -[lib/mina.ts:64](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L64) +[lib/mina.ts:65](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L65) ___ @@ -57,4 +57,4 @@ ___ #### Defined in -[lib/mina.ts:63](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L63) +[lib/mina.ts:64](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L64) diff --git a/docs/zkapps/snarkyjs-reference/interfaces/Permissions.md b/docs/zkapps/snarkyjs-reference/interfaces/Permissions.md index e8b9f7b89..cde0a9695 100644 --- a/docs/zkapps/snarkyjs-reference/interfaces/Permissions.md +++ b/docs/zkapps/snarkyjs-reference/interfaces/Permissions.md @@ -46,7 +46,7 @@ Permissions\_.access #### Defined in -[lib/account_update.ts:233](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L233) +[lib/account_update.ts:233](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L233) ___ @@ -62,7 +62,7 @@ Permissions\_.editActionState #### Defined in -[lib/account_update.ts:212](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L212) +[lib/account_update.ts:212](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L212) ___ @@ -79,7 +79,7 @@ Permissions\_.editState #### Defined in -[lib/account_update.ts:168](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L168) +[lib/account_update.ts:168](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L168) ___ @@ -93,7 +93,7 @@ Permissions\_.incrementNonce #### Defined in -[lib/account_update.ts:221](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L221) +[lib/account_update.ts:221](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L221) ___ @@ -110,7 +110,7 @@ Permissions\_.receive #### Defined in -[lib/account_update.ts:180](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L180) +[lib/account_update.ts:180](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L180) ___ @@ -127,7 +127,7 @@ Permissions\_.send #### Defined in -[lib/account_update.ts:174](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L174) +[lib/account_update.ts:174](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L174) ___ @@ -144,7 +144,7 @@ Permissions\_.setDelegate #### Defined in -[lib/account_update.ts:186](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L186) +[lib/account_update.ts:186](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L186) ___ @@ -161,7 +161,7 @@ Permissions\_.setPermissions #### Defined in -[lib/account_update.ts:192](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L192) +[lib/account_update.ts:192](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L192) ___ @@ -175,7 +175,7 @@ Permissions\_.setTiming #### Defined in -[lib/account_update.ts:223](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L223) +[lib/account_update.ts:223](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L223) ___ @@ -192,7 +192,7 @@ Permissions\_.setTokenSymbol #### Defined in -[lib/account_update.ts:218](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L218) +[lib/account_update.ts:218](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L218) ___ @@ -210,7 +210,7 @@ Permissions\_.setVerificationKey #### Defined in -[lib/account_update.ts:199](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L199) +[lib/account_update.ts:199](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L199) ___ @@ -224,7 +224,7 @@ Permissions\_.setVotingFor #### Defined in -[lib/account_update.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L222) +[lib/account_update.ts:222](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L222) ___ @@ -243,4 +243,4 @@ Permissions\_.setZkappUri #### Defined in -[lib/account_update.ts:207](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L207) +[lib/account_update.ts:207](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L207) diff --git a/docs/zkapps/snarkyjs-reference/interfaces/Provable.md b/docs/zkapps/snarkyjs-reference/interfaces/Provable.md deleted file mode 100644 index 584bd2140..000000000 --- a/docs/zkapps/snarkyjs-reference/interfaces/Provable.md +++ /dev/null @@ -1,141 +0,0 @@ -# Interface: Provable - -`Provable` is the general circuit type interface. It describes how a type `T` is made up of field elements and auxiliary (non-field element) data. - -You will find this as the required input type in a few places in snarkyjs. One convenient way to create a `Provable` is using `Struct`. - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- **`Provable`** - - ↳ [`ProvablePure`](ProvablePure.md) - -## Table of contents - -### Properties - -- [check](Provable.md#check) -- [fromFields](Provable.md#fromfields) -- [toAuxiliary](Provable.md#toauxiliary) -- [toFields](Provable.md#tofields) - -### Methods - -- [sizeInFields](Provable.md#sizeinfields) - -## Properties - -### check - -• **check**: (`x`: `T`) => `void` - -#### Type declaration - -▸ (`x`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `x` | `T` | - -##### Returns - -`void` - -#### Defined in - -[snarky.d.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L37) - -___ - -### fromFields - -• **fromFields**: (`x`: [`Field`](../classes/Field.md)[], `aux`: `any`[]) => `T` - -#### Type declaration - -▸ (`x`, `aux`): `T` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `x` | [`Field`](../classes/Field.md)[] | -| `aux` | `any`[] | - -##### Returns - -`T` - -#### Defined in - -[snarky.d.ts:35](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L35) - -___ - -### toAuxiliary - -• **toAuxiliary**: (`x?`: `T`) => `any`[] - -#### Type declaration - -▸ (`x?`): `any`[] - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `x?` | `T` | - -##### Returns - -`any`[] - -#### Defined in - -[snarky.d.ts:34](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L34) - -___ - -### toFields - -• **toFields**: (`x`: `T`) => [`Field`](../classes/Field.md)[] - -#### Type declaration - -▸ (`x`): [`Field`](../classes/Field.md)[] - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `x` | `T` | - -##### Returns - -[`Field`](../classes/Field.md)[] - -#### Defined in - -[snarky.d.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L33) - -## Methods - -### sizeInFields - -▸ **sizeInFields**(): `number` - -#### Returns - -`number` - -#### Defined in - -[snarky.d.ts:36](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L36) diff --git a/docs/zkapps/snarkyjs-reference/interfaces/ProvablePure.md b/docs/zkapps/snarkyjs-reference/interfaces/ProvablePure.md index 770578847..d6740033b 100644 --- a/docs/zkapps/snarkyjs-reference/interfaces/ProvablePure.md +++ b/docs/zkapps/snarkyjs-reference/interfaces/ProvablePure.md @@ -13,7 +13,7 @@ Examples where `ProvablePure` is required are types of on-chain state, events ## Hierarchy -- [`Provable`](Provable.md)<`T`\> +- `Provable`<`T`\> ↳ **`ProvablePure`** @@ -52,11 +52,11 @@ Examples where `ProvablePure` is required are types of on-chain state, events #### Overrides -[Provable](Provable.md).[check](Provable.md#check) +Provable.check #### Defined in -[snarky.d.ts:50](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L50) +[snarky.d.ts:43](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L43) ___ @@ -80,11 +80,11 @@ ___ #### Overrides -[Provable](Provable.md).[fromFields](Provable.md#fromfields) +Provable.fromFields #### Defined in -[snarky.d.ts:48](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L48) +[snarky.d.ts:41](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L41) ___ @@ -108,11 +108,11 @@ ___ #### Overrides -[Provable](Provable.md).[toAuxiliary](Provable.md#toauxiliary) +Provable.toAuxiliary #### Defined in -[snarky.d.ts:47](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L47) +[snarky.d.ts:40](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L40) ___ @@ -136,11 +136,11 @@ ___ #### Overrides -[Provable](Provable.md).[toFields](Provable.md#tofields) +Provable.toFields #### Defined in -[snarky.d.ts:46](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L46) +[snarky.d.ts:39](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L39) ## Methods @@ -154,8 +154,8 @@ ___ #### Overrides -[Provable](Provable.md).[sizeInFields](Provable.md#sizeinfields) +Provable.sizeInFields #### Defined in -[snarky.d.ts:49](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L49) +[snarky.d.ts:42](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L42) diff --git a/docs/zkapps/snarkyjs-reference/modules/Encryption.md b/docs/zkapps/snarkyjs-reference/modules/Encryption.md index caefd186d..ab5476356 100644 --- a/docs/zkapps/snarkyjs-reference/modules/Encryption.md +++ b/docs/zkapps/snarkyjs-reference/modules/Encryption.md @@ -28,7 +28,7 @@ Decrypts a CipherText using a [PrivateKey](../classes/PrivateKey.md).^ #### Defined in -[lib/encryption.ts:44](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/encryption.ts#L44) +[lib/encryption.ts:45](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/encryption.ts#L45) ___ @@ -56,4 +56,4 @@ Public Key Encryption, using a given array of [Field](../classes/Field.md) eleme #### Defined in -[lib/encryption.ts:15](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/encryption.ts#L15) +[lib/encryption.ts:16](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/encryption.ts#L16) diff --git a/docs/zkapps/snarkyjs-reference/modules/Experimental.md b/docs/zkapps/snarkyjs-reference/modules/Experimental.md index 5351cdce0..47c79d844 100644 --- a/docs/zkapps/snarkyjs-reference/modules/Experimental.md +++ b/docs/zkapps/snarkyjs-reference/modules/Experimental.md @@ -33,9 +33,9 @@ This module exposes APIs that are unstable, in the sense that the API surface is #### Defined in -[index.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/index.ts#L96) +[index.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/index.ts#L96) -[index.ts:97](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/index.ts#L97) +[index.ts:97](https://github.com/o1-labs/snarkyjs/blob/8374557/src/index.ts#L97) ## Variables @@ -45,9 +45,9 @@ This module exposes APIs that are unstable, in the sense that the API surface is #### Defined in -[index.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/index.ts#L96) +[index.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/index.ts#L96) -[index.ts:97](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/index.ts#L97) +[index.ts:97](https://github.com/o1-labs/snarkyjs/blob/8374557/src/index.ts#L97) ## Functions @@ -74,7 +74,7 @@ This module exposes APIs that are unstable, in the sense that the API surface is #### Defined in -[lib/proof_system.ts:205](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L205) +[lib/proof_system.ts:198](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L198) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[lib/account_update.ts:1704](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1704) +[lib/account_update.ts:1709](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1709) ___ @@ -104,7 +104,7 @@ ___ ▸ **memoizeWitness**<`T`\>(`type`, `compute`): `T` -Like Circuit.witness, but memoizes the witness during transaction construction +Like Provable.witness, but memoizes the witness during transaction construction for reuse by the prover. This is needed to witness non-deterministic values. #### Type parameters @@ -126,4 +126,4 @@ for reuse by the prover. This is needed to witness non-deterministic values. #### Defined in -[lib/circuit_value.ts:856](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L856) +[lib/provable.ts:491](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L491) diff --git a/docs/zkapps/snarkyjs-reference/modules/Mina.md b/docs/zkapps/snarkyjs-reference/modules/Mina.md index a27cd22da..431539db1 100644 --- a/docs/zkapps/snarkyjs-reference/modules/Mina.md +++ b/docs/zkapps/snarkyjs-reference/modules/Mina.md @@ -58,7 +58,7 @@ #### Defined in -[lib/mina.ts:154](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L154) +[lib/mina.ts:155](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L155) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[lib/mina.ts:112](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L112) +[lib/mina.ts:113](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L113) ___ @@ -90,7 +90,7 @@ Allows you to specify information about the fee payer account and the transactio #### Defined in -[lib/mina.ts:125](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L125) +[lib/mina.ts:126](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L126) ___ @@ -112,9 +112,9 @@ ___ #### Defined in -[lib/mina.ts:67](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L67) +[lib/mina.ts:68](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L68) -[lib/mina.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L104) +[lib/mina.ts:105](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L105) ## Variables @@ -130,9 +130,9 @@ ___ #### Defined in -[lib/mina.ts:67](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L67) +[lib/mina.ts:68](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L68) -[lib/mina.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L104) +[lib/mina.ts:105](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L105) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[lib/mina.ts:949](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L949) +[lib/mina.ts:963](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L963) ## Functions @@ -167,7 +167,7 @@ The name `BerkeleyQANet` was misleading because it suggested that this is specif #### Defined in -[lib/mina.ts:945](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L945) +[lib/mina.ts:959](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L959) ___ @@ -215,7 +215,7 @@ A mock Mina blockchain running locally and useful for testing. #### Defined in -[lib/mina.ts:365](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L365) +[lib/mina.ts:379](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L379) ___ @@ -237,7 +237,7 @@ Represents the Mina blockchain running on a real network #### Defined in -[lib/mina.ts:650](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L650) +[lib/mina.ts:664](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L664) ▸ **Network**(`graphqlEndpoints`): `Mina` @@ -255,7 +255,7 @@ Represents the Mina blockchain running on a real network #### Defined in -[lib/mina.ts:651](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L651) +[lib/mina.ts:665](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L665) ___ @@ -271,7 +271,7 @@ Returns the default account creation fee. #### Defined in -[lib/mina.ts:1146](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1146) +[lib/mina.ts:1165](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1165) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -[lib/mina.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L167) +[lib/mina.ts:168](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L168) ___ @@ -313,7 +313,7 @@ The current slot number, according to the active Mina instance. #### Defined in -[lib/mina.ts:1111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1111) +[lib/mina.ts:1130](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1130) ___ @@ -327,7 +327,7 @@ ___ #### Defined in -[lib/global-context.ts:6](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/global-context.ts#L6) +[lib/global-context.ts:6](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/global-context.ts#L6) ___ @@ -350,7 +350,7 @@ Requests the [testnet faucet](https://faucet.minaprotocol.com/api/v1/faucet) to #### Defined in -[lib/mina.ts:1525](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1525) +[lib/mina.ts:1544](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1544) ___ @@ -374,7 +374,7 @@ A list of emitted sequencing actions associated to the given public key. #### Defined in -[lib/mina.ts:1168](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1168) +[lib/mina.ts:1187](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1187) ___ @@ -398,7 +398,7 @@ A list of emitted events associated to the given public key. #### Defined in -[lib/mina.ts:1157](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1157) +[lib/mina.ts:1176](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1176) ___ @@ -424,7 +424,7 @@ ___ #### Defined in -[lib/mina.ts:1482](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1482) +[lib/mina.ts:1501](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1501) ___ @@ -447,7 +447,7 @@ The account data associated to the given public key. #### Defined in -[lib/mina.ts:1118](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1118) +[lib/mina.ts:1137](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1137) ___ @@ -471,7 +471,7 @@ A list of emitted sequencing actions associated to the given public key. #### Defined in -[lib/mina.ts:1179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1179) +[lib/mina.ts:1198](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1198) ___ @@ -494,7 +494,7 @@ The balance associated to the given public key. #### Defined in -[lib/mina.ts:1139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1139) +[lib/mina.ts:1158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1158) ___ @@ -510,7 +510,7 @@ Data associated with the current state of the Mina network. #### Defined in -[lib/mina.ts:1132](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1132) +[lib/mina.ts:1151](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1151) ___ @@ -524,7 +524,7 @@ ___ #### Defined in -[lib/mina.ts:1187](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1187) +[lib/mina.ts:1206](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1206) ___ @@ -547,7 +547,7 @@ Checks if an account exists within the ledger. #### Defined in -[lib/mina.ts:1125](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1125) +[lib/mina.ts:1144](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1144) ___ @@ -567,7 +567,7 @@ ___ #### Defined in -[lib/mina.ts:1150](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1150) +[lib/mina.ts:1169](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1169) ___ @@ -585,7 +585,7 @@ Throws an error if not inside a transaction, or the sender wasn't passed in. #### Defined in -[lib/mina.ts:1087](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1087) +[lib/mina.ts:1106](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1106) ___ @@ -607,7 +607,7 @@ Set the currently used Mina instance. #### Defined in -[lib/mina.ts:1031](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1031) +[lib/mina.ts:1045](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1045) ___ @@ -640,7 +640,7 @@ A transaction that can subsequently be submitted to the chain. #### Defined in -[lib/mina.ts:1048](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1048) +[lib/mina.ts:1062](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1062) ▸ **transaction**(`f`): `Promise`<[`Transaction`](Mina.md#transaction-1)\> @@ -656,7 +656,7 @@ A transaction that can subsequently be submitted to the chain. #### Defined in -[lib/mina.ts:1049](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1049) +[lib/mina.ts:1063](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1063) ▸ **transaction**(`sender`, `f`): `Promise`<[`Transaction`](Mina.md#transaction-1)\> @@ -686,7 +686,7 @@ Mina.transaction({ feePayerKey: privateKey }, ...); #### Defined in -[lib/mina.ts:1062](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1062) +[lib/mina.ts:1076](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1076) ___ @@ -706,4 +706,4 @@ ___ #### Defined in -[lib/mina.ts:1501](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1501) +[lib/mina.ts:1520](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1520) diff --git a/sidebars.js b/sidebars.js index dffc29b03..1d6c0fa97 100644 --- a/sidebars.js +++ b/sidebars.js @@ -235,11 +235,6 @@ module.exports = { id: 'zkapps/snarkyjs-reference/interfaces/Permissions', label: 'Permissions', }, - { - type: 'doc', - id: 'zkapps/snarkyjs-reference/interfaces/Provable', - label: 'Provable', - }, { type: 'doc', id: 'zkapps/snarkyjs-reference/interfaces/ProvablePure', From eff3de91a54c4ff0241c003e9e1b65ea20417c3e Mon Sep 17 00:00:00 2001 From: Florian Date: Mon, 22 May 2023 17:15:06 +0200 Subject: [PATCH 3/6] Revert "Build and publish new SnarkyJS API reference docs" This reverts commit cfb6d5bb140055eaee17cefd95ca062a024d8e0b. --- docs/zkapps/snarkyjs-reference/README.md | 191 ++++----- .../classes/AccountUpdate.md | 122 +++--- .../zkapps/snarkyjs-reference/classes/Bool.md | 68 ++-- .../snarkyjs-reference/classes/Character.md | 44 +-- .../snarkyjs-reference/classes/Circuit.md | 371 +++++++++++++----- .../classes/CircuitString.md | 58 +-- .../classes/CircuitValue.md | 34 +- .../snarkyjs-reference/classes/Field.md | 120 +++--- .../snarkyjs-reference/classes/Group.md | 50 +-- .../snarkyjs-reference/classes/Int64.md | 70 ++-- .../snarkyjs-reference/classes/Keypair.md | 55 +-- .../snarkyjs-reference/classes/Ledger.md | 54 +-- .../snarkyjs-reference/classes/MerkleMap.md | 14 +- .../classes/MerkleMapWitness.md | 40 +- .../snarkyjs-reference/classes/MerkleTree.md | 24 +- .../snarkyjs-reference/classes/PrivateKey.md | 48 +-- .../snarkyjs-reference/classes/Proof.md | 26 +- .../snarkyjs-reference/classes/Scalar.md | 36 +- .../snarkyjs-reference/classes/SelfProof.md | 26 +- .../zkapps/snarkyjs-reference/classes/Sign.md | 50 +-- .../snarkyjs-reference/classes/Signature.md | 46 +-- .../classes/SmartContract.md | 80 ++-- .../snarkyjs-reference/classes/Token.md | 12 +- .../snarkyjs-reference/classes/TokenSymbol.md | 28 +- .../classes/Types.PublicKey.md | 56 +-- .../snarkyjs-reference/classes/UInt32.md | 98 ++--- .../snarkyjs-reference/classes/UInt64.md | 100 ++--- .../classes/VerificationKey.md | 24 +- .../interfaces/Mina.TransactionId.md | 6 +- .../interfaces/Permissions.md | 26 +- .../snarkyjs-reference/interfaces/Provable.md | 141 +++++++ .../interfaces/ProvablePure.md | 22 +- .../snarkyjs-reference/modules/Encryption.md | 4 +- .../modules/Experimental.md | 16 +- .../zkapps/snarkyjs-reference/modules/Mina.md | 66 ++-- sidebars.js | 5 + 36 files changed, 1226 insertions(+), 1005 deletions(-) create mode 100644 docs/zkapps/snarkyjs-reference/interfaces/Provable.md diff --git a/docs/zkapps/snarkyjs-reference/README.md b/docs/zkapps/snarkyjs-reference/README.md index 5f2d8d3e8..22de79326 100644 --- a/docs/zkapps/snarkyjs-reference/README.md +++ b/docs/zkapps/snarkyjs-reference/README.md @@ -46,6 +46,7 @@ ### Interfaces - [Permissions](interfaces/Permissions.md) +- [Provable](interfaces/Provable.md) - [ProvablePure](interfaces/ProvablePure.md) ### Type Aliases @@ -56,7 +57,6 @@ - [FlexibleProvablePure](README.md#flexibleprovablepure) - [InferProvable](README.md#inferprovable) - [JsonProof](README.md#jsonproof) -- [Provable](README.md#provable) - [ProvableExtended](README.md#provableextended) - [Reducer](README.md#reducer) - [State](README.md#state) @@ -71,7 +71,6 @@ - [Empty](README.md#empty-1) - [Permissions](README.md#permissions) - [Poseidon](README.md#poseidon) -- [Provable](README.md#provable-1) - [TokenId](README.md#tokenid) - [Undefined](README.md#undefined-1) - [Void](README.md#void-1) @@ -98,7 +97,7 @@ - [matrixProp](README.md#matrixprop) - [method](README.md#method) - [prop](README.md#prop) -- [provable](README.md#provable-2) +- [provable](README.md#provable) - [provablePure](README.md#provablepure) - [public\_](README.md#public_) - [sendZkapp](README.md#sendzkapp) @@ -124,7 +123,7 @@ Re-exports [PublicKey](classes/Types.PublicKey.md) #### Defined in -[lib/zkapp.ts:1502](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1502) +[lib/zkapp.ts:1508](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1508) ___ @@ -134,15 +133,15 @@ ___ #### Defined in -[lib/proof_system.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L73) +[lib/proof_system.ts:80](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L80) -[lib/proof_system.ts:74](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L74) +[lib/proof_system.ts:81](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L81) ___ ### FlexibleProvable -Ƭ **FlexibleProvable**<`T`\>: [`Provable`](README.md#provable-1)<`T`\> \| [`Struct`](README.md#struct)<`T`\> +Ƭ **FlexibleProvable**<`T`\>: [`Provable`](interfaces/Provable.md)<`T`\> \| [`Struct`](README.md#struct)<`T`\> #### Type parameters @@ -152,7 +151,7 @@ ___ #### Defined in -[lib/circuit_value.ts:60](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L60) +[lib/circuit_value.ts:77](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L77) ___ @@ -168,13 +167,13 @@ ___ #### Defined in -[lib/circuit_value.ts:61](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L61) +[lib/circuit_value.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L78) ___ ### InferProvable -Ƭ **InferProvable**<`A`\>: `A` extends `Constructor` ? `A` extends `Provable`<`U`\> ? `U` : `A` extends `Struct`<`U`\> ? `U` : `InferProvableBase`<`A`\> : `InferProvableBase`<`A`\> +Ƭ **InferProvable**<`A`\>: `A` extends `Constructor` ? `A` extends [`Provable`](interfaces/Provable.md)<`U`\> ? `U` : `A` extends `Struct`<`U`\> ? `U` : `InferProvableBase`<`A`\> : `InferProvableBase`<`A`\> #### Type parameters @@ -203,35 +202,13 @@ ___ #### Defined in -[lib/proof_system.ts:180](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L180) - -___ - -### Provable - -Ƭ **Provable**<`T`\>: `Provable_`<`T`\> - -`Provable` is the general circuit type interface. It describes how a type `T` is made up of field elements and auxiliary (non-field element) data. - -You will find this as the required input type in a few places in SnarkyJS. One convenient way to create a `Provable` is using `Struct`. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[lib/provable.ts:35](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L35) - -[lib/provable.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L37) +[lib/proof_system.ts:187](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L187) ___ ### ProvableExtended -Ƭ **ProvableExtended**<`T`, `TJson`\>: [`Provable`](README.md#provable-1)<`T`\> & `ProvableExtension`<`T`, `TJson`\> +Ƭ **ProvableExtended**<`T`, `TJson`\>: [`Provable`](interfaces/Provable.md)<`T`\> & `ProvableExtension`<`T`, `TJson`\> #### Type parameters @@ -242,7 +219,7 @@ ___ #### Defined in -[lib/circuit_value.ts:50](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L50) +[lib/circuit_value.ts:67](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L67) ___ @@ -264,9 +241,9 @@ ___ #### Defined in -[lib/zkapp.ts:1230](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1230) +[lib/zkapp.ts:1236](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1236) -[lib/zkapp.ts:1574](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1574) +[lib/zkapp.ts:1580](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1580) ___ @@ -296,9 +273,9 @@ Gettable and settable state that can be checked for equality. #### Defined in -[lib/state.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L73) +[lib/state.ts:73](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L73) -[lib/state.ts:20](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L20) +[lib/state.ts:20](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L20) ___ @@ -314,9 +291,9 @@ ___ #### Defined in -[lib/circuit_value.ts:357](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L357) +[lib/circuit_value.ts:459](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L459) -[lib/circuit_value.ts:55](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L55) +[lib/circuit_value.ts:72](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L72) ___ @@ -332,7 +309,7 @@ UNKNOWN: The transaction has either been snarked, reached finality through conse #### Defined in -[lib/fetch.ts:650](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L650) +[lib/fetch.ts:650](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L650) ___ @@ -342,9 +319,9 @@ ___ #### Defined in -[lib/proof_system.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L70) +[lib/proof_system.ts:77](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L77) -[lib/proof_system.ts:71](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L71) +[lib/proof_system.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L78) ___ @@ -354,9 +331,9 @@ ___ #### Defined in -[lib/proof_system.ts:75](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L75) +[lib/proof_system.ts:82](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L82) -[lib/proof_system.ts:76](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L76) +[lib/proof_system.ts:83](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L83) ___ @@ -386,9 +363,9 @@ transaction. #### Defined in -[lib/account_update.ts:1940](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1940) +[lib/account_update.ts:1935](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1935) -[lib/account_update.ts:1944](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1944) +[lib/account_update.ts:1939](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1939) ## Variables @@ -398,9 +375,9 @@ transaction. #### Defined in -[lib/proof_system.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L73) +[lib/proof_system.ts:80](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L80) -[lib/proof_system.ts:74](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L74) +[lib/proof_system.ts:81](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L81) ___ @@ -426,9 +403,9 @@ ___ #### Defined in -[lib/account_update.ts:163](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L163) +[lib/account_update.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L163) -[lib/account_update.ts:235](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L235) +[lib/account_update.ts:235](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L235) ___ @@ -448,37 +425,7 @@ ___ #### Defined in -[lib/hash.ts:39](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L39) - -___ - -### Provable - -• **Provable**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Array` | (`elementType`: `A`, `length`: `number`) => `InferredProvable`<`A`[]\> | -| `asProver` | (`f`: () => `void`) => `void` | -| `assertEqual` | (`type`: [`FlexibleProvable`](README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => `void`(`x`: `T`, `y`: `T`) => `void` | -| `constraintSystem` | (`f`: () => `T`) => { `digest`: `string` ; `gates`: `Gate`[] ; `publicInputSize`: `number` ; `result`: `T` ; `rows`: `number` } | -| `equal` | (`type`: [`FlexibleProvable`](README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => [`Bool`](classes/Bool.md)(`x`: `T`, `y`: `T`) => [`Bool`](classes/Bool.md) | -| `if` | (`condition`: [`Bool`](classes/Bool.md), `type`: [`FlexibleProvable`](README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => `T`(`condition`: [`Bool`](classes/Bool.md), `x`: `T`, `y`: `T`) => `T` | -| `inCheckedComputation` | () => `boolean` | -| `inProver` | () => `boolean` | -| `log` | (...`args`: `any`) => `void` | -| `runAndCheck` | (`f`: () => `void`) => `void` | -| `runUnchecked` | (`f`: () => `void`) => `void` | -| `switch` | (`mask`: [`Bool`](classes/Bool.md)[], `type`: `A`, `values`: `T`[]) => `T` | -| `witness` | (`type`: `S`, `compute`: () => `T`) => `T` | - -#### Defined in - -[lib/provable.ts:35](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L35) - -[lib/provable.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L37) +[lib/hash.ts:43](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L43) ___ @@ -506,7 +453,7 @@ ___ #### Defined in -[lib/account_update.ts:602](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L602) +[lib/account_update.ts:602](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L602) ___ @@ -516,9 +463,9 @@ ___ #### Defined in -[lib/proof_system.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L70) +[lib/proof_system.ts:77](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L77) -[lib/proof_system.ts:71](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L71) +[lib/proof_system.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L78) ___ @@ -528,9 +475,9 @@ ___ #### Defined in -[lib/proof_system.ts:75](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L75) +[lib/proof_system.ts:82](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L82) -[lib/proof_system.ts:76](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L76) +[lib/proof_system.ts:83](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L83) ___ @@ -540,9 +487,9 @@ ___ #### Defined in -[lib/account_update.ts:1940](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1940) +[lib/account_update.ts:1935](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1935) -[lib/account_update.ts:1944](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1944) +[lib/account_update.ts:1939](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1939) ___ @@ -556,7 +503,7 @@ ___ #### Defined in -[snarky.d.ts:1216](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1216) +[snarky.d.ts:1299](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1299) ## Functions @@ -577,7 +524,7 @@ ___ #### Defined in -[lib/zkapp.ts:1509](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1509) +[lib/zkapp.ts:1515](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1515) ___ @@ -601,7 +548,7 @@ A circuit-compatible Merkle Witness. #### Defined in -[lib/merkle_tree.ts:236](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L236) +[lib/merkle_tree.ts:236](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L236) ___ @@ -629,7 +576,7 @@ ___ #### Defined in -[lib/zkapp.ts:1574](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1574) +[lib/zkapp.ts:1580](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1580) ___ @@ -649,13 +596,13 @@ ___ #### Defined in -[lib/state.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L73) +[lib/state.ts:73](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L73) ___ ### Struct -▸ **Struct**<`A`, `T`, `J`, `Pure`\>(`type`, `options?`): (`value`: `T`) => `T` & { `_isStruct`: ``true`` } & `Pure` extends ``true`` ? [`ProvablePure`](interfaces/ProvablePure.md)<`T`\> : [`Provable`](README.md#provable-1)<`T`\> & { `fromJSON`: (`x`: `J`) => `T` ; `toInput`: (`x`: `T`) => { `fields?`: [`Field`](classes/Field.md)[] ; `packed?`: [[`Field`](classes/Field.md), `number`][] } ; `toJSON`: (`x`: `T`) => `J` } +▸ **Struct**<`A`, `T`, `J`, `Pure`\>(`type`, `options?`): (`value`: `T`) => `T` & { `_isStruct`: ``true`` } & `Pure` extends ``true`` ? [`ProvablePure`](interfaces/ProvablePure.md)<`T`\> : [`Provable`](interfaces/Provable.md)<`T`\> & { `fromJSON`: (`x`: `J`) => `T` ; `toInput`: (`x`: `T`) => { `fields?`: [`Field`](classes/Field.md)[] ; `packed?`: [[`Field`](classes/Field.md), `number`][] } ; `toJSON`: (`x`: `T`) => `J` } `Struct` lets you declare composite types for use in snarkyjs circuits. @@ -741,13 +688,13 @@ From the circuit point of view, it simply doesn't exist! #### Returns -(`value`: `T`) => `T` & { `_isStruct`: ``true`` } & `Pure` extends ``true`` ? [`ProvablePure`](interfaces/ProvablePure.md)<`T`\> : [`Provable`](README.md#provable-1)<`T`\> & { `fromJSON`: (`x`: `J`) => `T` ; `toInput`: (`x`: `T`) => { `fields?`: [`Field`](classes/Field.md)[] ; `packed?`: [[`Field`](classes/Field.md), `number`][] } ; `toJSON`: (`x`: `T`) => `J` } +(`value`: `T`) => `T` & { `_isStruct`: ``true`` } & `Pure` extends ``true`` ? [`ProvablePure`](interfaces/ProvablePure.md)<`T`\> : [`Provable`](interfaces/Provable.md)<`T`\> & { `fromJSON`: (`x`: `J`) => `T` ; `toInput`: (`x`: `T`) => { `fields?`: [`Field`](classes/Field.md)[] ; `packed?`: [[`Field`](classes/Field.md), `number`][] } ; `toJSON`: (`x`: `T`) => `J` } Class which you can extend #### Defined in -[lib/circuit_value.ts:357](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L357) +[lib/circuit_value.ts:459](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L459) ___ @@ -770,7 +717,7 @@ Adds an account to the local cache, indexed by a GraphQL endpoint. #### Defined in -[lib/fetch.ts:351](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L351) +[lib/fetch.ts:351](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L351) ___ @@ -810,7 +757,7 @@ ___ #### Defined in -[lib/circuit_value.ts:262](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L262) +[lib/circuit_value.ts:364](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L364) ___ @@ -830,7 +777,7 @@ ___ #### Defined in -[lib/fetch.ts:498](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L498) +[lib/fetch.ts:498](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L498) ___ @@ -842,7 +789,7 @@ ___ | Name | Type | | :------ | :------ | -| `target` | typeof [`Circuit`](classes/Circuit.md) | +| `target` | `any` | | `propertyName` | `string` | | `_descriptor?` | `PropertyDescriptor` | @@ -852,7 +799,7 @@ ___ #### Defined in -[lib/circuit.ts:219](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L219) +[lib/circuit.ts:272](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L272) ___ @@ -886,7 +833,7 @@ Note that a method of the same name must still be defined on the class, just wit | Name | Type | | :------ | :------ | | `SmartContract` | `T` | -| `methodArguments` | `Record`<`string`, [`Provable`](README.md#provable-1)<`unknown`\>[]\> | +| `methodArguments` | `Record`<`string`, [`Provable`](interfaces/Provable.md)<`unknown`\>[]\> | #### Returns @@ -894,7 +841,7 @@ Note that a method of the same name must still be defined on the class, just wit #### Defined in -[lib/zkapp.ts:1560](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1560) +[lib/zkapp.ts:1566](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1566) ___ @@ -954,7 +901,7 @@ declareState(MyContract, { x: Field }); #### Defined in -[lib/state.ts:163](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L163) +[lib/state.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L163) ___ @@ -988,7 +935,7 @@ zkapp information on the specified account or an error is thrown #### Defined in -[lib/fetch.ts:131](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L131) +[lib/fetch.ts:131](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L131) ___ @@ -1030,7 +977,7 @@ A promise that resolves to an array of objects containing event data, block info #### Defined in -[lib/fetch.ts:820](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L820) +[lib/fetch.ts:820](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L820) ___ @@ -1052,7 +999,7 @@ Fetches the last block on the Mina network. #### Defined in -[lib/fetch.ts:394](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L394) +[lib/fetch.ts:394](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L394) ___ @@ -1075,7 +1022,7 @@ Fetches the status of a transaction. #### Defined in -[lib/fetch.ts:625](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L625) +[lib/fetch.ts:625](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L625) ___ @@ -1116,7 +1063,7 @@ ___ #### Defined in -[lib/circuit_value.ts:271](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L271) +[lib/circuit_value.ts:373](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L373) ___ @@ -1153,7 +1100,7 @@ You can use inside your zkApp class as: #### Defined in -[lib/zkapp.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L94) +[lib/zkapp.ts:98](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L98) ___ @@ -1175,7 +1122,7 @@ ___ #### Defined in -[lib/circuit_value.ts:247](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L247) +[lib/circuit_value.ts:264](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L264) ___ @@ -1254,7 +1201,7 @@ ___ #### Defined in -[lib/circuit.ts:185](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L185) +[lib/circuit.ts:224](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L224) ___ @@ -1279,7 +1226,7 @@ Sends a zkApp command (transaction) to the specified GraphQL endpoint. #### Defined in -[lib/fetch.ts:655](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L655) +[lib/fetch.ts:655](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L655) ___ @@ -1301,7 +1248,7 @@ Sets up a GraphQL endpoint to be used for fetching information from an Archive N #### Defined in -[lib/fetch.ts:100](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L100) +[lib/fetch.ts:100](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L100) ___ @@ -1321,7 +1268,7 @@ ___ #### Defined in -[lib/fetch.ts:78](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L78) +[lib/fetch.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L78) ___ @@ -1341,7 +1288,7 @@ ___ #### Defined in -[lib/fetch.ts:71](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/fetch.ts#L71) +[lib/fetch.ts:71](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/fetch.ts#L71) ___ @@ -1359,7 +1306,7 @@ ___ #### Defined in -[snarky.d.ts:1211](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1211) +[snarky.d.ts:1294](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1294) ___ @@ -1381,7 +1328,7 @@ ___ #### Defined in -[lib/zkapp.ts:1517](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1517) +[lib/zkapp.ts:1523](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1523) ___ @@ -1429,7 +1376,7 @@ you can use the following in the declaration of your zkapp: #### Defined in -[lib/state.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/state.ts#L87) +[lib/state.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/state.ts#L87) ___ @@ -1450,4 +1397,4 @@ ___ #### Defined in -[lib/proof_system.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L150) +[lib/proof_system.ts:157](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L157) diff --git a/docs/zkapps/snarkyjs-reference/classes/AccountUpdate.md b/docs/zkapps/snarkyjs-reference/classes/AccountUpdate.md index b7c533cc4..85c33c2e9 100644 --- a/docs/zkapps/snarkyjs-reference/classes/AccountUpdate.md +++ b/docs/zkapps/snarkyjs-reference/classes/AccountUpdate.md @@ -98,7 +98,7 @@ be authorized by either a [Signature](Signature.md) or [Proof](Proof.md). #### Defined in -[lib/account_update.ts:684](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L684) +[lib/account_update.ts:684](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L684) ## Properties @@ -108,7 +108,7 @@ be authorized by either a [Signature](Signature.md) or [Proof](Proof.md). #### Defined in -[lib/account_update.ts:665](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L665) +[lib/account_update.ts:665](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L665) ___ @@ -129,7 +129,7 @@ Types.AccountUpdate.authorization #### Defined in -[lib/account_update.ts:662](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L662) +[lib/account_update.ts:662](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L662) ___ @@ -143,7 +143,7 @@ Types.AccountUpdate.body #### Defined in -[lib/account_update.ts:661](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L661) +[lib/account_update.ts:661](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L661) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[lib/account_update.ts:668](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L668) +[lib/account_update.ts:668](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L668) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[lib/account_update.ts:667](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L667) +[lib/account_update.ts:667](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L667) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[lib/account_update.ts:655](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L655) +[lib/account_update.ts:655](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L655) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[lib/account_update.ts:680](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L680) +[lib/account_update.ts:680](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L680) ___ @@ -203,7 +203,7 @@ was created. Can be modified by applications to add richer information. #### Defined in -[lib/account_update.ts:660](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L660) +[lib/account_update.ts:660](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L660) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[lib/account_update.ts:663](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L663) +[lib/account_update.ts:663](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L663) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -[lib/account_update.ts:666](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L666) +[lib/account_update.ts:666](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L666) ___ @@ -233,7 +233,7 @@ ___ #### Defined in -[lib/account_update.ts:678](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L678) +[lib/account_update.ts:678](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L678) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[lib/account_update.ts:682](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L682) +[lib/account_update.ts:682](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L682) ___ @@ -306,7 +306,7 @@ StaticChildren(AnyChildren, StaticChildren(1)) #### Defined in -[lib/account_update.ts:1398](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1398) +[lib/account_update.ts:1393](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1393) ___ @@ -330,7 +330,7 @@ ___ #### Defined in -[lib/account_update.ts:1283](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1283) +[lib/account_update.ts:1278](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1278) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[lib/account_update.ts:1019](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1019) +[lib/account_update.ts:1014](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1014) ___ @@ -358,7 +358,7 @@ ___ #### Defined in -[lib/account_update.ts:1262](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1262) +[lib/account_update.ts:1257](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1257) ___ @@ -382,7 +382,7 @@ ___ #### Defined in -[lib/account_update.ts:1263](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1263) +[lib/account_update.ts:1258](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1258) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[lib/account_update.ts:1282](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1282) +[lib/account_update.ts:1277](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1277) ## Accessors @@ -425,7 +425,7 @@ ___ #### Defined in -[lib/account_update.ts:875](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L875) +[lib/account_update.ts:875](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L875) ___ @@ -439,7 +439,7 @@ ___ #### Defined in -[lib/account_update.ts:958](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L958) +[lib/account_update.ts:958](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L958) ___ @@ -453,7 +453,7 @@ ___ #### Defined in -[lib/account_update.ts:815](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L815) +[lib/account_update.ts:815](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L815) ___ @@ -475,7 +475,7 @@ use `this.account.tokenSymbol` #### Defined in -[lib/account_update.ts:822](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L822) +[lib/account_update.ts:822](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L822) ___ @@ -538,7 +538,7 @@ ___ #### Defined in -[lib/account_update.ts:890](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L890) +[lib/account_update.ts:890](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L890) ___ @@ -568,7 +568,7 @@ ___ #### Defined in -[lib/account_update.ts:1412](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1412) +[lib/account_update.ts:1407](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1407) ## Methods @@ -592,7 +592,7 @@ approves it. #### Defined in -[lib/account_update.ts:867](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L867) +[lib/account_update.ts:867](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L867) ___ @@ -606,7 +606,7 @@ ___ #### Defined in -[lib/account_update.ts:1079](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1079) +[lib/account_update.ts:1074](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1074) ___ @@ -620,7 +620,7 @@ ___ #### Defined in -[lib/account_update.ts:1108](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1108) +[lib/account_update.ts:1103](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1103) ___ @@ -648,7 +648,7 @@ be (can be) authorized by a signature. #### Defined in -[lib/account_update.ts:977](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L977) +[lib/account_update.ts:977](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L977) ___ @@ -670,7 +670,7 @@ ___ #### Defined in -[lib/account_update.ts:832](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L832) +[lib/account_update.ts:832](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L832) ___ @@ -694,7 +694,7 @@ ___ #### Defined in -[lib/account_update.ts:988](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L988) +[lib/account_update.ts:983](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L983) ___ @@ -708,7 +708,7 @@ ___ #### Defined in -[lib/account_update.ts:1068](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1068) +[lib/account_update.ts:1063](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1063) ___ @@ -725,7 +725,7 @@ default [AccountUpdate](AccountUpdate.md). #### Defined in -[lib/account_update.ts:1447](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1447) +[lib/account_update.ts:1442](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1442) ___ @@ -739,7 +739,7 @@ ___ #### Defined in -[lib/account_update.ts:1096](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1096) +[lib/account_update.ts:1091](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1091) ___ @@ -762,7 +762,7 @@ ___ #### Defined in -[lib/account_update.ts:721](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L721) +[lib/account_update.ts:721](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L721) ___ @@ -792,7 +792,7 @@ Constrain a property to lie between lower and upper bounds. #### Defined in -[lib/account_update.ts:918](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L918) +[lib/account_update.ts:918](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L918) ___ @@ -821,7 +821,7 @@ Fix a property to a certain value. #### Defined in -[lib/account_update.ts:945](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L945) +[lib/account_update.ts:945](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L945) ___ @@ -844,7 +844,7 @@ Attach account update to the current transaction #### Defined in -[lib/account_update.ts:1152](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1152) +[lib/account_update.ts:1147](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1147) ___ @@ -866,7 +866,7 @@ Clones the [AccountUpdate](AccountUpdate.md). #### Defined in -[lib/account_update.ts:702](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L702) +[lib/account_update.ts:702](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L702) ___ @@ -893,7 +893,7 @@ becomes part of the proof. #### Defined in -[lib/account_update.ts:1133](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1133) +[lib/account_update.ts:1128](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1128) ___ @@ -928,7 +928,7 @@ be (can be) authorized by a signature. #### Defined in -[lib/account_update.ts:1199](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1199) +[lib/account_update.ts:1194](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1194) ▸ `Static` **createSigned**(`signer`, `tokenId?`): [`AccountUpdate`](AccountUpdate.md) @@ -949,7 +949,7 @@ in favor of calling this function with a `PublicKey` as `signer` #### Defined in -[lib/account_update.ts:1203](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1203) +[lib/account_update.ts:1198](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1198) ___ @@ -970,7 +970,7 @@ ___ #### Defined in -[lib/account_update.ts:1102](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1102) +[lib/account_update.ts:1097](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1097) ___ @@ -991,7 +991,7 @@ ___ #### Defined in -[lib/account_update.ts:1112](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1112) +[lib/account_update.ts:1107](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1107) ___ @@ -1005,7 +1005,7 @@ ___ #### Defined in -[lib/account_update.ts:1105](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1105) +[lib/account_update.ts:1100](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1100) ___ @@ -1019,7 +1019,7 @@ ___ #### Defined in -[lib/account_update.ts:1121](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1121) +[lib/account_update.ts:1116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1116) ___ @@ -1040,7 +1040,7 @@ ___ #### Defined in -[lib/account_update.ts:1284](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1284) +[lib/account_update.ts:1279](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1279) ___ @@ -1060,7 +1060,7 @@ ___ #### Defined in -[lib/account_update.ts:1074](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1074) +[lib/account_update.ts:1069](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1069) ___ @@ -1089,7 +1089,7 @@ they [AccountUpdate](AccountUpdate.md) for the account which pays the fee #### Defined in -[lib/account_update.ts:1231](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1231) +[lib/account_update.ts:1226](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1226) ▸ `Static` **fundNewAccount**(`feePayer`, `options?`): [`AccountUpdate`](AccountUpdate.md) @@ -1115,7 +1115,7 @@ feePayerUpdate.send({ to: receiverAddress, amount: initialBalance }); #### Defined in -[lib/account_update.ts:1243](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1243) +[lib/account_update.ts:1238](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1238) ___ @@ -1135,7 +1135,7 @@ ___ #### Defined in -[lib/account_update.ts:1015](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1015) +[lib/account_update.ts:1010](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1010) ___ @@ -1160,7 +1160,7 @@ ___ #### Defined in -[lib/account_update.ts:1024](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1024) +[lib/account_update.ts:1019](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1019) ___ @@ -1185,7 +1185,7 @@ ___ #### Defined in -[lib/account_update.ts:1032](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1032) +[lib/account_update.ts:1027](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1027) ___ @@ -1212,7 +1212,7 @@ ___ #### Defined in -[lib/account_update.ts:894](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L894) +[lib/account_update.ts:894](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L894) ___ @@ -1233,7 +1233,7 @@ ___ #### Defined in -[lib/account_update.ts:1006](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1006) +[lib/account_update.ts:1001](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1001) ___ @@ -1253,7 +1253,7 @@ ___ #### Defined in -[lib/account_update.ts:1264](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1264) +[lib/account_update.ts:1259](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1259) ___ @@ -1273,7 +1273,7 @@ ___ #### Defined in -[lib/account_update.ts:1071](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1071) +[lib/account_update.ts:1066](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1066) ___ @@ -1295,7 +1295,7 @@ Disattach an account update from where it's currently located in the transaction #### Defined in -[lib/account_update.ts:1172](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1172) +[lib/account_update.ts:1167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1167) ___ @@ -1329,7 +1329,7 @@ ___ #### Defined in -[lib/account_update.ts:1292](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1292) +[lib/account_update.ts:1287](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1287) ___ @@ -1352,7 +1352,7 @@ ___ #### Defined in -[lib/account_update.ts:1308](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1308) +[lib/account_update.ts:1303](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1303) ___ @@ -1390,4 +1390,4 @@ accountUpdate's children, which also get witnessed #### Defined in -[lib/account_update.ts:1353](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1353) +[lib/account_update.ts:1348](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1348) diff --git a/docs/zkapps/snarkyjs-reference/classes/Bool.md b/docs/zkapps/snarkyjs-reference/classes/Bool.md index 14b7a86db..8ade9afb6 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Bool.md +++ b/docs/zkapps/snarkyjs-reference/classes/Bool.md @@ -59,7 +59,7 @@ #### Defined in -[snarky.d.ts:632](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L632) +[snarky.d.ts:553](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L553) ## Properties @@ -75,7 +75,7 @@ #### Defined in -[snarky.d.ts:722](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L722) +[snarky.d.ts:643](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L643) ## Methods @@ -98,7 +98,7 @@ this [Bool](Bool.md) and `y` are also true. #### Defined in -[snarky.d.ts:649](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L649) +[snarky.d.ts:570](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L570) ___ @@ -121,7 +121,7 @@ Proves that this [Bool](Bool.md) is equal to `y`. #### Defined in -[snarky.d.ts:662](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L662) +[snarky.d.ts:583](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L583) ___ @@ -143,7 +143,7 @@ Proves that this [Bool](Bool.md) is `false`. #### Defined in -[snarky.d.ts:672](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L672) +[snarky.d.ts:593](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L593) ___ @@ -165,7 +165,7 @@ Proves that this [Bool](Bool.md) is `true`. #### Defined in -[snarky.d.ts:667](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L667) +[snarky.d.ts:588](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L588) ___ @@ -187,7 +187,7 @@ Returns true if this [Bool](Bool.md) is equal to `y`. #### Defined in -[snarky.d.ts:678](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L678) +[snarky.d.ts:599](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L599) ___ @@ -203,7 +203,7 @@ a new [Bool](Bool.md) that is the negation of this [Bool](Bool.md). #### Defined in -[snarky.d.ts:642](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L642) +[snarky.d.ts:563](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L563) ___ @@ -226,7 +226,7 @@ this [Bool](Bool.md) or `y` is true. #### Defined in -[snarky.d.ts:656](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L656) +[snarky.d.ts:577](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L577) ___ @@ -242,7 +242,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:683](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L683) +[snarky.d.ts:604](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L604) ___ @@ -259,7 +259,7 @@ This can only be called on non-witness values. #### Defined in -[snarky.d.ts:705](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L705) +[snarky.d.ts:626](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L626) ___ @@ -275,7 +275,7 @@ Converts a [Bool](Bool.md) to a [Field](Field.md). `false` becomes 0 and `true` #### Defined in -[snarky.d.ts:637](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L637) +[snarky.d.ts:558](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L558) ___ @@ -291,7 +291,7 @@ Serializes this [Bool](Bool.md) into [Field](Field.md) elements. #### Defined in -[snarky.d.ts:688](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L688) +[snarky.d.ts:609](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L609) ___ @@ -308,7 +308,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:699](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L699) +[snarky.d.ts:620](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L620) ___ @@ -325,7 +325,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:694](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L694) +[snarky.d.ts:615](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L615) ___ @@ -348,7 +348,7 @@ Boolean AND operation. #### Defined in -[snarky.d.ts:740](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L740) +[snarky.d.ts:661](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L661) ___ @@ -371,7 +371,7 @@ Asserts if both [Bool](Bool.md) are equal. #### Defined in -[snarky.d.ts:750](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L750) +[snarky.d.ts:671](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L671) ___ @@ -391,7 +391,7 @@ ___ #### Defined in -[snarky.d.ts:792](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L792) +[snarky.d.ts:713](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L713) ___ @@ -413,7 +413,7 @@ Counts all elements of type [Bool](Bool.md). #### Defined in -[snarky.d.ts:760](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L760) +[snarky.d.ts:681](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L681) ___ @@ -436,7 +436,7 @@ Checks two [Bool](Bool.md) for equality. #### Defined in -[snarky.d.ts:755](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L755) +[snarky.d.ts:676](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L676) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[snarky.d.ts:797](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L797) +[snarky.d.ts:718](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L718) ___ @@ -478,7 +478,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:779](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L779) +[snarky.d.ts:700](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L700) ___ @@ -501,7 +501,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:790](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L790) +[snarky.d.ts:711](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L711) ___ @@ -523,7 +523,7 @@ Boolean negation. #### Defined in -[snarky.d.ts:735](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L735) +[snarky.d.ts:656](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L656) ___ @@ -546,7 +546,7 @@ Boolean OR operation. #### Defined in -[snarky.d.ts:745](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L745) +[snarky.d.ts:666](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L666) ___ @@ -567,7 +567,7 @@ ___ #### Defined in -[snarky.d.ts:798](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L798) +[snarky.d.ts:719](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L719) ___ @@ -581,7 +581,7 @@ ___ #### Defined in -[snarky.d.ts:802](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L802) +[snarky.d.ts:723](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L723) ___ @@ -597,7 +597,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:765](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L765) +[snarky.d.ts:686](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L686) ___ @@ -619,7 +619,7 @@ Static method to serialize a [Bool](Bool.md) into its auxiliary data. #### Defined in -[snarky.d.ts:775](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L775) +[snarky.d.ts:696](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L696) ___ @@ -639,7 +639,7 @@ ___ #### Defined in -[snarky.d.ts:796](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L796) +[snarky.d.ts:717](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L717) ___ @@ -661,7 +661,7 @@ Serializes a [Bool](Bool.md) into an array of [Field](Field.md) elements. #### Defined in -[snarky.d.ts:720](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L720) +[snarky.d.ts:641](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L641) ___ @@ -683,7 +683,7 @@ Static method to serialize a [Bool](Bool.md) into an array of [Field](Field.md) #### Defined in -[snarky.d.ts:770](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L770) +[snarky.d.ts:691](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L691) ___ @@ -707,7 +707,7 @@ ___ #### Defined in -[snarky.d.ts:795](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L795) +[snarky.d.ts:716](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L716) ___ @@ -730,4 +730,4 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:785](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L785) +[snarky.d.ts:706](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L706) diff --git a/docs/zkapps/snarkyjs-reference/classes/Character.md b/docs/zkapps/snarkyjs-reference/classes/Character.md index 9cf6ca2da..6638c3c1e 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Character.md +++ b/docs/zkapps/snarkyjs-reference/classes/Character.md @@ -61,7 +61,7 @@ #### Defined in -[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) ## Properties @@ -71,7 +71,7 @@ #### Defined in -[lib/string.ts:11](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L11) +[lib/string.ts:11](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L11) ## Methods @@ -95,7 +95,7 @@ #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[lib/string.ts:13](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L13) +[lib/string.ts:13](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L13) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[lib/string.ts:17](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L17) +[lib/string.ts:17](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L17) ___ @@ -201,7 +201,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -219,7 +219,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -233,7 +233,7 @@ ___ #### Defined in -[lib/string.ts:21](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L21) +[lib/string.ts:21](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L21) ___ @@ -257,7 +257,7 @@ ___ #### Defined in -[lib/string.ts:33](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L33) +[lib/string.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L33) ___ @@ -288,7 +288,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -319,7 +319,7 @@ ___ #### Defined in -[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) +[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) ___ @@ -350,7 +350,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -370,7 +370,7 @@ ___ #### Defined in -[lib/string.ts:26](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L26) +[lib/string.ts:26](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L26) ___ @@ -388,7 +388,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -437,7 +437,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -468,7 +468,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -499,7 +499,7 @@ ___ #### Defined in -[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) +[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) ___ @@ -530,4 +530,4 @@ ___ #### Defined in -[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) +[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) diff --git a/docs/zkapps/snarkyjs-reference/classes/Circuit.md b/docs/zkapps/snarkyjs-reference/classes/Circuit.md index fa0afc37d..226df425a 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Circuit.md +++ b/docs/zkapps/snarkyjs-reference/classes/Circuit.md @@ -8,11 +8,11 @@ ### Properties -- [\_main](Circuit.md#_main) - [array](Circuit.md#array) - [asProver](Circuit.md#asprover) - [assertEqual](Circuit.md#assertequal) - [constraintSystem](Circuit.md#constraintsystem) +- [constraintSystemFromKeypair](Circuit.md#constraintsystemfromkeypair) - [equal](Circuit.md#equal) - [if](Circuit.md#if) - [inCheckedComputation](Circuit.md#incheckedcomputation) @@ -21,6 +21,7 @@ - [runAndCheck](Circuit.md#runandcheck) - [runUnchecked](Circuit.md#rununchecked) - [switch](Circuit.md#switch) +- [toFields](Circuit.md#tofields) - [witness](Circuit.md#witness) ### Methods @@ -37,27 +38,21 @@ ## Properties -### \_main - -▪ `Static` **\_main**: `CircuitData`<`any`, `any`\> - -#### Defined in - -[lib/circuit.ts:13](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L13) - -___ - ### array -▪ `Static` **array**: (`elementType`: `A`, `length`: `number`) => `InferredProvable`<`A`[]\> = `Provable.Array` +▪ `Static` **array**: (`elementType`: `A`, `length`: `number`) => `InferredProvable`<`A`[]\> = `SnarkyCircuit.array` #### Type declaration ▸ <`A`\>(`elementType`, `length`): `InferredProvable`<`A`[]\> -**`Deprecated`** +Creates a [Provable](../interfaces/Provable.md) for a generic array. + +**`Example`** -use [Array](../README.md#array) +```ts +const ProvableArray = Circuit.array(Field, 5); +``` ##### Type parameters @@ -78,21 +73,27 @@ use [Array](../README.md#array) #### Defined in -[lib/circuit.ts:103](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L103) +[lib/circuit.ts:141](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L141) ___ ### asProver -▪ `Static` **asProver**: (`f`: () => `void`) => `void` = `Provable.asProver` +▪ `Static` **asProver**: (`f`: () => `void`) => `void` = `SnarkyCircuit.asProver` #### Type declaration ▸ (`f`): `void` -**`Deprecated`** +Runs code as a prover. -use [asProver](../README.md#asprover) +**`Example`** + +```ts +Circuit.asProver(() => { + // Your prover code here +}); +``` ##### Parameters @@ -106,21 +107,28 @@ use [asProver](../README.md#asprover) #### Defined in -[lib/circuit.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L87) +[lib/circuit.ts:93](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L93) ___ ### assertEqual -▪ `Static` **assertEqual**: (`type`: [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => `void`(`x`: `T`, `y`: `T`) => `void` = `Provable.assertEqual` +▪ `Static` **assertEqual**: (`ctor`: { `toFields`: (`x`: `T`) => [`Field`](Field.md)[] }, `x`: `T`, `y`: `T`) => `void`(`x`: `T`, `y`: `T`) => `void` = `SnarkyCircuit.assertEqual` #### Type declaration -▸ <`T`\>(`type`, `x`, `y`): `void` +▸ <`T`\>(`ctor`, `x`, `y`): `void` + +Asserts that two values are equal. -**`Deprecated`** +**`Example`** -use [assertEqual](../README.md#assertequal) +```ts +class MyStruct extends Struct({ a: Field, b: Bool }) {}; +const a: MyStruct = { a: Field(0), b: Bool(false) }; +const b: MyStruct = { a: Field(1), b: Bool(true) }; +Circuit.assertEqual(MyStruct, a, b); +``` ##### Type parameters @@ -132,7 +140,8 @@ use [assertEqual](../README.md#assertequal) | Name | Type | | :------ | :------ | -| `type` | [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\> | +| `ctor` | `Object` | +| `ctor.toFields` | (`x`: `T`) => [`Field`](Field.md)[] | | `x` | `T` | | `y` | `T` | @@ -142,15 +151,22 @@ use [assertEqual](../README.md#assertequal) ▸ <`T`\>(`x`, `y`): `void` -**`Deprecated`** +Asserts that two values are equal. + +**`Example`** -use [assertEqual](../README.md#assertequal) +```ts +class MyStruct extends Struct({ a: Field, b: Bool }) {}; +const a: MyStruct = { a: Field(0), b: Bool(false) }; +const b: MyStruct = { a: Field(1), b: Bool(true) }; +Circuit.assertEqual(MyStruct, a, b); +``` ##### Type parameters -| Name | Type | -| :------ | :------ | -| `T` | extends `ToFieldable` | +| Name | +| :------ | +| `T` | ##### Parameters @@ -165,21 +181,26 @@ use [assertEqual](../README.md#assertequal) #### Defined in -[lib/circuit.ts:107](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L107) +[lib/circuit.ts:152](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L152) ___ ### constraintSystem -▪ `Static` **constraintSystem**: (`f`: () => `T`) => { `digest`: `string` ; `gates`: `Gate`[] ; `publicInputSize`: `number` ; `result`: `T` ; `rows`: `number` } = `Provable.constraintSystem` +▪ `Static` **constraintSystem**: (`f`: () => `T`) => { `digest`: `string` ; `gates`: `Gate`[] ; `publicInputSize`: `number` ; `result`: `T` ; `rows`: `number` } = `SnarkyCircuit.constraintSystem` #### Type declaration ▸ <`T`\>(`f`): `Object` -**`Deprecated`** +Returns information about the constraint system in the callback function. + +**`Example`** -use [constraintSystem](../README.md#constraintsystem) +```ts +const result = Circuit.constraintSystem(circuit); +console.log(result); +``` ##### Type parameters @@ -207,21 +228,62 @@ use [constraintSystem](../README.md#constraintsystem) #### Defined in -[lib/circuit.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L99) +[lib/circuit.ts:122](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L122) + +___ + +### constraintSystemFromKeypair + +▪ `Static` **constraintSystemFromKeypair**: (`keypair`: [`Keypair`](Keypair.md)) => `Gate`[] = `SnarkyCircuit.constraintSystemFromKeypair` + +#### Type declaration + +▸ (`keypair`): `Gate`[] + +Returns a low-level JSON representation of the `Circuit` from its [Keypair](Keypair.md): +a list of gates, each of which represents a row in a table, with certain coefficients and wires to other (row, column) pairs + +**`Example`** + +```ts +const keypair = await Circuit.generateKeypair(); +const jsonRepresentation = Circuit.constraintSystemFromKeypair(keypair); +``` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `keypair` | [`Keypair`](Keypair.md) | + +##### Returns + +`Gate`[] + +#### Defined in + +[lib/circuit.ts:132](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L132) ___ ### equal -▪ `Static` **equal**: (`type`: [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => [`Bool`](Bool.md)(`x`: `T`, `y`: `T`) => [`Bool`](Bool.md) = `Provable.equal` +▪ `Static` **equal**: (`ctor`: { `toFields`: (`x`: `T`) => [`Field`](Field.md)[] }, `x`: `T`, `y`: `T`) => [`Bool`](Bool.md)(`x`: `T`, `y`: `T`) => [`Bool`](Bool.md) = `SnarkyCircuit.equal` #### Type declaration -▸ <`T`\>(`type`, `x`, `y`): [`Bool`](Bool.md) +▸ <`T`\>(`ctor`, `x`, `y`): [`Bool`](Bool.md) -**`Deprecated`** +Checks if two elements are equal. -use [equal](../README.md#equal) +**`Example`** + +```ts +class MyStruct extends Struct({ a: Field, b: Bool }) {}; +const a: MyStruct = { a: Field(0), b: Bool(false) }; +const b: MyStruct = { a: Field(1), b: Bool(true) }; +const isEqual = Circuit.equal(MyStruct, a, b); +``` ##### Type parameters @@ -233,7 +295,8 @@ use [equal](../README.md#equal) | Name | Type | | :------ | :------ | -| `type` | [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\> | +| `ctor` | `Object` | +| `ctor.toFields` | (`x`: `T`) => [`Field`](Field.md)[] | | `x` | `T` | | `y` | `T` | @@ -243,15 +306,22 @@ use [equal](../README.md#equal) ▸ <`T`\>(`x`, `y`): [`Bool`](Bool.md) -**`Deprecated`** +Checks if two elements are equal. -use [equal](../README.md#equal) +**`Example`** + +```ts +class MyStruct extends Struct({ a: Field, b: Bool }) {}; +const a: MyStruct = { a: Field(0), b: Bool(false) }; +const b: MyStruct = { a: Field(1), b: Bool(true) }; +const isEqual = Circuit.equal(MyStruct, a, b); +``` ##### Type parameters -| Name | Type | -| :------ | :------ | -| `T` | extends `ToFieldable` | +| Name | +| :------ | +| `T` | ##### Parameters @@ -266,21 +336,26 @@ use [equal](../README.md#equal) #### Defined in -[lib/circuit.ts:111](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L111) +[lib/circuit.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L163) ___ ### if -▪ `Static` **if**: (`condition`: [`Bool`](Bool.md), `type`: [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\>, `x`: `T`, `y`: `T`) => `T`(`condition`: [`Bool`](Bool.md), `x`: `T`, `y`: `T`) => `T` = `Provable.if` +▪ `Static` **if**: (`b`: `boolean` \| [`Bool`](Bool.md), `ctor`: [`ProvablePure`](../interfaces/ProvablePure.md)<`T`\>, `x`: `T`, `y`: `T`) => `T`(`b`: `boolean` \| [`Bool`](Bool.md), `x`: `T`, `y`: `T`) => `T` = `SnarkyCircuit.if` #### Type declaration -▸ <`T`\>(`condition`, `type`, `x`, `y`): `T` +▸ <`T`\>(`b`, `ctor`, `x`, `y`): `T` -**`Deprecated`** +Circuit-compatible if-statement. -use [if](../README.md#if) +**`Example`** + +```ts +const condition = Bool(true); +const result = Circuit.if(condition, Field(1), Field(2)); // Returns Field(1) +``` ##### Type parameters @@ -292,8 +367,8 @@ use [if](../README.md#if) | Name | Type | | :------ | :------ | -| `condition` | [`Bool`](Bool.md) | -| `type` | [`FlexibleProvable`](../README.md#flexibleprovable)<`T`\> | +| `b` | `boolean` \| [`Bool`](Bool.md) | +| `ctor` | [`ProvablePure`](../interfaces/ProvablePure.md)<`T`\> | | `x` | `T` | | `y` | `T` | @@ -301,23 +376,28 @@ use [if](../README.md#if) `T` -▸ <`T`\>(`condition`, `x`, `y`): `T` +▸ <`T`\>(`b`, `x`, `y`): `T` -**`Deprecated`** +Circuit-compatible if-statement. -use [if](../README.md#if) +**`Example`** + +```ts +const condition = Bool(true); +const result = Circuit.if(condition, Field(1), Field(2)); // Returns Field(1) +``` ##### Type parameters -| Name | Type | -| :------ | :------ | -| `T` | extends `ToFieldable` | +| Name | +| :------ | +| `T` | ##### Parameters | Name | Type | | :------ | :------ | -| `condition` | [`Bool`](Bool.md) | +| `b` | `boolean` \| [`Bool`](Bool.md) | | `x` | `T` | | `y` | `T` | @@ -327,21 +407,27 @@ use [if](../README.md#if) #### Defined in -[lib/circuit.ts:115](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L115) +[lib/circuit.ts:172](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L172) ___ ### inCheckedComputation -▪ `Static` **inCheckedComputation**: () => `boolean` = `Provable.inCheckedComputation` +▪ `Static` **inCheckedComputation**: () => `boolean` = `SnarkyCircuit.inCheckedComputation` #### Type declaration ▸ (): `boolean` -**`Deprecated`** +Checks if the circuit is in checked computation mode. -use [inCheckedComputation](../README.md#incheckedcomputation) +**`Example`** + +```ts +if (Circuit.inCheckedComputation()) { + // Checked computation-specific code +} +``` ##### Returns @@ -349,21 +435,27 @@ use [inCheckedComputation](../README.md#incheckedcomputation) #### Defined in -[lib/circuit.ts:127](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L127) +[lib/circuit.ts:212](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L212) ___ ### inProver -▪ `Static` **inProver**: () => `boolean` = `Provable.inProver` +▪ `Static` **inProver**: () => `boolean` = `SnarkyCircuit.inProver` #### Type declaration ▸ (): `boolean` -**`Deprecated`** +Checks if the circuit is in prover mode. -use [inProver](../README.md#inprover) +**`Example`** + +```ts +if (Circuit.inProver()) { + // Prover-specific code +} +``` ##### Returns @@ -371,21 +463,26 @@ use [inProver](../README.md#inprover) #### Defined in -[lib/circuit.ts:123](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L123) +[lib/circuit.ts:202](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L202) ___ ### log -▪ `Static` **log**: (...`args`: `any`) => `void` = `Provable.log` +▪ `Static` **log**: (...`args`: `any`) => `void` = `SnarkyCircuit.log` #### Type declaration ▸ (`...args`): `void` -**`Deprecated`** +Interface to log elements within a circuit. Similar to `console.log()`. -use [log](../README.md#log) +**`Example`** + +```ts +const element = Field(42); +Circuit.log(element); +``` ##### Parameters @@ -399,21 +496,27 @@ use [log](../README.md#log) #### Defined in -[lib/circuit.ts:131](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L131) +[lib/circuit.ts:221](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L221) ___ ### runAndCheck -▪ `Static` **runAndCheck**: (`f`: () => `void`) => `void` = `Provable.runAndCheck` +▪ `Static` **runAndCheck**: (`f`: () => `void`) => `void` = `SnarkyCircuit.runAndCheck` #### Type declaration ▸ (`f`): `void` -**`Deprecated`** +Runs provable code quickly, without creating a proof, but still checking whether constraints are satisfied. -use [runAndCheck](../README.md#runandcheck) +**`Example`** + +```ts +Circuit.runAndCheck(() => { + // Your code to check here +}); +``` ##### Parameters @@ -427,21 +530,27 @@ use [runAndCheck](../README.md#runandcheck) #### Defined in -[lib/circuit.ts:91](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L91) +[lib/circuit.ts:103](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L103) ___ ### runUnchecked -▪ `Static` **runUnchecked**: (`f`: () => `void`) => `void` = `Provable.runUnchecked` +▪ `Static` **runUnchecked**: (`f`: () => `void`) => `void` = `SnarkyCircuit.runUnchecked` #### Type declaration ▸ (`f`): `void` -**`Deprecated`** +Runs provable code quickly, without creating a proof, and not checking whether constraints are satisfied. + +**`Example`** -use [runUnchecked](../README.md#rununchecked) +```ts +Circuit.runUnchecked(() => { + // Your code to run here +}); +``` ##### Parameters @@ -455,21 +564,28 @@ use [runUnchecked](../README.md#rununchecked) #### Defined in -[lib/circuit.ts:95](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L95) +[lib/circuit.ts:113](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L113) ___ ### switch -▪ `Static` **switch**: (`mask`: [`Bool`](Bool.md)[], `type`: `A`, `values`: `T`[]) => `T` = `Provable.switch` +▪ `Static` **switch**: (`mask`: [`Bool`](Bool.md)[], `type`: `A`, `values`: `T`[]) => `T` = `SnarkyCircuit.switch` #### Type declaration ▸ <`T`, `A`\>(`mask`, `type`, `values`): `T` -**`Deprecated`** +Generalization of `Circuit.if` for choosing between more than two different cases. +It takes a "mask", which is an array of `Bool`s that contains only one `true` element, a type/constructor, and an array of values of that type. +The result is that value which corresponds to the true element of the mask. + +**`Example`** -use [switch](../README.md#switch) +```ts +let x = Circuit.switch([Bool(false), Bool(true)], Field, [Field(1), Field(2)]); +x.assertEquals(2); +``` ##### Type parameters @@ -492,21 +608,74 @@ use [switch](../README.md#switch) #### Defined in -[lib/circuit.ts:119](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L119) +[lib/circuit.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L183) + +___ + +### toFields + +▪ `Static` **toFields**: (`a`: `A`) => [`Field`](Field.md)[] = `SnarkyCircuit.toFields` + +#### Type declaration + +▸ <`A`\>(`a`): [`Field`](Field.md)[] + +Serializes an element into [Field](Field.md) elements. + +**`Example`** + +```ts +const element = Field(42); +const fields = Circuit.toFields(element); +``` + +##### Type parameters + +| Name | +| :------ | +| `A` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `a` | `A` | + +##### Returns + +[`Field`](Field.md)[] + +#### Defined in + +[lib/circuit.ts:192](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L192) ___ ### witness -▪ `Static` **witness**: (`type`: `S`, `compute`: () => `T`) => `T` = `Provable.witness` +▪ `Static` **witness**: (`ctor`: `S`, `f`: () => `T`) => `T` = `SnarkyCircuit.witness` #### Type declaration -▸ <`T`, `S`\>(`type`, `compute`): `T` +▸ <`T`, `S`\>(`ctor`, `f`): `T` + +Create a new witness. A witness, or variable, is a value that is provided as input +by the prover. This provides a flexible way to introduce values from outside into the circuit. +However, note that nothing about how the value was created is part of the proof - `Circuit.witness` +behaves exactly like user input. So, make sure that after receiving the witness you make any assertions +that you want to associate with it. -**`Deprecated`** +**`Example`** -use [witness](../README.md#witness) +Example for re-implementing `Field.inv` with the help of `witness`: +```ts +let invX = Circuit.witness(Field, () => { + // compute the inverse of `x` outside the circuit, however you like! + return Field.inv(x)); +} +// prove that `invX` is really the inverse of `x`: +invX.mul(x).assertEquals(1); +``` ##### Type parameters @@ -519,8 +688,8 @@ use [witness](../README.md#witness) | Name | Type | | :------ | :------ | -| `type` | `S` | -| `compute` | () => `T` | +| `ctor` | `S` | +| `f` | () => `T` | ##### Returns @@ -528,7 +697,7 @@ use [witness](../README.md#witness) #### Defined in -[lib/circuit.ts:83](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L83) +[lib/circuit.ts:83](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L83) ## Methods @@ -541,7 +710,7 @@ Generates a proving key and a verification key for this circuit. **`Example`** ```ts -const keypair = await MyCircuit.generateKeypair(); +const keypair = await Circuit.generateKeypair(); ``` #### Returns @@ -550,7 +719,7 @@ const keypair = await MyCircuit.generateKeypair(); #### Defined in -[lib/circuit.ts:22](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L22) +[lib/circuit.ts:25](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L25) ___ @@ -563,8 +732,8 @@ Proves a statement using the private input, public input, and the [Keypair](Keyp **`Example`** ```ts -const keypair = await MyCircuit.generateKeypair(); -const proof = await MyCircuit.prove(privateInput, publicInput, keypair); +const keypair = await Circuit.generateKeypair(); +const proof = await Circuit.prove(privateInput, publicInput, keypair); ``` #### Parameters @@ -581,22 +750,22 @@ const proof = await MyCircuit.prove(privateInput, publicInput, keypair); #### Defined in -[lib/circuit.ts:39](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L39) +[lib/circuit.ts:39](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L39) ___ ### verify -▸ `Static` **verify**(`publicInput`, `verificationKey`, `proof`): `Promise`<`boolean`\> +▸ `Static` **verify**(`publicInput`, `vk`, `proof`): `Promise`<`boolean`\> Verifies a proof using the public input, the proof, and the initial [Keypair](Keypair.md) of the circuit. **`Example`** ```ts -const keypair = await MyCircuit.generateKeypair(); -const proof = await MyCircuit.prove(privateInput, publicInput, keypair); -const isValid = await MyCircuit.verify(publicInput, keypair.vk, proof); +const keypair = await Circuit.generateKeypair(); +const proof = await Circuit.prove(privateInput, publicInput, keypair); +const isValid = await Circuit.verify(publicInput, keypair.vk, proof); ``` #### Parameters @@ -604,7 +773,7 @@ const isValid = await MyCircuit.verify(publicInput, keypair.vk, proof); | Name | Type | | :------ | :------ | | `publicInput` | `any`[] | -| `verificationKey` | `VerificationKey` | +| `vk` | `VerificationKey` | | `proof` | `Proof` | #### Returns @@ -613,4 +782,4 @@ const isValid = await MyCircuit.verify(publicInput, keypair.vk, proof); #### Defined in -[lib/circuit.ts:63](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L63) +[lib/circuit.ts:54](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit.ts#L54) diff --git a/docs/zkapps/snarkyjs-reference/classes/CircuitString.md b/docs/zkapps/snarkyjs-reference/classes/CircuitString.md index d644ecb87..c500e8360 100644 --- a/docs/zkapps/snarkyjs-reference/classes/CircuitString.md +++ b/docs/zkapps/snarkyjs-reference/classes/CircuitString.md @@ -68,7 +68,7 @@ #### Defined in -[lib/string.ts:45](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L45) +[lib/string.ts:45](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L45) ## Properties @@ -78,7 +78,7 @@ #### Defined in -[lib/string.ts:40](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L40) +[lib/string.ts:40](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L40) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[lib/string.ts:39](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L39) +[lib/string.ts:39](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L39) ## Methods @@ -111,7 +111,7 @@ within the `maxLength` of this string (the other string can have a different max #### Defined in -[lib/string.ts:88](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L88) +[lib/string.ts:88](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L88) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[lib/string.ts:58](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L58) +[lib/string.ts:58](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L58) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -194,7 +194,7 @@ returns true if `str` is found in this `CircuitString` #### Defined in -[lib/string.ts:124](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L124) +[lib/string.ts:124](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L124) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[lib/string.ts:80](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L80) +[lib/string.ts:80](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L80) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[lib/string.ts:77](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L77) +[lib/string.ts:77](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L77) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -[lib/string.ts:53](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L53) +[lib/string.ts:53](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L53) ___ @@ -275,7 +275,7 @@ ___ #### Defined in -[lib/string.ts:128](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L128) +[lib/string.ts:128](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L128) ___ @@ -293,7 +293,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -329,7 +329,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -343,7 +343,7 @@ ___ #### Defined in -[lib/string.ts:132](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L132) +[lib/string.ts:132](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L132) ___ @@ -374,7 +374,7 @@ ___ #### Defined in -[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) +[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) ___ @@ -394,7 +394,7 @@ ___ #### Defined in -[lib/string.ts:49](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L49) +[lib/string.ts:49](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L49) ___ @@ -425,7 +425,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) +[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) ___ @@ -487,7 +487,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -507,7 +507,7 @@ ___ #### Defined in -[lib/string.ts:139](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/string.ts#L139) +[lib/string.ts:139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/string.ts#L139) ___ @@ -525,7 +525,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -543,7 +543,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -574,7 +574,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -605,7 +605,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -636,7 +636,7 @@ ___ #### Defined in -[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) +[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) ___ @@ -667,4 +667,4 @@ ___ #### Defined in -[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) +[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) diff --git a/docs/zkapps/snarkyjs-reference/classes/CircuitValue.md b/docs/zkapps/snarkyjs-reference/classes/CircuitValue.md index d3df8b007..73e75eefe 100644 --- a/docs/zkapps/snarkyjs-reference/classes/CircuitValue.md +++ b/docs/zkapps/snarkyjs-reference/classes/CircuitValue.md @@ -67,7 +67,7 @@ #### Defined in -[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) ## Methods @@ -87,7 +87,7 @@ #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) +[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) ___ @@ -217,7 +217,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) +[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) ___ @@ -271,7 +271,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -299,7 +299,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -353,7 +353,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) +[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) ___ @@ -407,4 +407,4 @@ ___ #### Defined in -[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) +[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) diff --git a/docs/zkapps/snarkyjs-reference/classes/Field.md b/docs/zkapps/snarkyjs-reference/classes/Field.md index 92ed41654..50c954ad9 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Field.md +++ b/docs/zkapps/snarkyjs-reference/classes/Field.md @@ -86,7 +86,7 @@ Coerces anything field-like to a [Field](Field.md). #### Defined in -[snarky.d.ts:140](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L140) +[snarky.d.ts:61](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L61) ## Properties @@ -98,7 +98,7 @@ The field order as a `bigint`. #### Defined in -[snarky.d.ts:511](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L511) +[snarky.d.ts:432](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L432) ___ @@ -114,7 +114,7 @@ The number -1 as a [[`Field`]]. #### Defined in -[snarky.d.ts:507](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L507) +[snarky.d.ts:428](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L428) ___ @@ -130,7 +130,7 @@ The number 1 as a [[`Field`]]. #### Defined in -[snarky.d.ts:495](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L495) +[snarky.d.ts:416](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L416) ___ @@ -146,7 +146,7 @@ The number 0 as a [[`Field`]]. #### Defined in -[snarky.d.ts:501](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L501) +[snarky.d.ts:422](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L422) ## Methods @@ -173,7 +173,7 @@ let sum = a.add(5) #### Defined in -[snarky.d.ts:173](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L173) +[snarky.d.ts:94](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L94) ___ @@ -199,7 +199,7 @@ Field(0).assertBool(); #### Defined in -[snarky.d.ts:435](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L435) +[snarky.d.ts:356](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L356) ___ @@ -229,7 +229,7 @@ Field(0).assertBoolean(); #### Defined in -[snarky.d.ts:447](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L447) +[snarky.d.ts:368](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L368) ___ @@ -257,7 +257,7 @@ Field(1).assertEquals(1); #### Defined in -[snarky.d.ts:425](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L425) +[snarky.d.ts:346](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L346) ___ @@ -284,7 +284,7 @@ Field(1).assertGt(0); #### Defined in -[snarky.d.ts:309](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L309) +[snarky.d.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L230) ___ @@ -311,7 +311,7 @@ Field(1).assertGte(0); #### Defined in -[snarky.d.ts:322](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L322) +[snarky.d.ts:243](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L243) ___ @@ -342,7 +342,7 @@ Field(1).assertGt(0); #### Defined in -[snarky.d.ts:404](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L404) +[snarky.d.ts:325](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L325) ___ @@ -373,7 +373,7 @@ Field(1).assertGte(0); #### Defined in -[snarky.d.ts:415](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L415) +[snarky.d.ts:336](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L336) ___ @@ -400,7 +400,7 @@ Field(1).assertLessThan(2); #### Defined in -[snarky.d.ts:286](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L286) +[snarky.d.ts:207](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L207) ___ @@ -427,7 +427,7 @@ Field(1).assertLessThanOrEqual(2); #### Defined in -[snarky.d.ts:296](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L296) +[snarky.d.ts:217](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L217) ___ @@ -458,7 +458,7 @@ Field(1).assertLessThan(2); #### Defined in -[snarky.d.ts:383](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L383) +[snarky.d.ts:304](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L304) ___ @@ -489,7 +489,7 @@ Field(1).assertLte(2); #### Defined in -[snarky.d.ts:393](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L393) +[snarky.d.ts:314](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L314) ___ @@ -511,7 +511,7 @@ Divides this [Field](Field.md) element through another coercible to a field. #### Defined in -[snarky.d.ts:188](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L188) +[snarky.d.ts:109](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L109) ___ @@ -538,7 +538,7 @@ Field(2).equals(2); // Bool(true) #### Defined in -[snarky.d.ts:470](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L470) +[snarky.d.ts:391](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L391) ___ @@ -560,7 +560,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:548](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L548) +[snarky.d.ts:469](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L469) ___ @@ -587,7 +587,7 @@ Field(2).greaterThan(1); // Bool(true) #### Defined in -[snarky.d.ts:264](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L264) +[snarky.d.ts:185](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L185) ___ @@ -614,7 +614,7 @@ Field(2).greaterThanOrEqual(1); // Bool(true) #### Defined in -[snarky.d.ts:274](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L274) +[snarky.d.ts:195](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L195) ___ @@ -645,7 +645,7 @@ Field(2).gt(1); // Bool(true) #### Defined in -[snarky.d.ts:359](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L359) +[snarky.d.ts:280](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L280) ___ @@ -676,7 +676,7 @@ Field(2).gte(1); // Bool(true) #### Defined in -[snarky.d.ts:370](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L370) +[snarky.d.ts:291](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L291) ___ @@ -699,7 +699,7 @@ A [Field](Field.md) element that is equivalent to one divided by this element. #### Defined in -[snarky.d.ts:163](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L163) +[snarky.d.ts:84](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L84) ___ @@ -715,7 +715,7 @@ Checks whether this is a hard-coded constant in the Circuit. #### Defined in -[snarky.d.ts:480](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L480) +[snarky.d.ts:401](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L401) ___ @@ -729,7 +729,7 @@ ___ #### Defined in -[snarky.d.ts:449](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L449) +[snarky.d.ts:370](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L370) ___ @@ -756,7 +756,7 @@ Field(2).lessThan(3); // Bool(true) #### Defined in -[snarky.d.ts:244](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L244) +[snarky.d.ts:165](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L165) ___ @@ -783,7 +783,7 @@ Field(2).lessThanOrEqual(3); // Bool(true) #### Defined in -[snarky.d.ts:254](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L254) +[snarky.d.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L175) ___ @@ -814,7 +814,7 @@ Field(2).lt(3); // Bool(true) #### Defined in -[snarky.d.ts:337](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L337) +[snarky.d.ts:258](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L258) ___ @@ -845,7 +845,7 @@ Field(2).lte(3); // Bool(true) #### Defined in -[snarky.d.ts:348](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L348) +[snarky.d.ts:269](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L269) ___ @@ -867,7 +867,7 @@ Multiplies this [Field](Field.md) element with another coercible to a field. #### Defined in -[snarky.d.ts:183](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L183) +[snarky.d.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L104) ___ @@ -889,7 +889,7 @@ negOne.assertEquals(-1); #### Defined in -[snarky.d.ts:151](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L151) +[snarky.d.ts:72](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L72) ___ @@ -909,7 +909,7 @@ ___ #### Defined in -[snarky.d.ts:475](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L475) +[snarky.d.ts:396](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L396) ___ @@ -923,7 +923,7 @@ ___ #### Defined in -[snarky.d.ts:473](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L473) +[snarky.d.ts:394](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L394) ___ @@ -939,7 +939,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:228](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L228) +[snarky.d.ts:149](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L149) ___ @@ -959,7 +959,7 @@ x.square().sqrt().assertEquals(x); #### Defined in -[snarky.d.ts:207](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L207) +[snarky.d.ts:128](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L128) ___ @@ -980,7 +980,7 @@ x2.assertEquals(x.mul(x)); #### Defined in -[snarky.d.ts:198](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L198) +[snarky.d.ts:119](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L119) ___ @@ -1002,7 +1002,7 @@ Subtracts another [Field](Field.md)-like element from this one. #### Defined in -[snarky.d.ts:178](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L178) +[snarky.d.ts:99](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L99) ___ @@ -1019,7 +1019,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:218](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L218) +[snarky.d.ts:139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L139) ___ @@ -1035,7 +1035,7 @@ Little endian binary representation of the field element. #### Defined in -[snarky.d.ts:454](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L454) +[snarky.d.ts:375](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L375) ▸ **toBits**(`length`): [`Bool`](Bool.md)[] @@ -1054,7 +1054,7 @@ Fails if the field element cannot fit in `length` bits. #### Defined in -[snarky.d.ts:460](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L460) +[snarky.d.ts:381](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L381) ___ @@ -1070,7 +1070,7 @@ Returns a constant. #### Defined in -[snarky.d.ts:485](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L485) +[snarky.d.ts:406](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L406) ___ @@ -1086,7 +1086,7 @@ Serializes this data structure into [Field](Field.md) elements. #### Defined in -[snarky.d.ts:233](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L233) +[snarky.d.ts:154](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L154) ___ @@ -1103,7 +1103,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:223](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L223) +[snarky.d.ts:144](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L144) ___ @@ -1120,7 +1120,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L213) +[snarky.d.ts:134](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L134) ___ @@ -1140,7 +1140,7 @@ ___ #### Defined in -[snarky.d.ts:606](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L606) +[snarky.d.ts:527](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L527) ___ @@ -1163,7 +1163,7 @@ Fails if the field element cannot fit given too many bits. #### Defined in -[snarky.d.ts:582](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L582) +[snarky.d.ts:503](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L503) ___ @@ -1183,7 +1183,7 @@ ___ #### Defined in -[snarky.d.ts:611](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L611) +[snarky.d.ts:532](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L532) ___ @@ -1205,7 +1205,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:553](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L553) +[snarky.d.ts:474](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L474) ___ @@ -1228,7 +1228,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:604](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L604) +[snarky.d.ts:525](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L525) ___ @@ -1244,7 +1244,7 @@ A random field element. #### Defined in -[snarky.d.ts:516](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L516) +[snarky.d.ts:437](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L437) ___ @@ -1265,7 +1265,7 @@ ___ #### Defined in -[snarky.d.ts:612](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L612) +[snarky.d.ts:533](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L533) ___ @@ -1279,7 +1279,7 @@ ___ #### Defined in -[snarky.d.ts:616](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L616) +[snarky.d.ts:537](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L537) ___ @@ -1295,7 +1295,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:558](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L558) +[snarky.d.ts:479](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L479) ___ @@ -1317,7 +1317,7 @@ Static method to serialize a [Field](Field.md) into its auxiliary data. #### Defined in -[snarky.d.ts:567](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L567) +[snarky.d.ts:488](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L488) ___ @@ -1337,7 +1337,7 @@ ___ #### Defined in -[snarky.d.ts:610](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L610) +[snarky.d.ts:531](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L531) ___ @@ -1359,7 +1359,7 @@ Static method to serialize a [Field](Field.md) into an array of [Field](Field.md #### Defined in -[snarky.d.ts:563](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L563) +[snarky.d.ts:484](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L484) ___ @@ -1383,7 +1383,7 @@ ___ #### Defined in -[snarky.d.ts:609](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L609) +[snarky.d.ts:530](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L530) ___ @@ -1406,4 +1406,4 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:598](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L598) +[snarky.d.ts:519](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L519) diff --git a/docs/zkapps/snarkyjs-reference/classes/Group.md b/docs/zkapps/snarkyjs-reference/classes/Group.md index 97da6cc32..6f74b95f3 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Group.md +++ b/docs/zkapps/snarkyjs-reference/classes/Group.md @@ -53,7 +53,7 @@ Represents a point with x and y coordinates on an elliptic curve. #### Defined in -[snarky.d.ts:960](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L960) +[snarky.d.ts:1024](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1024) • **new Group**(`x`, `y`) @@ -66,7 +66,7 @@ Represents a point with x and y coordinates on an elliptic curve. #### Defined in -[snarky.d.ts:964](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L964) +[snarky.d.ts:1028](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1028) ## Properties @@ -76,7 +76,7 @@ Represents a point with x and y coordinates on an elliptic curve. #### Defined in -[snarky.d.ts:921](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L921) +[snarky.d.ts:985](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L985) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[snarky.d.ts:922](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L922) +[snarky.d.ts:986](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L986) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[snarky.d.ts:969](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L969) +[snarky.d.ts:1033](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1033) ## Methods @@ -118,7 +118,7 @@ Adds two [Group](Group.md) elements together. #### Defined in -[snarky.d.ts:927](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L927) +[snarky.d.ts:991](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L991) ___ @@ -141,7 +141,7 @@ Asserts that two [Group](Group.md) elements are equal. #### Defined in -[snarky.d.ts:948](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L948) +[snarky.d.ts:1012](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1012) ___ @@ -163,7 +163,7 @@ Checks if two [Group](Group.md) elements are equal. #### Defined in -[snarky.d.ts:953](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L953) +[snarky.d.ts:1017](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1017) ___ @@ -179,7 +179,7 @@ Negates this [Group](Group.md) elements and returns a new instance. #### Defined in -[snarky.d.ts:937](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L937) +[snarky.d.ts:1001](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1001) ___ @@ -201,7 +201,7 @@ Scales this [Group](Group.md) element using a [Scalar](Scalar.md). #### Defined in -[snarky.d.ts:942](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L942) +[snarky.d.ts:1006](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1006) ___ @@ -223,7 +223,7 @@ Subtracts one [Group](Group.md) element from the other. #### Defined in -[snarky.d.ts:932](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L932) +[snarky.d.ts:996](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L996) ___ @@ -244,7 +244,7 @@ Returns the JSON representation of this [Group](Group.md) element. #### Defined in -[snarky.d.ts:958](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L958) +[snarky.d.ts:1022](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1022) ___ @@ -267,7 +267,7 @@ Adds two [Group](Group.md) elements together. #### Defined in -[snarky.d.ts:973](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L973) +[snarky.d.ts:1037](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1037) ___ @@ -290,7 +290,7 @@ Asserts that two [Group](Group.md) elements are equal. #### Defined in -[snarky.d.ts:992](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L992) +[snarky.d.ts:1056](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1056) ___ @@ -310,7 +310,7 @@ ___ #### Defined in -[snarky.d.ts:1030](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1030) +[snarky.d.ts:1094](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1094) ___ @@ -333,7 +333,7 @@ Checks if two [Group](Group.md) elements are equal. #### Defined in -[snarky.d.ts:997](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L997) +[snarky.d.ts:1061](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1061) ___ @@ -355,7 +355,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:1009](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1009) +[snarky.d.ts:1073](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1073) ___ @@ -380,7 +380,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:1023](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1023) +[snarky.d.ts:1087](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1087) ___ @@ -402,7 +402,7 @@ Negates a [Group](Group.md) elements and returns a new instance. #### Defined in -[snarky.d.ts:981](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L981) +[snarky.d.ts:1045](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1045) ___ @@ -425,7 +425,7 @@ Scales this [Group](Group.md) element using a [Scalar](Scalar.md). #### Defined in -[snarky.d.ts:986](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L986) +[snarky.d.ts:1050](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1050) ___ @@ -441,7 +441,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:1013](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1013) +[snarky.d.ts:1077](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1077) ___ @@ -464,7 +464,7 @@ Subtracts one [Group](Group.md) element from the other. #### Defined in -[snarky.d.ts:977](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L977) +[snarky.d.ts:1041](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1041) ___ @@ -486,7 +486,7 @@ Static method to serialize a [Group](Group.md) into its auxiliary data. #### Defined in -[snarky.d.ts:1005](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1005) +[snarky.d.ts:1069](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1069) ___ @@ -508,7 +508,7 @@ Static method to serialize a [Group](Group.md) into an array of [Field](Field.md #### Defined in -[snarky.d.ts:1001](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1001) +[snarky.d.ts:1065](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1065) ___ @@ -536,4 +536,4 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:1018](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1018) +[snarky.d.ts:1082](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1082) diff --git a/docs/zkapps/snarkyjs-reference/classes/Int64.md b/docs/zkapps/snarkyjs-reference/classes/Int64.md index 4ce5512be..003668cdb 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Int64.md +++ b/docs/zkapps/snarkyjs-reference/classes/Int64.md @@ -80,7 +80,7 @@ A 64 bit signed integer with values ranging from -18,446,744,073,709,551,615 to #### Defined in -[lib/int.ts:790](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L790) +[lib/int.ts:785](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L785) ## Properties @@ -94,7 +94,7 @@ BalanceChange.magnitude #### Defined in -[lib/int.ts:767](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L767) +[lib/int.ts:762](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L762) ___ @@ -108,7 +108,7 @@ BalanceChange.sgn #### Defined in -[lib/int.ts:768](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L768) +[lib/int.ts:763](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L763) ## Accessors @@ -124,7 +124,7 @@ Static method to create a [Int64](Int64.md) with value `-1`. #### Defined in -[lib/int.ts:865](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L865) +[lib/int.ts:861](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L861) ___ @@ -140,7 +140,7 @@ Static method to create a [Int64](Int64.md) with value `1`. #### Defined in -[lib/int.ts:859](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L859) +[lib/int.ts:855](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L855) ___ @@ -156,7 +156,7 @@ Static method to create a [Int64](Int64.md) with value `0`. #### Defined in -[lib/int.ts:853](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L853) +[lib/int.ts:849](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L849) ## Methods @@ -178,7 +178,7 @@ Addition with overflow checking. #### Defined in -[lib/int.ts:899](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L899) +[lib/int.ts:895](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L895) ___ @@ -205,7 +205,7 @@ Asserts that two values are equal. #### Defined in -[lib/int.ts:953](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L953) +[lib/int.ts:949](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L949) ___ @@ -230,7 +230,7 @@ Integer division. #### Defined in -[lib/int.ts:924](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L924) +[lib/int.ts:920](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L920) ___ @@ -256,7 +256,7 @@ Checks if two values are equal. #### Defined in -[lib/int.ts:946](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L946) +[lib/int.ts:942](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L942) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[lib/int.ts:842](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L842) +[lib/int.ts:838](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L838) ___ @@ -290,7 +290,7 @@ Checks if the value is postive. #### Defined in -[lib/int.ts:963](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L963) +[lib/int.ts:959](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L959) ___ @@ -315,7 +315,7 @@ Integer remainder. #### Defined in -[lib/int.ts:936](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L936) +[lib/int.ts:932](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L932) ___ @@ -337,7 +337,7 @@ Multiplication with overflow checking. #### Defined in -[lib/int.ts:913](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L913) +[lib/int.ts:909](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L909) ___ @@ -355,7 +355,7 @@ Negates the value. #### Defined in -[lib/int.ts:892](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L892) +[lib/int.ts:888](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L888) ___ @@ -377,7 +377,7 @@ Subtraction with underflow checking. #### Defined in -[lib/int.ts:906](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L906) +[lib/int.ts:902](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L902) ___ @@ -395,7 +395,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -411,7 +411,7 @@ Returns the [Field](Field.md) value. #### Defined in -[lib/int.ts:872](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L872) +[lib/int.ts:868](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L868) ___ @@ -429,7 +429,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -447,7 +447,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -463,7 +463,7 @@ Turns the [Int64](Int64.md) into a string. #### Defined in -[lib/int.ts:837](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L837) +[lib/int.ts:832](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L832) ___ @@ -494,7 +494,7 @@ ___ #### Defined in -[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) +[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) ___ @@ -518,7 +518,7 @@ Check the range if the argument is a constant. #### Defined in -[lib/int.ts:827](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L827) +[lib/int.ts:822](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L822) ___ @@ -540,7 +540,7 @@ Static method to create a [Int64](Int64.md) from a [Field](Field.md). #### Defined in -[lib/int.ts:878](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L878) +[lib/int.ts:874](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L874) ___ @@ -564,7 +564,7 @@ Does check if the [Field](Field.md) is within range. #### Defined in -[lib/int.ts:799](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L799) +[lib/int.ts:794](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L794) ___ @@ -595,7 +595,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -626,7 +626,7 @@ ___ #### Defined in -[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) +[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) ___ @@ -657,7 +657,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -681,7 +681,7 @@ Creates a new [Int64](Int64.md) from a [Field](Field.md). #### Defined in -[lib/int.ts:817](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L817) +[lib/int.ts:812](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L812) ___ @@ -699,7 +699,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -717,7 +717,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -748,7 +748,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -779,7 +779,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -810,7 +810,7 @@ ___ #### Defined in -[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) +[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) ___ @@ -841,4 +841,4 @@ ___ #### Defined in -[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) +[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) diff --git a/docs/zkapps/snarkyjs-reference/classes/Keypair.md b/docs/zkapps/snarkyjs-reference/classes/Keypair.md index 131420595..a7c73219e 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Keypair.md +++ b/docs/zkapps/snarkyjs-reference/classes/Keypair.md @@ -1,72 +1,25 @@ # Class: Keypair +Contains a proving key and [VerificationKey](VerificationKey.md) which can be used to verify proofs. + ## Table of contents ### Constructors - [constructor](Keypair.md#constructor) -### Properties - -- [value](Keypair.md#value) - ### Methods -- [constraintSystem](Keypair.md#constraintsystem) - [verificationKey](Keypair.md#verificationkey) ## Constructors ### constructor -• **new Keypair**(`value`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `unknown` | - -#### Defined in - -[lib/circuit.ts:137](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L137) - -## Properties - -### value - -• **value**: `unknown` - -#### Defined in - -[lib/circuit.ts:135](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L135) +• **new Keypair**() ## Methods -### constraintSystem - -▸ **constraintSystem**(): `Gate`[] - -Returns a low-level JSON representation of the [Circuit](Circuit.md) from its [Keypair](Keypair.md): -a list of gates, each of which represents a row in a table, with certain coefficients and wires to other (row, column) pairs - -**`Example`** - -```ts -const keypair = await MyCircuit.generateKeypair(); -const json = MyCircuit.constraintSystemFromKeypair(keypair); -``` - -#### Returns - -`Gate`[] - -#### Defined in - -[lib/circuit.ts:156](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L156) - -___ - ### verificationKey ▸ **verificationKey**(): `VerificationKey` @@ -77,4 +30,4 @@ ___ #### Defined in -[lib/circuit.ts:141](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit.ts#L141) +[snarky.d.ts:1135](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1135) diff --git a/docs/zkapps/snarkyjs-reference/classes/Ledger.md b/docs/zkapps/snarkyjs-reference/classes/Ledger.md index 514516d68..30972eb2e 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Ledger.md +++ b/docs/zkapps/snarkyjs-reference/classes/Ledger.md @@ -63,7 +63,7 @@ Represents the Mina ledger. #### Defined in -[snarky.d.ts:1174](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1174) +[snarky.d.ts:1257](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1257) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[snarky.d.ts:1163](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1163) +[snarky.d.ts:1246](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1246) ## Methods @@ -108,7 +108,7 @@ Adds an account and its balance to the ledger. #### Defined in -[snarky.d.ts:1079](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1079) +[snarky.d.ts:1162](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1162) ___ @@ -132,7 +132,7 @@ Applies a JSON transaction to the ledger. #### Defined in -[snarky.d.ts:1084](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1084) +[snarky.d.ts:1167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1167) ___ @@ -155,7 +155,7 @@ Returns an account. #### Defined in -[snarky.d.ts:1093](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1093) +[snarky.d.ts:1176](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1176) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[snarky.d.ts:1154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1154) +[snarky.d.ts:1237](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1237) ___ @@ -198,7 +198,7 @@ Creates a fresh ledger. #### Defined in -[snarky.d.ts:1072](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1072) +[snarky.d.ts:1155](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1155) ___ @@ -219,7 +219,7 @@ ___ #### Defined in -[snarky.d.ts:1142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1142) +[snarky.d.ts:1225](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1225) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[snarky.d.ts:1140](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1140) +[snarky.d.ts:1223](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1223) ___ @@ -261,7 +261,7 @@ ___ #### Defined in -[snarky.d.ts:1141](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1141) +[snarky.d.ts:1224](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1224) ___ @@ -277,7 +277,7 @@ Returns a dummy signature. #### Defined in -[snarky.d.ts:1124](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1124) +[snarky.d.ts:1207](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1207) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -[snarky.d.ts:1149](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1149) +[snarky.d.ts:1232](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1232) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -[snarky.d.ts:1148](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1148) +[snarky.d.ts:1231](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1231) ___ @@ -337,7 +337,7 @@ ___ #### Defined in -[snarky.d.ts:1159](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1159) +[snarky.d.ts:1242](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1242) ___ @@ -357,7 +357,7 @@ ___ #### Defined in -[snarky.d.ts:1160](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1160) +[snarky.d.ts:1243](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1243) ___ @@ -377,7 +377,7 @@ ___ #### Defined in -[snarky.d.ts:1161](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1161) +[snarky.d.ts:1244](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1244) ___ @@ -397,7 +397,7 @@ ___ #### Defined in -[snarky.d.ts:1152](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1152) +[snarky.d.ts:1235](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1235) ___ @@ -417,7 +417,7 @@ ___ #### Defined in -[snarky.d.ts:1151](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1151) +[snarky.d.ts:1234](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1234) ___ @@ -437,7 +437,7 @@ ___ #### Defined in -[snarky.d.ts:1147](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1147) +[snarky.d.ts:1230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1230) ___ @@ -458,7 +458,7 @@ ___ #### Defined in -[snarky.d.ts:1146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1146) +[snarky.d.ts:1229](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1229) ___ @@ -478,7 +478,7 @@ ___ #### Defined in -[snarky.d.ts:1145](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1145) +[snarky.d.ts:1228](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1228) ___ @@ -498,7 +498,7 @@ ___ #### Defined in -[snarky.d.ts:1144](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1144) +[snarky.d.ts:1227](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1227) ___ @@ -522,7 +522,7 @@ Signs a transaction as the fee payer. #### Defined in -[snarky.d.ts:1129](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1129) +[snarky.d.ts:1212](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1212) ___ @@ -547,7 +547,7 @@ Signs a [Field](Field.md) element. #### Defined in -[snarky.d.ts:1115](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1115) +[snarky.d.ts:1198](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1198) ___ @@ -572,7 +572,7 @@ Signs an account update. #### Defined in -[snarky.d.ts:1134](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1134) +[snarky.d.ts:1217](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1217) ___ @@ -600,7 +600,7 @@ Returns the commitment of a JSON transaction. #### Defined in -[snarky.d.ts:1098](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1098) +[snarky.d.ts:1181](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1181) ___ @@ -628,4 +628,4 @@ Returns the public input of a zkApp transaction. #### Defined in -[snarky.d.ts:1107](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L1107) +[snarky.d.ts:1190](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L1190) diff --git a/docs/zkapps/snarkyjs-reference/classes/MerkleMap.md b/docs/zkapps/snarkyjs-reference/classes/MerkleMap.md index 811718ace..028288abd 100644 --- a/docs/zkapps/snarkyjs-reference/classes/MerkleMap.md +++ b/docs/zkapps/snarkyjs-reference/classes/MerkleMap.md @@ -28,7 +28,7 @@ Creates a new, empty Merkle Map. #### Defined in -[lib/merkle_map.ts:19](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L19) +[lib/merkle_map.ts:19](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L19) ## Properties @@ -38,7 +38,7 @@ Creates a new, empty Merkle Map. #### Defined in -[lib/merkle_map.ts:11](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L11) +[lib/merkle_map.ts:11](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L11) ## Methods @@ -58,7 +58,7 @@ Creates a new, empty Merkle Map. #### Defined in -[lib/merkle_map.ts:34](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L34) +[lib/merkle_map.ts:34](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L34) ___ @@ -82,7 +82,7 @@ The value stored at the key. #### Defined in -[lib/merkle_map.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L70) +[lib/merkle_map.ts:70](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L70) ___ @@ -100,7 +100,7 @@ The root of the Merkle Map. #### Defined in -[lib/merkle_map.ts:81](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L81) +[lib/merkle_map.ts:81](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L81) ___ @@ -124,7 +124,7 @@ A MerkleMapWitness, which can be used to assert changes to the MerkleMap, and th #### Defined in -[lib/merkle_map.ts:90](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L90) +[lib/merkle_map.ts:90](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L90) ___ @@ -147,4 +147,4 @@ Sets a key of the merkle map to a given value. #### Defined in -[lib/merkle_map.ts:58](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L58) +[lib/merkle_map.ts:58](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L58) diff --git a/docs/zkapps/snarkyjs-reference/classes/MerkleMapWitness.md b/docs/zkapps/snarkyjs-reference/classes/MerkleMapWitness.md index 134af9307..135c347f4 100644 --- a/docs/zkapps/snarkyjs-reference/classes/MerkleMapWitness.md +++ b/docs/zkapps/snarkyjs-reference/classes/MerkleMapWitness.md @@ -60,7 +60,7 @@ #### Defined in -[lib/merkle_map.ts:121](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L121) +[lib/merkle_map.ts:121](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L121) ## Properties @@ -70,7 +70,7 @@ #### Defined in -[lib/merkle_map.ts:118](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L118) +[lib/merkle_map.ts:118](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L118) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[lib/merkle_map.ts:119](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L119) +[lib/merkle_map.ts:119](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L119) ## Methods @@ -104,7 +104,7 @@ ___ #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -128,7 +128,7 @@ A tuple of the computed merkle root, and the key that is connected to the path u #### Defined in -[lib/merkle_map.ts:132](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_map.ts#L132) +[lib/merkle_map.ts:132](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_map.ts#L132) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -255,7 +255,7 @@ ___ #### Defined in -[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) +[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) +[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) ___ @@ -348,7 +348,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -384,7 +384,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -415,7 +415,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -446,7 +446,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -477,7 +477,7 @@ ___ #### Defined in -[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) +[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) ___ @@ -508,4 +508,4 @@ ___ #### Defined in -[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) +[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) diff --git a/docs/zkapps/snarkyjs-reference/classes/MerkleTree.md b/docs/zkapps/snarkyjs-reference/classes/MerkleTree.md index 8116c3699..92932e475 100644 --- a/docs/zkapps/snarkyjs-reference/classes/MerkleTree.md +++ b/docs/zkapps/snarkyjs-reference/classes/MerkleTree.md @@ -51,7 +51,7 @@ Creates a new, empty [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). #### Defined in -[lib/merkle_tree.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L37) +[lib/merkle_tree.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L37) ## Properties @@ -63,7 +63,7 @@ The height of Merkle Tree. #### Defined in -[lib/merkle_tree.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L37) +[lib/merkle_tree.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L37) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[lib/merkle_tree.ts:29](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L29) +[lib/merkle_tree.ts:29](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L29) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[lib/merkle_tree.ts:30](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L30) +[lib/merkle_tree.ts:30](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L30) ## Accessors @@ -101,7 +101,7 @@ Amount of leaf nodes. #### Defined in -[lib/merkle_tree.ts:145](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L145) +[lib/merkle_tree.ts:145](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L145) ## Methods @@ -123,7 +123,7 @@ Fills all leaves of the tree. #### Defined in -[lib/merkle_tree.ts:135](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L135) +[lib/merkle_tree.ts:135](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L135) ___ @@ -148,7 +148,7 @@ The data of the node. #### Defined in -[lib/merkle_tree.ts:50](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L50) +[lib/merkle_tree.ts:50](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L50) ___ @@ -166,7 +166,7 @@ The root of the Merkle Tree. #### Defined in -[lib/merkle_tree.ts:58](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L58) +[lib/merkle_tree.ts:58](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L58) ___ @@ -190,7 +190,7 @@ The witness that belongs to the leaf. #### Defined in -[lib/merkle_tree.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L96) +[lib/merkle_tree.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L96) ___ @@ -213,7 +213,7 @@ Sets the value of a leaf node at a given index to a given value. #### Defined in -[lib/merkle_tree.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L73) +[lib/merkle_tree.ts:73](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L73) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -[lib/merkle_tree.ts:63](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L63) +[lib/merkle_tree.ts:63](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L63) ___ @@ -259,4 +259,4 @@ True if the witness for the leaf node is valid. #### Defined in -[lib/merkle_tree.ts:118](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/merkle_tree.ts#L118) +[lib/merkle_tree.ts:118](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/merkle_tree.ts#L118) diff --git a/docs/zkapps/snarkyjs-reference/classes/PrivateKey.md b/docs/zkapps/snarkyjs-reference/classes/PrivateKey.md index f3980813f..72713b52a 100644 --- a/docs/zkapps/snarkyjs-reference/classes/PrivateKey.md +++ b/docs/zkapps/snarkyjs-reference/classes/PrivateKey.md @@ -61,7 +61,7 @@ A signing key. You can generate one via [random](PrivateKey.md#random). #### Defined in -[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) ## Properties @@ -71,7 +71,7 @@ A signing key. You can generate one via [random](PrivateKey.md#random). #### Defined in -[lib/signature.ts:18](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L18) +[lib/signature.ts:18](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L18) ## Methods @@ -95,7 +95,7 @@ A signing key. You can generate one via [random](PrivateKey.md#random). #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -155,7 +155,7 @@ a base58 encoded string #### Defined in -[lib/signature.ts:64](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L64) +[lib/signature.ts:64](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L64) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -227,7 +227,7 @@ a [PublicKey](Types.PublicKey.md). #### Defined in -[lib/signature.ts:46](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L46) +[lib/signature.ts:46](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L46) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) +[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) ___ @@ -282,7 +282,7 @@ a [PrivateKey](PrivateKey.md). #### Defined in -[lib/signature.ts:55](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L55) +[lib/signature.ts:55](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L55) ___ @@ -306,7 +306,7 @@ a [PrivateKey](PrivateKey.md). #### Defined in -[lib/signature.ts:37](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L37) +[lib/signature.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L37) ___ @@ -337,7 +337,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) +[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -419,7 +419,7 @@ a new [PrivateKey](PrivateKey.md). #### Defined in -[lib/signature.ts:27](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L27) +[lib/signature.ts:27](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L27) ___ @@ -437,7 +437,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -455,7 +455,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -480,7 +480,7 @@ a base58 encoded string #### Defined in -[lib/signature.ts:73](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L73) +[lib/signature.ts:73](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L73) ___ @@ -511,7 +511,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -542,7 +542,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -573,7 +573,7 @@ ___ #### Defined in -[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) +[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) ___ @@ -604,4 +604,4 @@ ___ #### Defined in -[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) +[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) diff --git a/docs/zkapps/snarkyjs-reference/classes/Proof.md b/docs/zkapps/snarkyjs-reference/classes/Proof.md index 002d4ec2e..b320cac11 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Proof.md +++ b/docs/zkapps/snarkyjs-reference/classes/Proof.md @@ -62,7 +62,7 @@ #### Defined in -[lib/proof_system.ts:132](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L132) +[lib/proof_system.ts:139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L139) ## Properties @@ -72,7 +72,7 @@ #### Defined in -[lib/proof_system.ts:90](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L90) +[lib/proof_system.ts:97](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L97) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[lib/proof_system.ts:89](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L89) +[lib/proof_system.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L96) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[lib/proof_system.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L87) +[lib/proof_system.ts:94](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L94) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[lib/proof_system.ts:88](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L88) +[lib/proof_system.ts:95](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L95) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[lib/proof_system.ts:91](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L91) +[lib/proof_system.ts:98](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L98) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[lib/proof_system.ts:79](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L79) +[lib/proof_system.ts:86](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L86) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[lib/proof_system.ts:80](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L80) +[lib/proof_system.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L87) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[lib/proof_system.ts:81](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L81) +[lib/proof_system.ts:88](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L88) ## Methods @@ -168,7 +168,7 @@ ___ #### Defined in -[lib/proof_system.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L99) +[lib/proof_system.ts:106](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L106) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[lib/proof_system.ts:93](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L93) +[lib/proof_system.ts:100](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L100) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[lib/proof_system.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L96) +[lib/proof_system.ts:103](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L103) ___ @@ -229,4 +229,4 @@ ___ #### Defined in -[lib/proof_system.ts:108](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L108) +[lib/proof_system.ts:115](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L115) diff --git a/docs/zkapps/snarkyjs-reference/classes/Scalar.md b/docs/zkapps/snarkyjs-reference/classes/Scalar.md index d668dc025..b44cef5e8 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Scalar.md +++ b/docs/zkapps/snarkyjs-reference/classes/Scalar.md @@ -56,7 +56,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:842](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L842) +[snarky.d.ts:906](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L906) ___ @@ -79,7 +79,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:860](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L860) +[snarky.d.ts:924](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L924) ___ @@ -102,7 +102,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:854](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L854) +[snarky.d.ts:918](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L918) ___ @@ -119,7 +119,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:836](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L836) +[snarky.d.ts:900](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L900) ___ @@ -142,7 +142,7 @@ Can only be called outside of circuit execution #### Defined in -[snarky.d.ts:848](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L848) +[snarky.d.ts:912](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L912) ___ @@ -162,7 +162,7 @@ Check out [toFieldsCompressed](Scalar.md#tofieldscompressed) for a user-friendly #### Defined in -[snarky.d.ts:822](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L822) +[snarky.d.ts:886](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L886) ___ @@ -178,7 +178,7 @@ Serializes this Scalar to a string #### Defined in -[snarky.d.ts:865](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L865) +[snarky.d.ts:929](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L929) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[snarky.d.ts:907](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L907) +[snarky.d.ts:971](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L971) ___ @@ -221,7 +221,7 @@ If the bigint is too large, it is reduced modulo the scalar field order. #### Defined in -[snarky.d.ts:906](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L906) +[snarky.d.ts:970](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L970) ___ @@ -243,7 +243,7 @@ Creates a data structure from an array of serialized [Bool](Bool.md). #### Defined in -[snarky.d.ts:886](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L886) +[snarky.d.ts:950](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L950) ___ @@ -265,7 +265,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements. #### Defined in -[snarky.d.ts:878](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L878) +[snarky.d.ts:942](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L942) ___ @@ -288,7 +288,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:901](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L901) +[snarky.d.ts:965](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L965) ___ @@ -305,7 +305,7 @@ Randomness can not be proven inside a circuit! #### Defined in -[snarky.d.ts:891](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L891) +[snarky.d.ts:955](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L955) ___ @@ -321,7 +321,7 @@ Returns the size of this type. #### Defined in -[snarky.d.ts:882](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L882) +[snarky.d.ts:946](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L946) ___ @@ -343,7 +343,7 @@ Static method to serialize a [Scalar](Scalar.md) into its auxiliary data. #### Defined in -[snarky.d.ts:874](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L874) +[snarky.d.ts:938](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L938) ___ @@ -365,7 +365,7 @@ Static method to serialize a [Scalar](Scalar.md) into an array of [Field](Field. #### Defined in -[snarky.d.ts:870](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L870) +[snarky.d.ts:934](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L934) ___ @@ -395,7 +395,7 @@ is needed to represent all Scalars. However, for a random Scalar, the high bit w #### Defined in -[snarky.d.ts:830](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L830) +[snarky.d.ts:894](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L894) ___ @@ -418,4 +418,4 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Defined in -[snarky.d.ts:896](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L896) +[snarky.d.ts:960](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L960) diff --git a/docs/zkapps/snarkyjs-reference/classes/SelfProof.md b/docs/zkapps/snarkyjs-reference/classes/SelfProof.md index f98c92140..b913f8c45 100644 --- a/docs/zkapps/snarkyjs-reference/classes/SelfProof.md +++ b/docs/zkapps/snarkyjs-reference/classes/SelfProof.md @@ -66,7 +66,7 @@ #### Defined in -[lib/proof_system.ts:132](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L132) +[lib/proof_system.ts:139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L139) ## Properties @@ -80,7 +80,7 @@ #### Defined in -[lib/proof_system.ts:90](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L90) +[lib/proof_system.ts:97](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L97) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[lib/proof_system.ts:89](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L89) +[lib/proof_system.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L96) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[lib/proof_system.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L87) +[lib/proof_system.ts:94](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L94) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[lib/proof_system.ts:88](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L88) +[lib/proof_system.ts:95](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L95) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[lib/proof_system.ts:91](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L91) +[lib/proof_system.ts:98](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L98) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[lib/proof_system.ts:79](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L79) +[lib/proof_system.ts:86](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L86) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[lib/proof_system.ts:80](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L80) +[lib/proof_system.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L87) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[lib/proof_system.ts:81](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L81) +[lib/proof_system.ts:88](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L88) ## Methods @@ -208,7 +208,7 @@ ___ #### Defined in -[lib/proof_system.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L99) +[lib/proof_system.ts:106](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L106) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[lib/proof_system.ts:93](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L93) +[lib/proof_system.ts:100](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L100) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[lib/proof_system.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L96) +[lib/proof_system.ts:103](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L103) ___ @@ -281,4 +281,4 @@ ___ #### Defined in -[lib/proof_system.ts:108](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L108) +[lib/proof_system.ts:115](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L115) diff --git a/docs/zkapps/snarkyjs-reference/classes/Sign.md b/docs/zkapps/snarkyjs-reference/classes/Sign.md index 6aca67d46..16de2f2b7 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Sign.md +++ b/docs/zkapps/snarkyjs-reference/classes/Sign.md @@ -67,7 +67,7 @@ #### Defined in -[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) ## Properties @@ -77,7 +77,7 @@ #### Defined in -[lib/int.ts:715](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L715) +[lib/int.ts:711](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L711) ## Accessors @@ -91,7 +91,7 @@ #### Defined in -[lib/int.ts:720](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L720) +[lib/int.ts:716](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L716) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -[lib/int.ts:717](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L717) +[lib/int.ts:713](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L713) ## Methods @@ -129,7 +129,7 @@ ___ #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -[lib/int.ts:749](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L749) +[lib/int.ts:745](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L745) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -[lib/int.ts:746](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L746) +[lib/int.ts:742](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L742) ___ @@ -219,7 +219,7 @@ ___ #### Defined in -[lib/int.ts:743](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L743) +[lib/int.ts:739](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L739) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -255,7 +255,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -273,7 +273,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -287,7 +287,7 @@ ___ #### Defined in -[lib/int.ts:752](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L752) +[lib/int.ts:748](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L748) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[lib/int.ts:723](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L723) +[lib/int.ts:719](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L719) ___ @@ -325,7 +325,7 @@ ___ #### Defined in -[lib/int.ts:727](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L727) +[lib/int.ts:723](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L723) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[lib/int.ts:738](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L738) +[lib/int.ts:734](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L734) ___ @@ -417,7 +417,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -435,7 +435,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -453,7 +453,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -484,7 +484,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -515,7 +515,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -539,7 +539,7 @@ ___ #### Defined in -[lib/int.ts:730](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L730) +[lib/int.ts:726](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L726) ___ @@ -563,4 +563,4 @@ ___ #### Defined in -[lib/int.ts:733](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L733) +[lib/int.ts:729](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L729) diff --git a/docs/zkapps/snarkyjs-reference/classes/Signature.md b/docs/zkapps/snarkyjs-reference/classes/Signature.md index d07f1676f..a7e265ca0 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Signature.md +++ b/docs/zkapps/snarkyjs-reference/classes/Signature.md @@ -60,7 +60,7 @@ A Schnorr [Signature](Signature.md) over the Pasta Curves. #### Defined in -[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) ## Properties @@ -70,7 +70,7 @@ A Schnorr [Signature](Signature.md) over the Pasta Curves. #### Defined in -[lib/signature.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L191) +[lib/signature.ts:191](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L191) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[lib/signature.ts:192](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L192) +[lib/signature.ts:192](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L192) ## Methods @@ -104,7 +104,7 @@ ___ #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -162,7 +162,7 @@ Encodes a [Signature](Signature.md) in base58 format. #### Defined in -[lib/signature.ts:252](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L252) +[lib/signature.ts:252](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L252) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -241,7 +241,7 @@ a [Bool](Bool.md) #### Defined in -[lib/signature.ts:226](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L226) +[lib/signature.ts:226](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L226) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) +[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) ___ @@ -297,7 +297,7 @@ a [Signature](Signature.md) #### Defined in -[lib/signature.ts:198](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L198) +[lib/signature.ts:198](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L198) ___ @@ -319,7 +319,7 @@ Decodes a base58 encoded signature into a [Signature](Signature.md). #### Defined in -[lib/signature.ts:242](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L242) +[lib/signature.ts:242](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L242) ___ @@ -350,7 +350,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -381,7 +381,7 @@ ___ #### Defined in -[lib/circuit_value.ts:224](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L224) +[lib/circuit_value.ts:241](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L241) ___ @@ -412,7 +412,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -430,7 +430,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -448,7 +448,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -479,7 +479,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -510,7 +510,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -541,7 +541,7 @@ ___ #### Defined in -[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) +[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) ___ @@ -572,4 +572,4 @@ ___ #### Defined in -[lib/circuit_value.ts:213](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L213) +[lib/circuit_value.ts:230](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L230) diff --git a/docs/zkapps/snarkyjs-reference/classes/SmartContract.md b/docs/zkapps/snarkyjs-reference/classes/SmartContract.md index fa314cc0a..9ddd18e7c 100644 --- a/docs/zkapps/snarkyjs-reference/classes/SmartContract.md +++ b/docs/zkapps/snarkyjs-reference/classes/SmartContract.md @@ -73,7 +73,7 @@ class YourSmartContract extends SmartContract { #### Defined in -[lib/zkapp.ts:635](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L635) +[lib/zkapp.ts:638](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L638) ## Properties @@ -90,7 +90,7 @@ class YourSmartContract extends SmartContract { #### Defined in -[lib/zkapp.ts:882](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L882) +[lib/zkapp.ts:888](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L888) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[lib/zkapp.ts:607](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L607) +[lib/zkapp.ts:610](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L610) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[lib/zkapp.ts:604](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L604) +[lib/zkapp.ts:607](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L607) ___ @@ -126,7 +126,7 @@ A list of event types that can be emitted using this.emitEvent()`. #### Defined in -[lib/zkapp.ts:993](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L993) +[lib/zkapp.ts:999](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L999) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[lib/zkapp.ts:605](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L605) +[lib/zkapp.ts:608](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L608) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[lib/zkapp.ts:620](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L620) +[lib/zkapp.ts:623](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L623) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[lib/zkapp.ts:609](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L609) +[lib/zkapp.ts:612](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L612) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[lib/zkapp.ts:608](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L608) +[lib/zkapp.ts:611](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L611) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[lib/zkapp.ts:619](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L619) +[lib/zkapp.ts:622](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L622) ___ @@ -193,7 +193,7 @@ ___ #### Defined in -[lib/zkapp.ts:621](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L621) +[lib/zkapp.ts:624](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L624) ## Accessors @@ -209,7 +209,7 @@ Current account of the [SmartContract](SmartContract.md). #### Defined in -[lib/zkapp.ts:913](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L913) +[lib/zkapp.ts:919](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L919) ___ @@ -230,7 +230,7 @@ Balance of this [SmartContract](SmartContract.md). #### Defined in -[lib/zkapp.ts:987](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L987) +[lib/zkapp.ts:993](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L993) ___ @@ -248,7 +248,7 @@ or `assertEquals()` (confusing, because the developer can't know the exact slot #### Defined in -[lib/zkapp.ts:927](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L927) +[lib/zkapp.ts:933](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L933) ___ @@ -264,7 +264,7 @@ Current network state of the [SmartContract](SmartContract.md). #### Defined in -[lib/zkapp.ts:919](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L919) +[lib/zkapp.ts:925](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L925) ___ @@ -280,7 +280,7 @@ Returns the current [AccountUpdate](AccountUpdate.md) associated to this [SmartC #### Defined in -[lib/zkapp.ts:839](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L839) +[lib/zkapp.ts:845](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L845) ___ @@ -301,7 +301,7 @@ A malicious prover could use any other public key without affecting the validity #### Defined in -[lib/zkapp.ts:892](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L892) +[lib/zkapp.ts:898](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L898) ___ @@ -326,7 +326,7 @@ Token of the [SmartContract](SmartContract.md). #### Defined in -[lib/zkapp.ts:933](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L933) +[lib/zkapp.ts:939](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L939) ___ @@ -348,7 +348,7 @@ use `this.account.tokenSymbol` #### Defined in -[lib/zkapp.ts:981](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L981) +[lib/zkapp.ts:987](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L987) ## Methods @@ -388,7 +388,7 @@ The account update that was approved (needed when passing in a Callback) #### Defined in -[lib/zkapp.ts:959](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L959) +[lib/zkapp.ts:965](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L965) ___ @@ -422,7 +422,7 @@ tx.sign([senderKey, zkAppKey]); #### Defined in -[lib/zkapp.ts:725](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L725) +[lib/zkapp.ts:728](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L728) ___ @@ -451,7 +451,7 @@ Emits an event. Events will be emitted as a part of the transaction and can be c #### Defined in -[lib/zkapp.ts:999](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L999) +[lib/zkapp.ts:1005](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1005) ___ @@ -491,13 +491,13 @@ A promise that resolves to an array of objects, each containing the event type a #### Defined in -[lib/zkapp.ts:1045](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1045) +[lib/zkapp.ts:1051](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1051) ___ ### init -▸ **init**(): `void` +▸ **init**(`zkappKey?`): `void` `SmartContract.init()` will be called only when a [SmartContract](SmartContract.md) will be first deployed, not for redeployment. This method can be overridden as follows @@ -511,13 +511,19 @@ class MyContract extends SmartContract { } ``` +#### Parameters + +| Name | Type | +| :------ | :------ | +| `zkappKey?` | [`PrivateKey`](PrivateKey.md) | + #### Returns `void` #### Defined in -[lib/zkapp.ts:794](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L794) +[lib/zkapp.ts:798](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L798) ___ @@ -533,7 +539,7 @@ Same as `SmartContract.self` but explicitly creates a new [AccountUpdate](Accoun #### Defined in -[lib/zkapp.ts:874](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L874) +[lib/zkapp.ts:880](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L880) ___ @@ -557,7 +563,7 @@ with the only difference being that quick mock proofs are filled in instead of r #### Defined in -[lib/zkapp.ts:815](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L815) +[lib/zkapp.ts:821](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L821) ___ @@ -579,7 +585,7 @@ ___ #### Defined in -[lib/zkapp.ts:971](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L971) +[lib/zkapp.ts:977](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L977) ___ @@ -603,7 +609,7 @@ use `this.account.permissions.set()` #### Defined in -[lib/zkapp.ts:1225](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1225) +[lib/zkapp.ts:1231](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1231) ___ @@ -634,7 +640,7 @@ use `this.account..set()` #### Defined in -[lib/zkapp.ts:1218](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1218) +[lib/zkapp.ts:1224](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1224) ___ @@ -658,7 +664,7 @@ ___ #### Defined in -[lib/zkapp.ts:821](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L821) +[lib/zkapp.ts:827](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L827) ___ @@ -679,7 +685,7 @@ authorization flow. #### Defined in -[lib/zkapp.ts:832](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L832) +[lib/zkapp.ts:838](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L838) ___ @@ -695,7 +701,7 @@ typeof `__class` #### Defined in -[lib/zkapp.ts:626](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L626) +[lib/zkapp.ts:629](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L629) ___ @@ -728,7 +734,7 @@ an object, keyed by method name, each entry containing: #### Defined in -[lib/zkapp.ts:1165](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1165) +[lib/zkapp.ts:1171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1171) ___ @@ -755,7 +761,7 @@ up to several minutes if your circuit is large or your hardware is not optimal f #### Defined in -[lib/zkapp.ts:662](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L662) +[lib/zkapp.ts:665](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L665) ___ @@ -775,7 +781,7 @@ the digest, as a hex string #### Defined in -[lib/zkapp.ts:704](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L704) +[lib/zkapp.ts:707](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L707) ___ @@ -795,4 +801,4 @@ ___ #### Defined in -[lib/zkapp.ts:1139](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1139) +[lib/zkapp.ts:1145](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1145) diff --git a/docs/zkapps/snarkyjs-reference/classes/Token.md b/docs/zkapps/snarkyjs-reference/classes/Token.md index 8c2f73e7e..03050f11a 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Token.md +++ b/docs/zkapps/snarkyjs-reference/classes/Token.md @@ -37,7 +37,7 @@ use `TokenId` instead of `Token.Id` and `TokenId.derive()` instead of `Token.get #### Defined in -[lib/account_update.ts:630](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L630) +[lib/account_update.ts:630](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L630) ## Properties @@ -47,7 +47,7 @@ use `TokenId` instead of `Token.Id` and `TokenId.derive()` instead of `Token.get #### Defined in -[lib/account_update.ts:627](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L627) +[lib/account_update.ts:627](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L627) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[lib/account_update.ts:628](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L628) +[lib/account_update.ts:628](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L628) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[lib/account_update.ts:629](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L629) +[lib/account_update.ts:629](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L629) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[lib/account_update.ts:621](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L621) +[lib/account_update.ts:621](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L621) ## Methods @@ -116,4 +116,4 @@ ___ #### Defined in -[lib/account_update.ts:623](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L623) +[lib/account_update.ts:623](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L623) diff --git a/docs/zkapps/snarkyjs-reference/classes/TokenSymbol.md b/docs/zkapps/snarkyjs-reference/classes/TokenSymbol.md index abcad20b2..bd3b2f6ce 100644 --- a/docs/zkapps/snarkyjs-reference/classes/TokenSymbol.md +++ b/docs/zkapps/snarkyjs-reference/classes/TokenSymbol.md @@ -54,7 +54,7 @@ Struct(TokenSymbolPure).constructor #### Defined in -[lib/circuit_value.ts:365](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L365) +[lib/circuit_value.ts:467](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L467) ## Properties @@ -68,7 +68,7 @@ Struct(TokenSymbolPure).field #### Defined in -[lib/hash.ts:137](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L137) +[lib/hash.ts:141](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L141) ___ @@ -82,7 +82,7 @@ Struct(TokenSymbolPure).symbol #### Defined in -[lib/hash.ts:137](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L137) +[lib/hash.ts:141](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L141) ___ @@ -96,7 +96,7 @@ Struct(TokenSymbolPure).\_isStruct #### Defined in -[lib/circuit_value.ts:365](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L365) +[lib/circuit_value.ts:467](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L467) ___ @@ -126,7 +126,7 @@ Struct(TokenSymbolPure).check #### Defined in -[snarky.d.ts:30](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L30) +[snarky.d.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L37) ___ @@ -160,7 +160,7 @@ Struct(TokenSymbolPure).fromFields #### Defined in -[snarky.d.ts:28](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L28) +[snarky.d.ts:35](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L35) ___ @@ -193,7 +193,7 @@ Struct(TokenSymbolPure).fromJSON #### Defined in -[lib/circuit_value.ts:373](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L373) +[lib/circuit_value.ts:475](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L475) ___ @@ -223,7 +223,7 @@ Struct(TokenSymbolPure).toAuxiliary #### Defined in -[snarky.d.ts:27](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L27) +[snarky.d.ts:34](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L34) ___ @@ -253,7 +253,7 @@ Struct(TokenSymbolPure).toFields #### Defined in -[snarky.d.ts:26](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L26) +[snarky.d.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L33) ___ @@ -288,7 +288,7 @@ Struct(TokenSymbolPure).toInput #### Defined in -[lib/circuit_value.ts:368](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L368) +[lib/circuit_value.ts:470](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L470) ___ @@ -318,7 +318,7 @@ Struct(TokenSymbolPure).toJSON #### Defined in -[lib/circuit_value.ts:372](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L372) +[lib/circuit_value.ts:474](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L474) ## Accessors @@ -337,7 +337,7 @@ Struct(TokenSymbolPure).toJSON #### Defined in -[lib/hash.ts:168](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L168) +[lib/hash.ts:172](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L172) ## Methods @@ -357,7 +357,7 @@ Struct(TokenSymbolPure).toJSON #### Defined in -[lib/hash.ts:172](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/hash.ts#L172) +[lib/hash.ts:176](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/hash.ts#L176) ___ @@ -375,4 +375,4 @@ Struct(TokenSymbolPure).sizeInFields #### Defined in -[snarky.d.ts:29](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L29) +[snarky.d.ts:36](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L36) diff --git a/docs/zkapps/snarkyjs-reference/classes/Types.PublicKey.md b/docs/zkapps/snarkyjs-reference/classes/Types.PublicKey.md index 6d7d46dc8..e26e838dd 100644 --- a/docs/zkapps/snarkyjs-reference/classes/Types.PublicKey.md +++ b/docs/zkapps/snarkyjs-reference/classes/Types.PublicKey.md @@ -68,7 +68,7 @@ You can derive a [PublicKey](Types.PublicKey.md) directly from a [PrivateKey](Pr #### Defined in -[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) ## Properties @@ -78,7 +78,7 @@ You can derive a [PublicKey](Types.PublicKey.md) directly from a [PrivateKey](Pr #### Defined in -[lib/signature.ts:86](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L86) +[lib/signature.ts:86](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L86) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[lib/signature.ts:85](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L85) +[lib/signature.ts:85](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L85) ## Methods @@ -112,7 +112,7 @@ ___ #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -172,7 +172,7 @@ a [Bool](Bool.md) #### Defined in -[lib/signature.ts:143](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L143) +[lib/signature.ts:143](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L143) ___ @@ -190,7 +190,7 @@ a base58 encoded [PublicKey](Types.PublicKey.md) #### Defined in -[lib/signature.ts:160](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L160) +[lib/signature.ts:160](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L160) ___ @@ -208,7 +208,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -244,7 +244,7 @@ A [Group](Group.md) #### Defined in -[lib/signature.ts:92](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L92) +[lib/signature.ts:92](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L92) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -293,7 +293,7 @@ ___ #### Defined in -[lib/circuit_value.ts:191](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L191) +[lib/circuit_value.ts:208](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L208) ___ @@ -311,7 +311,7 @@ an empty [PublicKey](Types.PublicKey.md) #### Defined in -[lib/signature.ts:135](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L135) +[lib/signature.ts:135](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L135) ___ @@ -337,7 +337,7 @@ a [PublicKey](Types.PublicKey.md). #### Defined in -[lib/signature.ts:127](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L127) +[lib/signature.ts:127](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L127) ___ @@ -361,7 +361,7 @@ a [PublicKey](Types.PublicKey.md) #### Defined in -[lib/signature.ts:152](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L152) +[lib/signature.ts:152](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L152) ___ @@ -392,7 +392,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -416,7 +416,7 @@ a [PublicKey](Types.PublicKey.md). #### Defined in -[lib/signature.ts:110](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L110) +[lib/signature.ts:110](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L110) ___ @@ -451,7 +451,7 @@ a JSON string #### Defined in -[lib/signature.ts:182](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L182) +[lib/signature.ts:182](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L182) ___ @@ -482,7 +482,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -506,7 +506,7 @@ a [PublicKey](Types.PublicKey.md). #### Defined in -[lib/signature.ts:119](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L119) +[lib/signature.ts:119](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L119) ___ @@ -524,7 +524,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -542,7 +542,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -566,7 +566,7 @@ a base58 encoded [PublicKey](Types.PublicKey.md) #### Defined in -[lib/signature.ts:168](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L168) +[lib/signature.ts:168](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L168) ___ @@ -597,7 +597,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -628,7 +628,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -659,7 +659,7 @@ ___ #### Defined in -[lib/circuit_value.ts:120](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L120) +[lib/circuit_value.ts:137](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L137) ___ @@ -687,4 +687,4 @@ a JSON string #### Defined in -[lib/signature.ts:175](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/signature.ts#L175) +[lib/signature.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/signature.ts#L175) diff --git a/docs/zkapps/snarkyjs-reference/classes/UInt32.md b/docs/zkapps/snarkyjs-reference/classes/UInt32.md index d091380e2..6aa9d567d 100644 --- a/docs/zkapps/snarkyjs-reference/classes/UInt32.md +++ b/docs/zkapps/snarkyjs-reference/classes/UInt32.md @@ -89,7 +89,7 @@ A 32 bit unsigned integer with values ranging from 0 to 4,294,967,295. #### Defined in -[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) ## Properties @@ -99,7 +99,7 @@ A 32 bit unsigned integer with values ranging from 0 to 4,294,967,295. #### Defined in -[lib/int.ts:380](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L380) +[lib/int.ts:377](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L377) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -[lib/int.ts:381](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L381) +[lib/int.ts:378](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L378) ## Accessors @@ -125,7 +125,7 @@ Static method to create a [UInt32](UInt32.md) with value `0`. #### Defined in -[lib/int.ts:393](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L393) +[lib/int.ts:390](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L390) ___ @@ -141,7 +141,7 @@ Static method to create a [UInt32](UInt32.md) with value `0`. #### Defined in -[lib/int.ts:386](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L386) +[lib/int.ts:383](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L383) ## Methods @@ -163,7 +163,7 @@ Addition with overflow checking. #### Defined in -[lib/int.ts:532](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L532) +[lib/int.ts:529](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L529) ___ @@ -187,7 +187,7 @@ ___ #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -210,7 +210,7 @@ Asserts that a [UInt32](UInt32.md) is greater than another one. #### Defined in -[lib/int.ts:675](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L675) +[lib/int.ts:672](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L672) ___ @@ -233,7 +233,7 @@ Asserts that a [UInt32](UInt32.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:708](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L708) +[lib/int.ts:705](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L705) ___ @@ -260,7 +260,7 @@ Asserts that a [UInt32](UInt32.md) is greater than another one. #### Defined in -[lib/int.ts:668](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L668) +[lib/int.ts:665](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L665) ___ @@ -287,7 +287,7 @@ Asserts that a [UInt32](UInt32.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:701](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L701) +[lib/int.ts:698](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L698) ___ @@ -310,7 +310,7 @@ Asserts that a [UInt32](UInt32.md) is less than another one. #### Defined in -[lib/int.ts:643](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L643) +[lib/int.ts:640](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L640) ___ @@ -333,7 +333,7 @@ Asserts that a [UInt32](UInt32.md) is less than or equal to another one. #### Defined in -[lib/int.ts:601](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L601) +[lib/int.ts:598](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L598) ___ @@ -360,7 +360,7 @@ Asserts that a [UInt32](UInt32.md) is less than another one. #### Defined in -[lib/int.ts:636](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L636) +[lib/int.ts:633](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L633) ___ @@ -387,7 +387,7 @@ Asserts that a [UInt32](UInt32.md) is less than or equal to another one. #### Defined in -[lib/int.ts:594](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L594) +[lib/int.ts:591](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L591) ___ @@ -412,7 +412,7 @@ Integer division. #### Defined in -[lib/int.ts:509](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L509) +[lib/int.ts:506](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L506) ___ @@ -441,7 +441,7 @@ Integer division with remainder. #### Defined in -[lib/int.ts:467](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L467) +[lib/int.ts:464](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L464) ___ @@ -465,7 +465,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -487,7 +487,7 @@ Checks if a [UInt32](UInt32.md) is greater than another one. #### Defined in -[lib/int.ts:659](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L659) +[lib/int.ts:656](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L656) ___ @@ -509,7 +509,7 @@ Checks if a [UInt32](UInt32.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:691](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L691) +[lib/int.ts:688](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L688) ___ @@ -535,7 +535,7 @@ Checks if a [UInt32](UInt32.md) is greater than another one. #### Defined in -[lib/int.ts:652](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L652) +[lib/int.ts:649](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L649) ___ @@ -561,7 +561,7 @@ Checks if a [UInt32](UInt32.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:684](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L684) +[lib/int.ts:681](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L681) ___ @@ -579,7 +579,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -601,7 +601,7 @@ Checks if a [UInt32](UInt32.md) is less than another one. #### Defined in -[lib/int.ts:627](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L627) +[lib/int.ts:624](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L624) ___ @@ -623,7 +623,7 @@ Checks if a [UInt32](UInt32.md) is less than or equal to another one. #### Defined in -[lib/int.ts:571](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L571) +[lib/int.ts:568](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L568) ___ @@ -649,7 +649,7 @@ Checks if a [UInt32](UInt32.md) is less than another one. #### Defined in -[lib/int.ts:620](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L620) +[lib/int.ts:617](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L617) ___ @@ -675,7 +675,7 @@ Checks if a [UInt32](UInt32.md) is less than or equal to another one. #### Defined in -[lib/int.ts:550](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L550) +[lib/int.ts:547](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L547) ___ @@ -700,7 +700,7 @@ Integer remainder. #### Defined in -[lib/int.ts:518](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L518) +[lib/int.ts:515](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L515) ___ @@ -722,7 +722,7 @@ Multiplication with overflow checking. #### Defined in -[lib/int.ts:524](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L524) +[lib/int.ts:521](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L521) ___ @@ -744,7 +744,7 @@ Subtraction with underflow checking. #### Defined in -[lib/int.ts:540](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L540) +[lib/int.ts:537](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L537) ___ @@ -760,7 +760,7 @@ Turns the [UInt32](UInt32.md) into a BigInt. #### Defined in -[lib/int.ts:405](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L405) +[lib/int.ts:402](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L402) ___ @@ -778,7 +778,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -796,7 +796,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -814,7 +814,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -830,7 +830,7 @@ Turns the [UInt32](UInt32.md) into a string. #### Defined in -[lib/int.ts:399](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L399) +[lib/int.ts:396](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L396) ___ @@ -846,7 +846,7 @@ Turns the [UInt32](UInt32.md) into a [UInt64](UInt64.md). #### Defined in -[lib/int.ts:411](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L411) +[lib/int.ts:408](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L408) ___ @@ -862,7 +862,7 @@ Creates a [UInt32](UInt32.md) with a value of 4,294,967,295. #### Defined in -[lib/int.ts:459](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L459) +[lib/int.ts:456](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L456) ___ @@ -886,7 +886,7 @@ ___ #### Defined in -[lib/int.ts:416](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L416) +[lib/int.ts:413](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L413) ___ @@ -906,7 +906,7 @@ ___ #### Defined in -[lib/int.ts:437](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L437) +[lib/int.ts:434](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L434) ___ @@ -928,7 +928,7 @@ Creates a new [UInt32](UInt32.md). #### Defined in -[lib/int.ts:452](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L452) +[lib/int.ts:449](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L449) ___ @@ -959,7 +959,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -991,7 +991,7 @@ Decodes a JSON-like object into this structure. #### Defined in -[lib/int.ts:433](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L433) +[lib/int.ts:430](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L430) ___ @@ -1022,7 +1022,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -1040,7 +1040,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -1058,7 +1058,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -1089,7 +1089,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -1120,7 +1120,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -1144,7 +1144,7 @@ ___ #### Defined in -[lib/int.ts:420](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L420) +[lib/int.ts:417](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L417) ___ @@ -1170,4 +1170,4 @@ Encodes this structure into a JSON-like object. #### Defined in -[lib/int.ts:426](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L426) +[lib/int.ts:423](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L423) diff --git a/docs/zkapps/snarkyjs-reference/classes/UInt64.md b/docs/zkapps/snarkyjs-reference/classes/UInt64.md index 10e16e71c..e6b85420f 100644 --- a/docs/zkapps/snarkyjs-reference/classes/UInt64.md +++ b/docs/zkapps/snarkyjs-reference/classes/UInt64.md @@ -90,7 +90,7 @@ A 64 bit unsigned integer with values ranging from 0 to 18,446,744,073,709,551,6 #### Defined in -[lib/circuit_value.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L70) +[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L87) ## Properties @@ -100,7 +100,7 @@ A 64 bit unsigned integer with values ranging from 0 to 18,446,744,073,709,551,6 #### Defined in -[lib/int.ts:16](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L16) +[lib/int.ts:14](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L14) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[lib/int.ts:17](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L17) +[lib/int.ts:15](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L15) ## Accessors @@ -126,7 +126,7 @@ Static method to create a [UInt64](UInt64.md) with value `1`. #### Defined in -[lib/int.ts:28](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L28) +[lib/int.ts:26](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L26) ___ @@ -142,7 +142,7 @@ Static method to create a [UInt64](UInt64.md) with value `0`. #### Defined in -[lib/int.ts:22](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L22) +[lib/int.ts:20](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L20) ## Methods @@ -164,7 +164,7 @@ Addition with overflow checking. #### Defined in -[lib/int.ts:192](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L192) +[lib/int.ts:190](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L190) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[lib/circuit_value.ts:158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L158) +[lib/circuit_value.ts:175](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L175) ___ @@ -211,7 +211,7 @@ Asserts that a [UInt64](UInt64.md) is greater than another one. #### Defined in -[lib/int.ts:339](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L339) +[lib/int.ts:337](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L337) ___ @@ -234,7 +234,7 @@ Asserts that a [UInt64](UInt64.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:371](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L371) +[lib/int.ts:369](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L369) ___ @@ -261,7 +261,7 @@ Asserts that a [UInt64](UInt64.md) is greater than another one. #### Defined in -[lib/int.ts:332](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L332) +[lib/int.ts:330](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L330) ___ @@ -288,7 +288,7 @@ Asserts that a [UInt64](UInt64.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:364](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L364) +[lib/int.ts:362](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L362) ___ @@ -311,7 +311,7 @@ Asserts that a [UInt64](UInt64.md) is less than another one. #### Defined in -[lib/int.ts:307](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L307) +[lib/int.ts:305](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L305) ___ @@ -334,7 +334,7 @@ Asserts that a [UInt64](UInt64.md) is less than or equal to another one. #### Defined in -[lib/int.ts:263](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L263) +[lib/int.ts:261](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L261) ___ @@ -361,7 +361,7 @@ Asserts that a [UInt64](UInt64.md) is less than another one. #### Defined in -[lib/int.ts:300](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L300) +[lib/int.ts:298](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L298) ___ @@ -388,7 +388,7 @@ Asserts that a [UInt64](UInt64.md) is less than or equal to another one. #### Defined in -[lib/int.ts:256](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L256) +[lib/int.ts:254](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L254) ___ @@ -413,7 +413,7 @@ Integer division. #### Defined in -[lib/int.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L166) +[lib/int.ts:164](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L164) ___ @@ -442,7 +442,7 @@ Integer division with remainder. #### Defined in -[lib/int.ts:123](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L123) +[lib/int.ts:121](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L121) ___ @@ -466,7 +466,7 @@ ___ #### Defined in -[lib/circuit_value.ts:154](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L154) +[lib/circuit_value.ts:171](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L171) ___ @@ -488,7 +488,7 @@ Checks if a [UInt64](UInt64.md) is greater than another one. #### Defined in -[lib/int.ts:323](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L323) +[lib/int.ts:321](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L321) ___ @@ -510,7 +510,7 @@ Checks if a [UInt64](UInt64.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:355](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L355) +[lib/int.ts:353](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L353) ___ @@ -536,7 +536,7 @@ Checks if a [UInt64](UInt64.md) is greater than another one. #### Defined in -[lib/int.ts:316](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L316) +[lib/int.ts:314](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L314) ___ @@ -562,7 +562,7 @@ Checks if a [UInt64](UInt64.md) is greater than or equal to another one. #### Defined in -[lib/int.ts:348](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L348) +[lib/int.ts:346](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L346) ___ @@ -580,7 +580,7 @@ ___ #### Defined in -[lib/circuit_value.ts:162](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L162) +[lib/circuit_value.ts:179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L179) ___ @@ -602,7 +602,7 @@ Checks if a [UInt64](UInt64.md) is less than another one. #### Defined in -[lib/int.ts:290](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L290) +[lib/int.ts:288](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L288) ___ @@ -624,7 +624,7 @@ Checks if a [UInt64](UInt64.md) is less than or equal to another one. #### Defined in -[lib/int.ts:233](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L233) +[lib/int.ts:231](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L231) ___ @@ -650,7 +650,7 @@ Checks if a [UInt64](UInt64.md) is less than another one. #### Defined in -[lib/int.ts:282](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L282) +[lib/int.ts:280](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L280) ___ @@ -676,7 +676,7 @@ Checks if a [UInt64](UInt64.md) is less than or equal to another one. #### Defined in -[lib/int.ts:212](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L212) +[lib/int.ts:210](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L210) ___ @@ -701,7 +701,7 @@ Integer remainder. #### Defined in -[lib/int.ts:176](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L176) +[lib/int.ts:174](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L174) ___ @@ -723,7 +723,7 @@ Multiplication with overflow checking. #### Defined in -[lib/int.ts:183](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L183) +[lib/int.ts:181](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L181) ___ @@ -745,7 +745,7 @@ Subtraction with underflow checking. #### Defined in -[lib/int.ts:201](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L201) +[lib/int.ts:199](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L199) ___ @@ -761,7 +761,7 @@ Turns the [UInt64](UInt64.md) into a BigInt. #### Defined in -[lib/int.ts:42](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L42) +[lib/int.ts:40](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L40) ___ @@ -779,7 +779,7 @@ ___ #### Defined in -[lib/circuit_value.ts:150](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L150) +[lib/circuit_value.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L167) ___ @@ -797,7 +797,7 @@ ___ #### Defined in -[lib/circuit_value.ts:142](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L142) +[lib/circuit_value.ts:159](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L159) ___ @@ -815,7 +815,7 @@ ___ #### Defined in -[lib/circuit_value.ts:146](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L146) +[lib/circuit_value.ts:163](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L163) ___ @@ -831,7 +831,7 @@ Turns the [UInt64](UInt64.md) into a string. #### Defined in -[lib/int.ts:35](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L35) +[lib/int.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L33) ___ @@ -847,7 +847,7 @@ Turns the [UInt64](UInt64.md) into a [UInt32](UInt32.md), asserting that it fits #### Defined in -[lib/int.ts:49](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L49) +[lib/int.ts:47](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L47) ___ @@ -866,7 +866,7 @@ UInt64.from(4294967296).toUInt32Clamped().toString(); // "4294967295" #### Defined in -[lib/int.ts:61](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L61) +[lib/int.ts:59](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L59) ___ @@ -882,7 +882,7 @@ Creates a [UInt64](UInt64.md) with a value of 18,446,744,073,709,551,615. #### Defined in -[lib/int.ts:114](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L114) +[lib/int.ts:112](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L112) ___ @@ -906,7 +906,7 @@ ___ #### Defined in -[lib/int.ts:70](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L70) +[lib/int.ts:68](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L68) ___ @@ -926,7 +926,7 @@ ___ #### Defined in -[lib/int.ts:91](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L91) +[lib/int.ts:89](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L89) ___ @@ -948,7 +948,7 @@ Creates a new [UInt64](UInt64.md). #### Defined in -[lib/int.ts:106](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L106) +[lib/int.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L104) ___ @@ -979,7 +979,7 @@ ___ #### Defined in -[lib/circuit_value.ts:166](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L166) +[lib/circuit_value.ts:183](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L183) ___ @@ -1011,7 +1011,7 @@ Decodes a JSON-like object into this structure. #### Defined in -[lib/int.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L87) +[lib/int.ts:85](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L85) ___ @@ -1042,7 +1042,7 @@ ___ #### Defined in -[lib/circuit_value.ts:87](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L87) +[lib/circuit_value.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L104) ___ @@ -1060,7 +1060,7 @@ ___ #### Defined in -[lib/circuit_value.ts:94](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L94) +[lib/circuit_value.ts:111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L111) ___ @@ -1078,7 +1078,7 @@ ___ #### Defined in -[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L116) +[lib/circuit_value.ts:133](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L133) ___ @@ -1109,7 +1109,7 @@ ___ #### Defined in -[lib/circuit_value.ts:205](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L205) +[lib/circuit_value.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L222) ___ @@ -1140,7 +1140,7 @@ ___ #### Defined in -[lib/circuit_value.ts:99](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L99) +[lib/circuit_value.ts:116](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L116) ___ @@ -1164,7 +1164,7 @@ ___ #### Defined in -[lib/int.ts:74](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L74) +[lib/int.ts:72](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L72) ___ @@ -1190,4 +1190,4 @@ Encodes this structure into a JSON-like object. #### Defined in -[lib/int.ts:80](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/int.ts#L80) +[lib/int.ts:78](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/int.ts#L78) diff --git a/docs/zkapps/snarkyjs-reference/classes/VerificationKey.md b/docs/zkapps/snarkyjs-reference/classes/VerificationKey.md index 6d9610c33..085934c68 100644 --- a/docs/zkapps/snarkyjs-reference/classes/VerificationKey.md +++ b/docs/zkapps/snarkyjs-reference/classes/VerificationKey.md @@ -54,7 +54,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:365](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L365) +[lib/circuit_value.ts:467](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L467) ## Properties @@ -73,7 +73,7 @@ Struct({ #### Defined in -[lib/zkapp.ts:1481](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1481) +[lib/zkapp.ts:1487](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1487) ___ @@ -92,7 +92,7 @@ Struct({ #### Defined in -[lib/zkapp.ts:1481](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/zkapp.ts#L1481) +[lib/zkapp.ts:1487](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/zkapp.ts#L1487) ___ @@ -111,7 +111,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:365](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L365) +[lib/circuit_value.ts:467](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L467) ___ @@ -146,7 +146,7 @@ Struct({ #### Defined in -[snarky.d.ts:30](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L30) +[snarky.d.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L37) ___ @@ -185,7 +185,7 @@ Struct({ #### Defined in -[snarky.d.ts:28](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L28) +[snarky.d.ts:35](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L35) ___ @@ -223,7 +223,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:373](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L373) +[lib/circuit_value.ts:475](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L475) ___ @@ -258,7 +258,7 @@ Struct({ #### Defined in -[snarky.d.ts:27](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L27) +[snarky.d.ts:34](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L34) ___ @@ -293,7 +293,7 @@ Struct({ #### Defined in -[snarky.d.ts:26](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L26) +[snarky.d.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L33) ___ @@ -333,7 +333,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:368](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L368) +[lib/circuit_value.ts:470](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L470) ___ @@ -368,7 +368,7 @@ Struct({ #### Defined in -[lib/circuit_value.ts:372](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/circuit_value.ts#L372) +[lib/circuit_value.ts:474](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L474) ## Methods @@ -391,4 +391,4 @@ Struct({ #### Defined in -[snarky.d.ts:29](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L29) +[snarky.d.ts:36](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L36) diff --git a/docs/zkapps/snarkyjs-reference/interfaces/Mina.TransactionId.md b/docs/zkapps/snarkyjs-reference/interfaces/Mina.TransactionId.md index deaece53a..b9b320834 100644 --- a/docs/zkapps/snarkyjs-reference/interfaces/Mina.TransactionId.md +++ b/docs/zkapps/snarkyjs-reference/interfaces/Mina.TransactionId.md @@ -21,7 +21,7 @@ #### Defined in -[lib/mina.ts:63](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L63) +[lib/mina.ts:62](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L62) ## Methods @@ -35,7 +35,7 @@ #### Defined in -[lib/mina.ts:65](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L65) +[lib/mina.ts:64](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L64) ___ @@ -57,4 +57,4 @@ ___ #### Defined in -[lib/mina.ts:64](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L64) +[lib/mina.ts:63](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L63) diff --git a/docs/zkapps/snarkyjs-reference/interfaces/Permissions.md b/docs/zkapps/snarkyjs-reference/interfaces/Permissions.md index cde0a9695..e8b9f7b89 100644 --- a/docs/zkapps/snarkyjs-reference/interfaces/Permissions.md +++ b/docs/zkapps/snarkyjs-reference/interfaces/Permissions.md @@ -46,7 +46,7 @@ Permissions\_.access #### Defined in -[lib/account_update.ts:233](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L233) +[lib/account_update.ts:233](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L233) ___ @@ -62,7 +62,7 @@ Permissions\_.editActionState #### Defined in -[lib/account_update.ts:212](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L212) +[lib/account_update.ts:212](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L212) ___ @@ -79,7 +79,7 @@ Permissions\_.editState #### Defined in -[lib/account_update.ts:168](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L168) +[lib/account_update.ts:168](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L168) ___ @@ -93,7 +93,7 @@ Permissions\_.incrementNonce #### Defined in -[lib/account_update.ts:221](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L221) +[lib/account_update.ts:221](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L221) ___ @@ -110,7 +110,7 @@ Permissions\_.receive #### Defined in -[lib/account_update.ts:180](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L180) +[lib/account_update.ts:180](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L180) ___ @@ -127,7 +127,7 @@ Permissions\_.send #### Defined in -[lib/account_update.ts:174](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L174) +[lib/account_update.ts:174](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L174) ___ @@ -144,7 +144,7 @@ Permissions\_.setDelegate #### Defined in -[lib/account_update.ts:186](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L186) +[lib/account_update.ts:186](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L186) ___ @@ -161,7 +161,7 @@ Permissions\_.setPermissions #### Defined in -[lib/account_update.ts:192](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L192) +[lib/account_update.ts:192](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L192) ___ @@ -175,7 +175,7 @@ Permissions\_.setTiming #### Defined in -[lib/account_update.ts:223](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L223) +[lib/account_update.ts:223](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L223) ___ @@ -192,7 +192,7 @@ Permissions\_.setTokenSymbol #### Defined in -[lib/account_update.ts:218](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L218) +[lib/account_update.ts:218](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L218) ___ @@ -210,7 +210,7 @@ Permissions\_.setVerificationKey #### Defined in -[lib/account_update.ts:199](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L199) +[lib/account_update.ts:199](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L199) ___ @@ -224,7 +224,7 @@ Permissions\_.setVotingFor #### Defined in -[lib/account_update.ts:222](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L222) +[lib/account_update.ts:222](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L222) ___ @@ -243,4 +243,4 @@ Permissions\_.setZkappUri #### Defined in -[lib/account_update.ts:207](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L207) +[lib/account_update.ts:207](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L207) diff --git a/docs/zkapps/snarkyjs-reference/interfaces/Provable.md b/docs/zkapps/snarkyjs-reference/interfaces/Provable.md new file mode 100644 index 000000000..584bd2140 --- /dev/null +++ b/docs/zkapps/snarkyjs-reference/interfaces/Provable.md @@ -0,0 +1,141 @@ +# Interface: Provable + +`Provable` is the general circuit type interface. It describes how a type `T` is made up of field elements and auxiliary (non-field element) data. + +You will find this as the required input type in a few places in snarkyjs. One convenient way to create a `Provable` is using `Struct`. + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Hierarchy + +- **`Provable`** + + ↳ [`ProvablePure`](ProvablePure.md) + +## Table of contents + +### Properties + +- [check](Provable.md#check) +- [fromFields](Provable.md#fromfields) +- [toAuxiliary](Provable.md#toauxiliary) +- [toFields](Provable.md#tofields) + +### Methods + +- [sizeInFields](Provable.md#sizeinfields) + +## Properties + +### check + +• **check**: (`x`: `T`) => `void` + +#### Type declaration + +▸ (`x`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `x` | `T` | + +##### Returns + +`void` + +#### Defined in + +[snarky.d.ts:37](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L37) + +___ + +### fromFields + +• **fromFields**: (`x`: [`Field`](../classes/Field.md)[], `aux`: `any`[]) => `T` + +#### Type declaration + +▸ (`x`, `aux`): `T` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `x` | [`Field`](../classes/Field.md)[] | +| `aux` | `any`[] | + +##### Returns + +`T` + +#### Defined in + +[snarky.d.ts:35](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L35) + +___ + +### toAuxiliary + +• **toAuxiliary**: (`x?`: `T`) => `any`[] + +#### Type declaration + +▸ (`x?`): `any`[] + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `x?` | `T` | + +##### Returns + +`any`[] + +#### Defined in + +[snarky.d.ts:34](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L34) + +___ + +### toFields + +• **toFields**: (`x`: `T`) => [`Field`](../classes/Field.md)[] + +#### Type declaration + +▸ (`x`): [`Field`](../classes/Field.md)[] + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `x` | `T` | + +##### Returns + +[`Field`](../classes/Field.md)[] + +#### Defined in + +[snarky.d.ts:33](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L33) + +## Methods + +### sizeInFields + +▸ **sizeInFields**(): `number` + +#### Returns + +`number` + +#### Defined in + +[snarky.d.ts:36](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L36) diff --git a/docs/zkapps/snarkyjs-reference/interfaces/ProvablePure.md b/docs/zkapps/snarkyjs-reference/interfaces/ProvablePure.md index d6740033b..770578847 100644 --- a/docs/zkapps/snarkyjs-reference/interfaces/ProvablePure.md +++ b/docs/zkapps/snarkyjs-reference/interfaces/ProvablePure.md @@ -13,7 +13,7 @@ Examples where `ProvablePure` is required are types of on-chain state, events ## Hierarchy -- `Provable`<`T`\> +- [`Provable`](Provable.md)<`T`\> ↳ **`ProvablePure`** @@ -52,11 +52,11 @@ Examples where `ProvablePure` is required are types of on-chain state, events #### Overrides -Provable.check +[Provable](Provable.md).[check](Provable.md#check) #### Defined in -[snarky.d.ts:43](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L43) +[snarky.d.ts:50](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L50) ___ @@ -80,11 +80,11 @@ ___ #### Overrides -Provable.fromFields +[Provable](Provable.md).[fromFields](Provable.md#fromfields) #### Defined in -[snarky.d.ts:41](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L41) +[snarky.d.ts:48](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L48) ___ @@ -108,11 +108,11 @@ ___ #### Overrides -Provable.toAuxiliary +[Provable](Provable.md).[toAuxiliary](Provable.md#toauxiliary) #### Defined in -[snarky.d.ts:40](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L40) +[snarky.d.ts:47](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L47) ___ @@ -136,11 +136,11 @@ ___ #### Overrides -Provable.toFields +[Provable](Provable.md).[toFields](Provable.md#tofields) #### Defined in -[snarky.d.ts:39](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L39) +[snarky.d.ts:46](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L46) ## Methods @@ -154,8 +154,8 @@ Provable.toFields #### Overrides -Provable.sizeInFields +[Provable](Provable.md).[sizeInFields](Provable.md#sizeinfields) #### Defined in -[snarky.d.ts:42](https://github.com/o1-labs/snarkyjs/blob/8374557/src/snarky.d.ts#L42) +[snarky.d.ts:49](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/snarky.d.ts#L49) diff --git a/docs/zkapps/snarkyjs-reference/modules/Encryption.md b/docs/zkapps/snarkyjs-reference/modules/Encryption.md index ab5476356..caefd186d 100644 --- a/docs/zkapps/snarkyjs-reference/modules/Encryption.md +++ b/docs/zkapps/snarkyjs-reference/modules/Encryption.md @@ -28,7 +28,7 @@ Decrypts a CipherText using a [PrivateKey](../classes/PrivateKey.md).^ #### Defined in -[lib/encryption.ts:45](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/encryption.ts#L45) +[lib/encryption.ts:44](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/encryption.ts#L44) ___ @@ -56,4 +56,4 @@ Public Key Encryption, using a given array of [Field](../classes/Field.md) eleme #### Defined in -[lib/encryption.ts:16](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/encryption.ts#L16) +[lib/encryption.ts:15](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/encryption.ts#L15) diff --git a/docs/zkapps/snarkyjs-reference/modules/Experimental.md b/docs/zkapps/snarkyjs-reference/modules/Experimental.md index 47c79d844..5351cdce0 100644 --- a/docs/zkapps/snarkyjs-reference/modules/Experimental.md +++ b/docs/zkapps/snarkyjs-reference/modules/Experimental.md @@ -33,9 +33,9 @@ This module exposes APIs that are unstable, in the sense that the API surface is #### Defined in -[index.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/index.ts#L96) +[index.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/index.ts#L96) -[index.ts:97](https://github.com/o1-labs/snarkyjs/blob/8374557/src/index.ts#L97) +[index.ts:97](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/index.ts#L97) ## Variables @@ -45,9 +45,9 @@ This module exposes APIs that are unstable, in the sense that the API surface is #### Defined in -[index.ts:96](https://github.com/o1-labs/snarkyjs/blob/8374557/src/index.ts#L96) +[index.ts:96](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/index.ts#L96) -[index.ts:97](https://github.com/o1-labs/snarkyjs/blob/8374557/src/index.ts#L97) +[index.ts:97](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/index.ts#L97) ## Functions @@ -74,7 +74,7 @@ This module exposes APIs that are unstable, in the sense that the API surface is #### Defined in -[lib/proof_system.ts:198](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/proof_system.ts#L198) +[lib/proof_system.ts:205](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/proof_system.ts#L205) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[lib/account_update.ts:1709](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/account_update.ts#L1709) +[lib/account_update.ts:1704](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/account_update.ts#L1704) ___ @@ -104,7 +104,7 @@ ___ ▸ **memoizeWitness**<`T`\>(`type`, `compute`): `T` -Like Provable.witness, but memoizes the witness during transaction construction +Like Circuit.witness, but memoizes the witness during transaction construction for reuse by the prover. This is needed to witness non-deterministic values. #### Type parameters @@ -126,4 +126,4 @@ for reuse by the prover. This is needed to witness non-deterministic values. #### Defined in -[lib/provable.ts:491](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/provable.ts#L491) +[lib/circuit_value.ts:856](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/circuit_value.ts#L856) diff --git a/docs/zkapps/snarkyjs-reference/modules/Mina.md b/docs/zkapps/snarkyjs-reference/modules/Mina.md index 431539db1..a27cd22da 100644 --- a/docs/zkapps/snarkyjs-reference/modules/Mina.md +++ b/docs/zkapps/snarkyjs-reference/modules/Mina.md @@ -58,7 +58,7 @@ #### Defined in -[lib/mina.ts:155](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L155) +[lib/mina.ts:154](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L154) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[lib/mina.ts:113](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L113) +[lib/mina.ts:112](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L112) ___ @@ -90,7 +90,7 @@ Allows you to specify information about the fee payer account and the transactio #### Defined in -[lib/mina.ts:126](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L126) +[lib/mina.ts:125](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L125) ___ @@ -112,9 +112,9 @@ ___ #### Defined in -[lib/mina.ts:68](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L68) +[lib/mina.ts:67](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L67) -[lib/mina.ts:105](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L105) +[lib/mina.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L104) ## Variables @@ -130,9 +130,9 @@ ___ #### Defined in -[lib/mina.ts:68](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L68) +[lib/mina.ts:67](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L67) -[lib/mina.ts:105](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L105) +[lib/mina.ts:104](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L104) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[lib/mina.ts:963](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L963) +[lib/mina.ts:949](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L949) ## Functions @@ -167,7 +167,7 @@ The name `BerkeleyQANet` was misleading because it suggested that this is specif #### Defined in -[lib/mina.ts:959](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L959) +[lib/mina.ts:945](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L945) ___ @@ -215,7 +215,7 @@ A mock Mina blockchain running locally and useful for testing. #### Defined in -[lib/mina.ts:379](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L379) +[lib/mina.ts:365](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L365) ___ @@ -237,7 +237,7 @@ Represents the Mina blockchain running on a real network #### Defined in -[lib/mina.ts:664](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L664) +[lib/mina.ts:650](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L650) ▸ **Network**(`graphqlEndpoints`): `Mina` @@ -255,7 +255,7 @@ Represents the Mina blockchain running on a real network #### Defined in -[lib/mina.ts:665](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L665) +[lib/mina.ts:651](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L651) ___ @@ -271,7 +271,7 @@ Returns the default account creation fee. #### Defined in -[lib/mina.ts:1165](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1165) +[lib/mina.ts:1146](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1146) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -[lib/mina.ts:168](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L168) +[lib/mina.ts:167](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L167) ___ @@ -313,7 +313,7 @@ The current slot number, according to the active Mina instance. #### Defined in -[lib/mina.ts:1130](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1130) +[lib/mina.ts:1111](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1111) ___ @@ -327,7 +327,7 @@ ___ #### Defined in -[lib/global-context.ts:6](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/global-context.ts#L6) +[lib/global-context.ts:6](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/global-context.ts#L6) ___ @@ -350,7 +350,7 @@ Requests the [testnet faucet](https://faucet.minaprotocol.com/api/v1/faucet) to #### Defined in -[lib/mina.ts:1544](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1544) +[lib/mina.ts:1525](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1525) ___ @@ -374,7 +374,7 @@ A list of emitted sequencing actions associated to the given public key. #### Defined in -[lib/mina.ts:1187](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1187) +[lib/mina.ts:1168](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1168) ___ @@ -398,7 +398,7 @@ A list of emitted events associated to the given public key. #### Defined in -[lib/mina.ts:1176](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1176) +[lib/mina.ts:1157](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1157) ___ @@ -424,7 +424,7 @@ ___ #### Defined in -[lib/mina.ts:1501](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1501) +[lib/mina.ts:1482](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1482) ___ @@ -447,7 +447,7 @@ The account data associated to the given public key. #### Defined in -[lib/mina.ts:1137](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1137) +[lib/mina.ts:1118](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1118) ___ @@ -471,7 +471,7 @@ A list of emitted sequencing actions associated to the given public key. #### Defined in -[lib/mina.ts:1198](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1198) +[lib/mina.ts:1179](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1179) ___ @@ -494,7 +494,7 @@ The balance associated to the given public key. #### Defined in -[lib/mina.ts:1158](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1158) +[lib/mina.ts:1139](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1139) ___ @@ -510,7 +510,7 @@ Data associated with the current state of the Mina network. #### Defined in -[lib/mina.ts:1151](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1151) +[lib/mina.ts:1132](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1132) ___ @@ -524,7 +524,7 @@ ___ #### Defined in -[lib/mina.ts:1206](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1206) +[lib/mina.ts:1187](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1187) ___ @@ -547,7 +547,7 @@ Checks if an account exists within the ledger. #### Defined in -[lib/mina.ts:1144](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1144) +[lib/mina.ts:1125](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1125) ___ @@ -567,7 +567,7 @@ ___ #### Defined in -[lib/mina.ts:1169](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1169) +[lib/mina.ts:1150](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1150) ___ @@ -585,7 +585,7 @@ Throws an error if not inside a transaction, or the sender wasn't passed in. #### Defined in -[lib/mina.ts:1106](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1106) +[lib/mina.ts:1087](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1087) ___ @@ -607,7 +607,7 @@ Set the currently used Mina instance. #### Defined in -[lib/mina.ts:1045](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1045) +[lib/mina.ts:1031](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1031) ___ @@ -640,7 +640,7 @@ A transaction that can subsequently be submitted to the chain. #### Defined in -[lib/mina.ts:1062](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1062) +[lib/mina.ts:1048](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1048) ▸ **transaction**(`f`): `Promise`<[`Transaction`](Mina.md#transaction-1)\> @@ -656,7 +656,7 @@ A transaction that can subsequently be submitted to the chain. #### Defined in -[lib/mina.ts:1063](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1063) +[lib/mina.ts:1049](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1049) ▸ **transaction**(`sender`, `f`): `Promise`<[`Transaction`](Mina.md#transaction-1)\> @@ -686,7 +686,7 @@ Mina.transaction({ feePayerKey: privateKey }, ...); #### Defined in -[lib/mina.ts:1076](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1076) +[lib/mina.ts:1062](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1062) ___ @@ -706,4 +706,4 @@ ___ #### Defined in -[lib/mina.ts:1520](https://github.com/o1-labs/snarkyjs/blob/8374557/src/lib/mina.ts#L1520) +[lib/mina.ts:1501](https://github.com/o1-labs/snarkyjs/blob/dcf69e2/src/lib/mina.ts#L1501) diff --git a/sidebars.js b/sidebars.js index 1d6c0fa97..dffc29b03 100644 --- a/sidebars.js +++ b/sidebars.js @@ -235,6 +235,11 @@ module.exports = { id: 'zkapps/snarkyjs-reference/interfaces/Permissions', label: 'Permissions', }, + { + type: 'doc', + id: 'zkapps/snarkyjs-reference/interfaces/Provable', + label: 'Provable', + }, { type: 'doc', id: 'zkapps/snarkyjs-reference/interfaces/ProvablePure', From 8b65a6c4964ab46b9130fd208cc6da617996ec8d Mon Sep 17 00:00:00 2001 From: barriebyron Date: Mon, 22 May 2023 14:05:30 -0400 Subject: [PATCH 4/6] editorial grooming for the Provable updates and then some more grooming --- docs/zkapps/how-to-write-a-zkapp.mdx | 88 ++++++++++++++-------------- 1 file changed, 43 insertions(+), 45 deletions(-) diff --git a/docs/zkapps/how-to-write-a-zkapp.mdx b/docs/zkapps/how-to-write-a-zkapp.mdx index 30380d66b..a173eea5c 100644 --- a/docs/zkapps/how-to-write-a-zkapp.mdx +++ b/docs/zkapps/how-to-write-a-zkapp.mdx @@ -82,13 +82,13 @@ You can view a list of :::info -Under the hood, every `@method` defines a zk-SNARK circuit. From the cryptography standpoint, a smart contract is a collection of circuits, all of which are compiled into a single prover & verification key. The proof says something to the effect of "I ran one of these methods, with some private input, and it produced this particular set of account updates". In ZKP terms, the account updates are the _public input_. The proof will only be accepted on the network if it verifies against the verification key stored in the account. This ensures that indeed, the same code that the zkApp developer wrote also ran on the user's device – thus, the account updates conform to the smart contract's rules. +Under the hood, every `@method` defines a zk-SNARK circuit. From the cryptography standpoint, a smart contract is a collection of circuits, all of which are compiled into a single prover & verification key. The proof says something to the effect of "I ran one of these methods, with some private input, and it produced this particular set of account updates". In ZKP terms, the account updates are the _public input_. The proof is only accepted on the network if it verifies against the verification key that is stored in the account. This ensures that indeed, the same code that the zkApp developer wrote also ran on the user's device so that the account updates conform to the smart contract's rules. ::: @@ -281,27 +280,27 @@ Under the hood, every `@method` defines a zk-SNARK circuit. From the cryptograph :::tip -You will find that inside a `@method`, things sometimes behave a little differently. For example, the following code can't be used in a method where `x: Field` is an input parameter: +Inside a `@method`, things sometimes behave a little differently. For example, the following code can't be used in a method where `x: Field` is an input parameter: ```ts console.log(x.toString()); // don't do this inside a `@method`! 😬 ``` -This doesn't work because, when we compile the SmartContract into prover and verification keys, we will run your method in an environment where the method inputs don't have any concrete values attached to them. They are like mathematical variables `x`, `y`, `z` which are used to build up abstract computations like `x^2 + y^2`, just by running your method code. +This doesn't work because, when we compile the SmartContract into prover and verification keys, your method runs in an environment where the method inputs don't have any concrete values attached to them. They are like mathematical variables `x`, `y`, `z` that are used to build up abstract computations, like `x^2 + y^2`, just by running your method code. -Therefore, when executing your code and trying to read the value of `x` to turn it into a string via `x.toString()`, it will blow up because such a value can't be found. On the other hand, during proof generation all the variables _have_ actual values attached to them (cryptographers call them "witnesses"); and it makes perfect sense to want to log these values for debugging. -This is why we have a special function for logging stuff from inside your method: +Therefore, when executing your code and trying to read the value of `x` to turn it into a string via `x.toString()`, the execution fails because the value can't be found. In contrast, during proof generation all the variables _have_ actual values attached to them (cryptographers call them "witnesses"). It makes perfect sense to want to log these values for debugging. +This is why a special function is available to log stuff from inside your method: ```ts Provable.log(x); ``` -The API is like that of `console.log`, but it will automatically handle printing SnarkyJS data types in a nice format. During SmartContract compilation, it will simply do nothing. +The API is like that of `console.log`, but it automatically handles printing SnarkyJS data types in a nice format. During SmartContract compilation, it simply does nothing. ::: ##### On-chain state -A smart contract can contain **on-chain state**, which is declared as a property +A smart contract can contain **on-chain state** that is declared as a property on the class with the `@state` decorator: ```ts @@ -333,7 +332,7 @@ As a zkApp developer, if you add this method to your smart contract, you are say ##### Reading state -Often, we also want to _read_ state – check out this example: +Often, you also want to _read_ state as shown in this example: ```ts class HelloWorld extends SmartContract { @@ -351,27 +350,26 @@ class HelloWorld extends SmartContract { ``` The `increment()` method fetches the current on-chain state `x` with `this.x.get()`. -Later, it sets the new state to `x + 1` using `this.x.set()`. Simple! +Later, it sets the new state to `x + 1` using `this.x.set()`. -There's another line though, which looks weird at first: +There's another line that looks weird at first: ```ts this.x.assertEquals(x); ``` -To understand it, we have to take a step back, and understand what it means to "use an on-chain value" during off-chain execution. +To understand it, take a step back and understand what it means to "use an on-chain value" during off-chain execution. -For sure, when we use an on-chain value, we have to _prove_ that this is the on-chain value. Verification has to fail if it's a different value! Otherwise, a malicious user could modify SnarkyJS and make it just use any other value than the current on-chain state – breaking our zkApp. +To use an on-chain value, you have to _prove_ that this is the on-chain value. Verification has to fail if it's a different value! Otherwise, a malicious user could modify SnarkyJS and make it just use any other value than the current on-chain state – breaking the zkApp. -To prevent that, we link "`x` at proving time" to be the same as "`x` at verification time". We call this a _precondition_ – a condition that is checked by the verifier (a Mina node) when it receives the proof in a transaction. This is what `this.x.assertEquals(x)` does: it adds the precondition that `this.x` – the on-chain state at verification time – has to equal `x` – the value we fetched from the chain on the client-side. In zkSNARK language, `x` becomes part of the public input. +To prevent that security vulnerability, link "`x` at proving time" to be the same as "`x` at verification time". This is called a _precondition_ that is checked by the verifier (a Mina node) when it receives the proof in a transaction. This check is what `this.x.assertEquals(x)` does: it adds the precondition that `this.x`, the on-chain state at verification time, has to equal `x` that is the value fetched from the chain on the client-side. In zkSNARK language, `x` becomes part of the public input. Side note: `this..assertEquals` is more flexible than equating with the current value. For example, `this.x.assertEquals(10)` fixes the on-chain `x` to the number `10`. :::note -Why didn't we just make `this.x.get()` add the precondition, automatically, so that you didn't have to write `this.x.assertEquals(x)`? -Well, we like to keep things explicit. The assertion reminds us that we add logic which can make the proof fail: If `x` isn't the same at verification time, the transaction will be rejected. So, reading on-chain values has to be done with care if many users are supposed to read and update state concurrently. It is applicable in some situations, but might cause races, and call for workarounds, in other situations. -One such workaround is the use of actions – see [Actions and Reducer](advanced-snarkyjs/actions-and-reducer). +Why can't you just make `this.x.get()` add the precondition automatically, so that you didn't have to write `this.x.assertEquals(x)`? To keep things explicit, the assertion adds logic that can make the proof fail: If `x` isn't the same at verification time, the transaction will be rejected. So, reading on-chain values has to be done with care if many users are supposed to read and update state concurrently. It is applicable in some situations, but in other situations, it might cause races and calls for workarounds. +One such workaround is the use of actions, see [Actions and Reducer](advanced-snarkyjs/actions-and-reducer). ::: @@ -379,7 +377,7 @@ One such workaround is the use of actions – see [Actions and Reducer](advanced -Let's modify the `increment()` method to accept a parameter: +To modify the `increment()` method to accept a parameter: ```ts class HelloWorld extends SmartContract { @@ -396,20 +394,20 @@ class HelloWorld extends SmartContract { } ``` -Here, after obtaining the current state `x` and asserting that it equals the on-chain value, we make another assertion: +Here, after obtaining the current state `x` and asserting that it equals the on-chain value, make another assertion: ```ts x.add(1).assertEquals(xPlus1); ``` -If the assertion fails, SnarkyJS will throw an error and not submit the transaction. -On the other hand, if it succeeds, it becomes part of the proof that is verified on-chain. +- If the assertion fails, SnarkyJS throws an error and does not submit the transaction. +- If the assertion succeeds, it becomes part of the proof that is verified on-chain. -Because of this, our new version of `increment()` is _guaranteed_ to behave like the previous version: It can only ever +Because of this, the new version of `increment()` is _guaranteed_ to behave like the previous version: It can only ever update the state `x` to `x + 1`. :::tip -You can add optional failure messages to assertions, to make debugging easier. For example, the above example could be written as: +You can add optional failure messages to assertions to make debugging easier. For example, the previous example could be written as: ```ts x.add(1).assertEquals(xPlus1, 'x + 1 should equal xPlus1'); @@ -417,7 +415,7 @@ x.add(1).assertEquals(xPlus1, 'x + 1 should equal xPlus1'); ::: -Assertions can be incredibly useful to constrain state updates. Common assertions you may use are: +Assertions can be incredibly useful to constrain state updates. Common assertions you can use are: ```ts @@ -437,7 +435,7 @@ While the state of a zkApp is **public**, method parameters are **private**. When a smart contract method is called, the proof it produces uses zero-knowledge to hide inputs and details of the computation. -The only way method parameters can be exposed is when the computation explicitly exposes them, as +The only way method parameters can be exposed is when the computation explicitly exposes them, like in the last example where the input was directly stored in the public state: `this.x.set(xPlus1);` For example where this is not the case, define a new method called `incrementSecret()`: @@ -513,7 +511,7 @@ The `myMethod()` proof: - Computes an appropriate hash of the function signature of `otherMethod()` plus any arguments and return values of that function call. - Guarantees that this hash matches the `callData` field on the account update produced by `otherMethod()` that is made part of `myMethod()`'s public input. -Therefore, when you calling another zkApp method, you effectively prove: "I called a method with this name, on this zkApp account, with this particular arguments and return value." +Therefore, when you call another zkApp method, you effectively prove: "I called a method with this name, on this zkApp account, with this particular arguments and return value." To ensure other methods can use a return value of your `@method`, you must annotate the return value in your TypeScript function signature. @@ -545,7 +543,7 @@ class Point extends Struct({ }) {} ``` -Now that you have defined your Struct, you can use it in your smart contract for any SnarkyJS built-in types. +Now that you have defined your `Struct`, you can use it in your smart contract for any SnarkyJS built-in types. For example, the following smart contract uses the `Point` Struct defined above as state and as a method argument: @@ -569,12 +567,12 @@ export class Grid extends SmartContract { } ``` -Note that your Structs can contain SnarkyJS built-in types like `Field`, `Bool`, `UInt64`, etc or even other custom types that you've defined which are based on the `Struct` class. +Note that Structs can contain SnarkyJS built-in types like `Field`, `Bool`, `UInt64`, and so on, or even other custom types that you've defined that are based on the `Struct` class. This allows for great composability and reusability of structs. ##### Transactions and account updates -Now that you have an idea about writing zkApp methods, it's time to learn how users can call these methods. Recall that smart contracts execute off-chain. The result of such an off-chain execution is a _transaction_, which can be sent to the Mina network to apply the changes made by the smart contract. In this section, you learn what a transaction looks like, and how you can create one. +Now that you know about writing zkApp methods, it's time to learn how users can call these methods. Recall that smart contracts execute off-chain. The result of such an off-chain execution is a _transaction_ that can be sent to the Mina network to apply the changes made by the smart contract. In this section, you learn what a transaction looks like and how you can create one. The fundamental data structure that Mina transactions are built from is called an _account update_. An account update always contains updates to one specific on-chain account. For example, if you transfer MINA from one account to another, the balance on two accounts is updated – the sender and the receiver. Therefore, sending MINA requires two account updates. Account updates are a flexible and powerful data structure that can express all kinds of updates, events and preconditions that you use for developing smart contracts. From ec0f63d53d898e973c7ec822d01e6d95e58f8b7b Mon Sep 17 00:00:00 2001 From: Florian Date: Thu, 8 Jun 2023 10:28:38 +0200 Subject: [PATCH 5/6] rename --- docs/zkapps/snarkyjs/smart-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zkapps/snarkyjs/smart-contracts.md b/docs/zkapps/snarkyjs/smart-contracts.md index bd7493cb9..a5ef7d2a9 100644 --- a/docs/zkapps/snarkyjs/smart-contracts.md +++ b/docs/zkapps/snarkyjs/smart-contracts.md @@ -112,7 +112,7 @@ Therefore, when executing your code and trying to read the value of `x` to turn This is why we have a special function for logging stuff from inside your method: ```ts -Circuit.log(x); +Provable.log(x); ``` The API is like that of `console.log`, but it will automatically handle printing SnarkyJS data types in a nice format. During SmartContract compilation, it will simply do nothing. From e8bff9404a511767d7da9744bd22ba604b4c2001 Mon Sep 17 00:00:00 2001 From: Florian Date: Wed, 12 Jul 2023 19:10:42 +0200 Subject: [PATCH 6/6] fix deployment issue --- docs/zkapps/tutorials/05-common-types-and-functions.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/zkapps/tutorials/05-common-types-and-functions.mdx b/docs/zkapps/tutorials/05-common-types-and-functions.mdx index dda1dbb7b..e3714ae79 100644 --- a/docs/zkapps/tutorials/05-common-types-and-functions.mdx +++ b/docs/zkapps/tutorials/05-common-types-and-functions.mdx @@ -194,8 +194,8 @@ points8 Fields: {"points":[{"x":"0","y":"0"},{"x":"1","y":"10"},{"x":"2","y":"20 There are two functions which help do control flow within SnarkyJS: -- [Provable.if](../snarkyjs-reference/classes/Provable#if) -- [Provable.switch](../snarkyjs-reference/classes/Provable#switch) +- [Provable.if](../snarkyjs-reference/classes/Circuit#if) +- [Provable.switch](../snarkyjs-reference/classes/Circuit#switch) `Provable.if` is similar to a ternary in JavaScript. `Provable.switch` is similar to a switch case statement in JavaScript. @@ -209,7 +209,7 @@ const input2 = Int64.from(-15); const inputSum = input1.add(input2); -const inputSumAbs = CiProvablercuit.if( +const inputSumAbs = Provable.if( inputSum.isPositive(), inputSum, inputSum.mul(Int64.minusOne)