diff --git a/docs/zkapps/o1js-reference/README.mdx b/docs/zkapps/o1js-reference/README.mdx index ee40df7e5..bd78c4437 100644 --- a/docs/zkapps/o1js-reference/README.mdx +++ b/docs/zkapps/o1js-reference/README.mdx @@ -86,8 +86,10 @@ To include your package, see [Creating high-quality community packages](https:// | [CircuitString](classes/CircuitString.mdx) | - | | [DynamicProof](classes/DynamicProof.mdx) | The `DynamicProof` class enables circuits to verify proofs using in-ciruit verfication keys. | | [EcdsaSignature](classes/EcdsaSignature.mdx) | - | +| [EcdsaSignatureV2](classes/EcdsaSignatureV2.mdx) | - | | [Field](classes/Field.mdx) | A [Field](classes/Field.mdx) is an element of a prime order [finite field](https://en.wikipedia.org/wiki/Finite_field). | | [ForeignCurve](classes/ForeignCurve.mdx) | - | +| [ForeignCurveV2](classes/ForeignCurveV2.mdx) | - | | [ForeignField](classes/ForeignField.mdx) | - | | [Group](classes/Group.mdx) | An element of a Group. | | [Hashed](classes/Hashed.mdx) | `Hashed` represents a type `T` by its hash. | @@ -128,6 +130,7 @@ To include your package, see [Creating high-quality community packages](https:// | [ConstantField](type-aliases/ConstantField.mdx) | - | | [DeployArgs](type-aliases/DeployArgs.mdx) | - | | [Empty](type-aliases/Empty.mdx) | - | +| [FeatureFlags](type-aliases/FeatureFlags.mdx) | - | | [Field](type-aliases/Field.mdx) | - | | [FlexibleProvable](type-aliases/FlexibleProvable.mdx) | - | | [FlexibleProvablePure](type-aliases/FlexibleProvablePure.mdx) | - | @@ -159,6 +162,7 @@ To include your package, see [Creating high-quality community packages](https:// | [Cache](variables/Cache.mdx) | - | | [Crypto](variables/Crypto.mdx) | - | | [Empty](variables/Empty.mdx) | - | +| [FeatureFlags](variables/FeatureFlags.mdx) | Feature flags indicate what custom gates are used in a proof of circuit. | | [Field](variables/Field.mdx) | A [Field](variables/Field.mdx) is an element of a prime order [finite field](https://en.wikipedia.org/wiki/Finite_field). | | [Gadgets](variables/Gadgets.mdx) | - | | [Group](variables/Group.mdx) | An element of a Group. | @@ -188,8 +192,11 @@ To include your package, see [Creating high-quality community packages](https:// | [checkBitLength](functions/checkBitLength.mdx) | - | | [checkZkappTransaction](functions/checkZkappTransaction.mdx) | - | | [circuitMain](functions/circuitMain.mdx) | - | -| [createEcdsa](functions/createEcdsa.mdx) | Create a class [EcdsaSignature](classes/EcdsaSignature.mdx) for verifying ECDSA signatures on the given curve. | -| [createForeignCurve](functions/createForeignCurve.mdx) | Create a class representing an elliptic curve group, which is different from the native [Group](classes/Group.mdx). | +| [conditionalSwap](functions/conditionalSwap.mdx) | - | +| [createEcdsa](functions/createEcdsa.mdx) | - | +| [createEcdsaV2](functions/createEcdsaV2.mdx) | Create a class [EcdsaSignatureV2](classes/EcdsaSignatureV2.mdx) for verifying ECDSA signatures on the given curve. | +| [createForeignCurve](functions/createForeignCurve.mdx) | - | +| [createForeignCurveV2](functions/createForeignCurveV2.mdx) | Create a class representing an elliptic curve group, which is different from the native [Group](classes/Group.mdx). | | [createForeignField](functions/createForeignField.mdx) | Create a class representing a prime order finite field, which is different from the native [Field](classes/Field.mdx). | | [declareMethods](functions/declareMethods.mdx) | `declareMethods` can be used in place of the `@method` decorator | | [declareState](functions/declareState.mdx) | `declareState` can be used in place of the `@state` decorator to declare on-chain state on a SmartContract. | @@ -199,7 +206,6 @@ To include your package, see [Creating high-quality community packages](https:// | [fetchTransactionStatus](functions/fetchTransactionStatus.mdx) | Fetches the status of a transaction. | | [genericHash](functions/genericHash.mdx) | - | | [initializeBindings](functions/initializeBindings.mdx) | A function that has to finish before any bindings exports can be used. | -| [maybeSwap](functions/maybeSwap.mdx) | - | | [merkleListHash](functions/merkleListHash.mdx) | - | | [method](functions/method.mdx) | A decorator to use in a zkApp to mark a method as provable. | | [provable](functions/provable.mdx) | - | diff --git a/docs/zkapps/o1js-reference/classes/AccountUpdate.mdx b/docs/zkapps/o1js-reference/classes/AccountUpdate.mdx index 4e697ad91..2207aea59 100644 --- a/docs/zkapps/o1js-reference/classes/AccountUpdate.mdx +++ b/docs/zkapps/o1js-reference/classes/AccountUpdate.mdx @@ -26,7 +26,7 @@ new AccountUpdate(body: Body, authorization?: {}): AccountUpdate #### Source -[lib/mina/account-update.ts:654](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L654) +[lib/mina/account-update.ts:679](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L679) ## Properties @@ -38,7 +38,7 @@ account: Account; #### Source -[lib/mina/account-update.ts:645](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L645) +[lib/mina/account-update.ts:670](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L670) *** @@ -54,7 +54,7 @@ authorization: {}; #### Source -[lib/mina/account-update.ts:642](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L642) +[lib/mina/account-update.ts:667](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L667) *** @@ -70,7 +70,7 @@ body: Body; #### Source -[lib/mina/account-update.ts:641](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L641) +[lib/mina/account-update.ts:666](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L666) *** @@ -82,7 +82,7 @@ currentSlot: CurrentSlot; #### Source -[lib/mina/account-update.ts:647](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L647) +[lib/mina/account-update.ts:672](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L672) *** @@ -94,7 +94,7 @@ id: number; #### Source -[lib/mina/account-update.ts:635](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L635) +[lib/mina/account-update.ts:660](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L660) *** @@ -109,7 +109,7 @@ was created. Can be modified by applications to add richer information. #### Source -[lib/mina/account-update.ts:640](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L640) +[lib/mina/account-update.ts:665](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L665) *** @@ -121,7 +121,7 @@ lazyAuthorization: undefined | LazySignature | LazyProof | LazyNone = undefined; #### Source -[lib/mina/account-update.ts:643](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L643) +[lib/mina/account-update.ts:668](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L668) *** @@ -133,7 +133,7 @@ network: Network; #### Source -[lib/mina/account-update.ts:646](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L646) +[lib/mina/account-update.ts:671](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L671) *** @@ -181,7 +181,7 @@ static Actions: { • **actions**: `Events` -• **event**: `Event` +• **action**: [`Field`](Field.mdx)[] ##### Returns @@ -201,7 +201,7 @@ static Actions: { #### Source -[lib/mina/account-update.ts:651](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L651) +[lib/mina/account-update.ts:676](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L676) *** @@ -241,7 +241,7 @@ static Events: { • **events**: `Events` -• **event**: `Event` +• **event**: [`Field`](Field.mdx)[] ##### Returns @@ -249,7 +249,7 @@ static Events: { #### Source -[lib/mina/account-update.ts:652](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L652) +[lib/mina/account-update.ts:677](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L677) *** @@ -269,7 +269,7 @@ static check: (x: AccountUpdate) => void = Types.AccountUpdate.check; #### Source -[lib/mina/account-update.ts:1118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1118) +[lib/mina/account-update.ts:1143](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1143) *** @@ -285,7 +285,7 @@ static sizeInFields: () => number = Types.AccountUpdate.sizeInFields; #### Source -[lib/mina/account-update.ts:1105](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1105) +[lib/mina/account-update.ts:1130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1130) *** @@ -305,7 +305,7 @@ static toFields: (x: AccountUpdate) => Field[] = Types.AccountUpdate.toFields; #### Source -[lib/mina/account-update.ts:1106](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1106) +[lib/mina/account-update.ts:1131](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1131) *** @@ -327,7 +327,7 @@ static toInput: (x: AccountUpdate) => {} = Types.AccountUpdate.toInput; #### Source -[lib/mina/account-update.ts:1114](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1114) +[lib/mina/account-update.ts:1139](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1139) *** @@ -347,7 +347,7 @@ static toValue: (x: AccountUpdate) => AccountUpdate = Types.AccountUpdate.toValu #### Source -[lib/mina/account-update.ts:1126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1126) +[lib/mina/account-update.ts:1151](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1151) ## Accessors @@ -403,7 +403,7 @@ get balance(): { #### Source -[lib/mina/account-update.ts:740](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L740) +[lib/mina/account-update.ts:765](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L765) *** @@ -427,7 +427,7 @@ set balanceChange(x: Int64): void #### Source -[lib/mina/account-update.ts:755](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L755) +[lib/mina/account-update.ts:780](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L780) *** @@ -443,7 +443,7 @@ get publicKey(): PublicKey #### Source -[lib/mina/account-update.ts:830](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L830) +[lib/mina/account-update.ts:855](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L855) *** @@ -459,7 +459,7 @@ get tokenId(): Field #### Source -[lib/mina/account-update.ts:683](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L683) +[lib/mina/account-update.ts:708](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L708) *** @@ -477,7 +477,7 @@ get update(): {} #### Source -[lib/mina/account-update.ts:762](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L762) +[lib/mina/account-update.ts:787](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L787) *** @@ -503,7 +503,10 @@ get static MayUseToken(): { }, { "inheritFromParent": Bool; "parentsOwnToken": Bool; - }, any>; + }, { + "inheritFromParent": Bool; + "parentsOwnToken": Bool; + }>; "isInheritFromParent": Bool; "isNo": Bool; "isParentsOwnToken": Bool; @@ -532,7 +535,10 @@ get static MayUseToken(): { }, { "inheritFromParent": Bool; "parentsOwnToken": Bool; - }, any>; + }, { + "inheritFromParent": Bool; + "parentsOwnToken": Bool; + }>; "isInheritFromParent": Bool; "isNo": Bool; "isParentsOwnToken": Bool; @@ -611,7 +617,10 @@ type: ProvablePureExtended<{ }, { "inheritFromParent": Bool; "parentsOwnToken": Bool; -}, any>; + }, { + "inheritFromParent": Bool; + "parentsOwnToken": Bool; +}>; ``` ###### Type declaration @@ -660,7 +669,7 @@ parentsOwnToken: Bool = Bool; #### Source -[lib/mina/account-update.ts:1151](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1151) +[lib/mina/account-update.ts:1176](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1176) ## Methods @@ -689,7 +698,7 @@ of the proof that authorizes the parent account update. #### Source -[lib/mina/account-update.ts:728](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L728) +[lib/mina/account-update.ts:753](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L753) *** @@ -705,7 +714,7 @@ extractTree(): AccountUpdateTree #### Source -[lib/mina/account-update.ts:976](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L976) +[lib/mina/account-update.ts:1001](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1001) *** @@ -721,7 +730,7 @@ hash(): Field #### Source -[lib/mina/account-update.ts:932](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L932) +[lib/mina/account-update.ts:957](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L957) *** @@ -737,7 +746,7 @@ isDummy(): Bool #### Source -[lib/mina/account-update.ts:994](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L994) +[lib/mina/account-update.ts:1019](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1019) *** @@ -767,7 +776,7 @@ be (can be) authorized by a signature. #### Source -[lib/mina/account-update.ts:849](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L849) +[lib/mina/account-update.ts:874](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L874) *** @@ -794,7 +803,7 @@ send(__namedParameters: { #### Source -[lib/mina/account-update.ts:687](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L687) +[lib/mina/account-update.ts:712](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L712) *** @@ -810,7 +819,7 @@ toJSON(): AccountUpdate #### Source -[lib/mina/account-update.ts:921](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L921) +[lib/mina/account-update.ts:946](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L946) *** @@ -829,7 +838,7 @@ default [AccountUpdate](AccountUpdate.mdx). #### Source -[lib/mina/account-update.ts:1183](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1183) +[lib/mina/account-update.ts:1208](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1208) *** @@ -845,7 +854,7 @@ toPrettyLayout(): void #### Source -[lib/mina/account-update.ts:970](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L970) +[lib/mina/account-update.ts:995](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L995) *** @@ -869,7 +878,7 @@ toPublicInput(__namedParameters: { #### Source -[lib/mina/account-update.ts:940](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L940) +[lib/mina/account-update.ts:965](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L965) *** @@ -920,7 +929,7 @@ Example: To constrain the account balance of a SmartContract to lie between #### Source -[lib/mina/account-update.ts:790](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L790) +[lib/mina/account-update.ts:815](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L815) *** @@ -961,7 +970,7 @@ Example: To fix the account nonce of a SmartContract to 0, you can use #### Source -[lib/mina/account-update.ts:817](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L817) +[lib/mina/account-update.ts:842](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L842) *** @@ -984,7 +993,7 @@ Attach account update to the current transaction #### Source -[lib/mina/account-update.ts:1038](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1038) +[lib/mina/account-update.ts:1063](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1063) *** @@ -1006,7 +1015,7 @@ Clones the [AccountUpdate](AccountUpdate.mdx). #### Source -[lib/mina/account-update.ts:669](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L669) +[lib/mina/account-update.ts:694](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L694) *** @@ -1034,7 +1043,7 @@ becomes part of the proof. #### Source -[lib/mina/account-update.ts:1019](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1019) +[lib/mina/account-update.ts:1044](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1044) *** @@ -1070,7 +1079,7 @@ be (can be) authorized by a signature. #### Source -[lib/mina/account-update.ts:1074](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1074) +[lib/mina/account-update.ts:1099](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1099) *** @@ -1092,7 +1101,7 @@ static defaultAccountUpdate(address: PublicKey, tokenId?: Field): AccountUpdate #### Source -[lib/mina/account-update.ts:986](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L986) +[lib/mina/account-update.ts:1011](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1011) *** @@ -1114,7 +1123,7 @@ static defaultFeePayer(address: PublicKey, nonce: UInt32): FeePayerUnsigned #### Source -[lib/mina/account-update.ts:998](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L998) +[lib/mina/account-update.ts:1023](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1023) *** @@ -1130,7 +1139,7 @@ static dummy(): AccountUpdate #### Source -[lib/mina/account-update.ts:989](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L989) +[lib/mina/account-update.ts:1014](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1014) *** @@ -1146,7 +1155,7 @@ static dummyFeePayer(): FeePayerUnsigned #### Source -[lib/mina/account-update.ts:1007](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1007) +[lib/mina/account-update.ts:1032](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1032) *** @@ -1162,7 +1171,7 @@ static empty(): AccountUpdate #### Source -[lib/mina/account-update.ts:1115](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1115) +[lib/mina/account-update.ts:1140](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1140) *** @@ -1184,7 +1193,7 @@ static fromFields(fields: Field[], __namedParameters: any[]): AccountUpdate #### Source -[lib/mina/account-update.ts:1119](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1119) +[lib/mina/account-update.ts:1144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1144) *** @@ -1204,7 +1213,7 @@ static fromJSON(json: AccountUpdate): AccountUpdate #### Source -[lib/mina/account-update.ts:927](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L927) +[lib/mina/account-update.ts:952](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L952) *** @@ -1224,7 +1233,7 @@ static fromValue(value: AccountUpdate | AccountUpdate | AccountUpdate): AccountU #### Source -[lib/mina/account-update.ts:1127](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1127) +[lib/mina/account-update.ts:1152](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1152) *** @@ -1258,7 +1267,7 @@ they [AccountUpdate](AccountUpdate.mdx) for the account which pays the fee #### Source -[lib/mina/account-update.ts:1095](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1095) +[lib/mina/account-update.ts:1120](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1120) *** @@ -1278,7 +1287,7 @@ static getNonce(accountUpdate: FeePayerUnsigned | AccountUpdate): UInt32 #### Source -[lib/mina/account-update.ts:873](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L873) +[lib/mina/account-update.ts:898](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L898) *** @@ -1304,7 +1313,7 @@ static setValue(maybeValue: SetOrKeep, value: T): void #### Source -[lib/mina/account-update.ts:766](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L766) +[lib/mina/account-update.ts:791](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L791) *** @@ -1324,7 +1333,7 @@ static signFeePayerInPlace(feePayer: FeePayerUnsigned): void #### Source -[lib/mina/account-update.ts:867](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L867) +[lib/mina/account-update.ts:892](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L892) *** @@ -1352,7 +1361,7 @@ static toAuxiliary(a?: AccountUpdate): (any[] | { #### Source -[lib/mina/account-update.ts:1107](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1107) +[lib/mina/account-update.ts:1132](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1132) *** @@ -1372,7 +1381,7 @@ static toJSON(a: AccountUpdate): AccountUpdate #### Source -[lib/mina/account-update.ts:924](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L924) +[lib/mina/account-update.ts:949](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L949) *** @@ -1394,7 +1403,7 @@ Disattach an account update from where it's currently located in the transaction #### Source -[lib/mina/account-update.ts:1055](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1055) +[lib/mina/account-update.ts:1080](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1080) *** @@ -1451,4 +1460,4 @@ static witness( #### Source -[lib/mina/account-update.ts:1135](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1135) +[lib/mina/account-update.ts:1160](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1160) diff --git a/docs/zkapps/o1js-reference/classes/AccountUpdateForest.mdx b/docs/zkapps/o1js-reference/classes/AccountUpdateForest.mdx index 1cc56a8e2..ca357b668 100644 --- a/docs/zkapps/o1js-reference/classes/AccountUpdateForest.mdx +++ b/docs/zkapps/o1js-reference/classes/AccountUpdateForest.mdx @@ -48,7 +48,7 @@ new AccountUpdateForest(__namedParameters: MerkleListBase<{ #### Source -[lib/provable/merkle-list.ts:83](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L83) +[lib/provable/merkle-list.ts:83](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L83) ## Properties @@ -68,7 +68,7 @@ data: Unconstrained; #### Source -[lib/provable/merkle-list.ts:300](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L300) +[lib/provable/merkle-list.ts:300](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L300) *** @@ -132,7 +132,7 @@ static _nextHash: undefined | (hash: Field, t: any) => Field; #### Source -[lib/provable/merkle-list.ts:296](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L296) +[lib/provable/merkle-list.ts:296](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L296) *** @@ -148,7 +148,7 @@ static _provable: undefined | ProvableHashable>; #### Source -[lib/provable/merkle-list.ts:299](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L299) +[lib/provable/merkle-list.ts:299](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L299) *** @@ -198,7 +198,7 @@ static empty: () => MerkleList<{ #### Source -[lib/provable/merkle-list.ts:245](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L245) +[lib/provable/merkle-list.ts:245](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L245) *** @@ -260,7 +260,7 @@ static from: (array: { #### Source -[lib/provable/merkle-list.ts:246](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L246) +[lib/provable/merkle-list.ts:246](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L246) *** @@ -322,7 +322,7 @@ static fromReverse: (array: { #### Source -[lib/provable/merkle-list.ts:247](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L247) +[lib/provable/merkle-list.ts:247](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L247) *** @@ -345,7 +345,7 @@ static provable: ProvableHashable #### Source -[lib/provable/merkle-list.ts:319](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L319) +[lib/provable/merkle-list.ts:319](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L319) *** @@ -393,7 +393,7 @@ get static emptyHash(): Field #### Source -[lib/provable/merkle-list.ts:314](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L314) +[lib/provable/merkle-list.ts:314](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L314) ## Methods @@ -440,7 +440,7 @@ clone(): MerkleList<{ #### Source -[lib/provable/merkle-list.ts:189](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L189) +[lib/provable/merkle-list.ts:189](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L189) *** @@ -478,7 +478,7 @@ to handle the `isDummy` flag separately. #### Source -[lib/provable/merkle-list.ts:203](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L203) +[lib/provable/merkle-list.ts:203](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L203) *** @@ -498,7 +498,7 @@ isEmpty(): Bool #### Source -[lib/provable/merkle-list.ts:88](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L88) +[lib/provable/merkle-list.ts:88](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L88) *** @@ -534,7 +534,7 @@ nextHash(hash: Field, value: { #### Source -[lib/provable/merkle-list.ts:306](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L306) +[lib/provable/merkle-list.ts:306](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L306) *** @@ -586,7 +586,7 @@ id: number = RandomId; #### Source -[lib/provable/merkle-list.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L154) +[lib/provable/merkle-list.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L154) *** @@ -638,7 +638,7 @@ id: number = RandomId; #### Source -[lib/provable/merkle-list.ts:139](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L139) +[lib/provable/merkle-list.ts:139](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L139) *** @@ -694,7 +694,7 @@ id: number = RandomId; #### Source -[lib/provable/merkle-list.ts:173](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L173) +[lib/provable/merkle-list.ts:173](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L173) *** @@ -730,7 +730,7 @@ Push a new element to the list. #### Source -[lib/provable/merkle-list.ts:95](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L95) +[lib/provable/merkle-list.ts:95](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L95) *** @@ -768,7 +768,7 @@ Push a new element to the list, if the `condition` is true. #### Source -[lib/provable/merkle-list.ts:107](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L107) +[lib/provable/merkle-list.ts:107](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L107) *** @@ -815,7 +815,7 @@ startIterating(): MerkleListIterator<{ #### Source -[lib/provable/merkle-list.ts:217](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L217) +[lib/provable/merkle-list.ts:217](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L217) *** @@ -862,7 +862,7 @@ startIteratingFromLast(): MerkleListIterator<{ #### Source -[lib/provable/merkle-list.ts:222](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L222) +[lib/provable/merkle-list.ts:222](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L222) *** @@ -882,7 +882,7 @@ static assertConstant(forest: AccountUpdateForestBase): void #### Source -[lib/mina/account-update.ts:1352](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1352) +[lib/mina/account-update.ts:1377](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1377) *** @@ -939,7 +939,7 @@ class MyList extends MerkleList.create(Field, (hash, x) => #### Source -[lib/provable/merkle-list.ts:239](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L239) +[lib/provable/merkle-list.ts:239](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L239) *** @@ -959,7 +959,7 @@ static fromFlatArray(updates: AccountUpdate[]): AccountUpdateForest #### Source -[lib/mina/account-update.ts:1321](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1321) +[lib/mina/account-update.ts:1346](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1346) *** @@ -986,4 +986,4 @@ static toFlatArray( #### Source -[lib/mina/account-update.ts:1325](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1325) +[lib/mina/account-update.ts:1350](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1350) diff --git a/docs/zkapps/o1js-reference/classes/AccountUpdateTree.mdx b/docs/zkapps/o1js-reference/classes/AccountUpdateTree.mdx index 35b23d70b..821caed4a 100644 --- a/docs/zkapps/o1js-reference/classes/AccountUpdateTree.mdx +++ b/docs/zkapps/o1js-reference/classes/AccountUpdateTree.mdx @@ -58,7 +58,7 @@ new AccountUpdateTree(value: { #### Source -[lib/provable/types/struct.ts:267](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L267) +[lib/provable/types/struct.ts:267](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L267) ## Properties @@ -78,7 +78,7 @@ accountUpdate: Hashed = HashedAccountUpdate.provable; #### Source -[lib/mina/account-update.ts:1380](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1380) +[lib/mina/account-update.ts:1405](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1405) *** @@ -122,7 +122,7 @@ id: number = RandomId; #### Source -[lib/mina/account-update.ts:1381](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1381) +[lib/mina/account-update.ts:1406](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1406) *** @@ -142,7 +142,7 @@ id: number = RandomId; #### Source -[lib/mina/account-update.ts:1379](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1379) +[lib/mina/account-update.ts:1404](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1404) *** @@ -162,7 +162,7 @@ static _isStruct: true; #### Source -[lib/provable/types/struct.ts:267](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L267) +[lib/provable/types/struct.ts:267](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L267) *** @@ -211,7 +211,7 @@ the element of type `T` to put assertions on. #### Source -[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L66) +[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L66) *** @@ -293,7 +293,7 @@ id: number = RandomId; #### Source -[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L76) +[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L76) *** @@ -341,7 +341,7 @@ If not provided, a default value for auxiliary data is returned. #### Source -[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L37) +[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L37) *** @@ -388,7 +388,7 @@ the element of type `T` to generate the [Field](Field.mdx) array from. #### Source -[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L26) +[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L26) *** @@ -450,7 +450,7 @@ optional packed: [Field, number][]; #### Source -[lib/provable/types/struct.ts:270](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L270) +[lib/provable/types/struct.ts:270](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L270) *** @@ -494,7 +494,7 @@ Convert provable type to a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L71) +[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L71) ## Methods @@ -520,7 +520,7 @@ See [AccountUpdate.approve](AccountUpdate.mdx#approve). #### Source -[lib/mina/account-update.ts:1400](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1400) +[lib/mina/account-update.ts:1425](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1425) *** @@ -544,7 +544,7 @@ static empty(): AccountUpdateTree #### Source -[lib/mina/account-update.ts:1416](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1416) +[lib/mina/account-update.ts:1441](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1441) *** @@ -568,7 +568,7 @@ Create a tree of account updates which only consists of a root. #### Source -[lib/mina/account-update.ts:1386](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1386) +[lib/mina/account-update.ts:1411](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1411) *** @@ -598,7 +598,7 @@ static fromFields(fields: Field[], aux: any): AccountUpdateTree #### Source -[lib/mina/account-update.ts:1413](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1413) +[lib/mina/account-update.ts:1438](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1438) *** @@ -626,4 +626,4 @@ A `number` representing the size of the `T` type in terms of [Field](Field.mdx) #### Source -[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L56) +[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L56) diff --git a/docs/zkapps/o1js-reference/classes/AlmostForeignField.mdx b/docs/zkapps/o1js-reference/classes/AlmostForeignField.mdx index 5777d8edc..da7f300a8 100644 --- a/docs/zkapps/o1js-reference/classes/AlmostForeignField.mdx +++ b/docs/zkapps/o1js-reference/classes/AlmostForeignField.mdx @@ -34,7 +34,7 @@ new AlmostForeignField(x: #### Source -[lib/provable/foreign-field.ts:481](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L481) +[lib/provable/foreign-field.ts:481](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L481) ## Properties @@ -46,7 +46,7 @@ type: "AlmostReduced" | "FullyReduced" = 'AlmostReduced'; #### Source -[lib/provable/foreign-field.ts:479](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L479) +[lib/provable/foreign-field.ts:479](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L479) *** @@ -64,7 +64,7 @@ The internal representation of a foreign field element, as a tuple of 3 limbs. #### Source -[lib/provable/foreign-field.ts:50](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L50) +[lib/provable/foreign-field.ts:50](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L50) *** @@ -80,7 +80,7 @@ static _Bigint: undefined | {} = undefined; #### Source -[lib/provable/foreign-field.ts:28](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L28) +[lib/provable/foreign-field.ts:28](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L28) *** @@ -96,7 +96,7 @@ static _modulus: undefined | bigint = undefined; #### Source -[lib/provable/foreign-field.ts:29](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L29) +[lib/provable/foreign-field.ts:29](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L29) *** @@ -112,7 +112,7 @@ static _provable: undefined | ProvablePureExtended #### Source -[lib/provable/foreign-field.ts:488](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L488) +[lib/provable/foreign-field.ts:488](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L488) *** @@ -286,7 +286,7 @@ get static sizeInBits(): number #### Source -[lib/provable/foreign-field.ts:43](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L43) +[lib/provable/foreign-field.ts:43](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L43) ## Methods @@ -318,7 +318,7 @@ x.add(2); // x + 2 mod p #### Source -[lib/provable/foreign-field.ts:208](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L208) +[lib/provable/foreign-field.ts:208](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L208) *** @@ -350,7 +350,7 @@ ensuring validity of all our non-native field arithmetic methods. #### Source -[lib/provable/foreign-field.ts:163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L163) +[lib/provable/foreign-field.ts:163](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L163) *** @@ -375,7 +375,7 @@ Returns the field element as a [CanonicalForeignField](CanonicalForeignField.mdx #### Source -[lib/provable/foreign-field.ts:194](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L194) +[lib/provable/foreign-field.ts:194](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L194) *** @@ -421,7 +421,7 @@ xChecked satisfies CanonicalForeignField; ##### Source -[lib/provable/foreign-field.ts:286](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L286) +[lib/provable/foreign-field.ts:286](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L286) #### assertEquals(y, message) @@ -445,7 +445,7 @@ assertEquals(y: AlmostForeignField, message?: string): AlmostForeignField ##### Source -[lib/provable/foreign-field.ts:290](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L290) +[lib/provable/foreign-field.ts:290](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L290) #### assertEquals(y, message) @@ -469,7 +469,7 @@ assertEquals(y: ForeignField, message?: string): ForeignField ##### Source -[lib/provable/foreign-field.ts:291](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L291) +[lib/provable/foreign-field.ts:291](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L291) *** @@ -505,7 +505,7 @@ x.assertLessThan(10); #### Source -[lib/provable/foreign-field.ts:333](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L333) +[lib/provable/foreign-field.ts:333](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L333) *** @@ -538,7 +538,7 @@ z.mul(y).assertEquals(x); #### Source -[lib/provable/foreign-field.ts:455](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L455) +[lib/provable/foreign-field.ts:455](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L455) *** @@ -566,7 +566,7 @@ let isXZero = x.equals(0); #### Source -[lib/provable/foreign-field.ts:515](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L515) +[lib/provable/foreign-field.ts:515](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L515) *** @@ -595,7 +595,7 @@ z.mul(x).assertEquals(1); #### Source -[lib/provable/foreign-field.ts:441](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L441) +[lib/provable/foreign-field.ts:441](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L441) *** @@ -619,7 +619,7 @@ See FieldVar to understand constants vs variables. #### Source -[lib/provable/foreign-field.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L126) +[lib/provable/foreign-field.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L126) *** @@ -651,7 +651,7 @@ x.mul(y); // x*y mod p #### Source -[lib/provable/foreign-field.ts:427](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L427) +[lib/provable/foreign-field.ts:427](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L427) *** @@ -679,7 +679,7 @@ x.neg(); // -x mod p = p - x #### Source -[lib/provable/foreign-field.ts:219](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L219) +[lib/provable/foreign-field.ts:219](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L219) *** @@ -711,7 +711,7 @@ x.sub(1); // x - 1 mod p #### Source -[lib/provable/foreign-field.ts:234](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L234) +[lib/provable/foreign-field.ts:234](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L234) *** @@ -733,7 +733,7 @@ Convert this field element to a bigint. #### Source -[lib/provable/foreign-field.ts:146](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L146) +[lib/provable/foreign-field.ts:146](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L146) *** @@ -761,7 +761,7 @@ This method is provable! #### Source -[lib/provable/foreign-field.ts:352](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L352) +[lib/provable/foreign-field.ts:352](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L352) *** @@ -788,7 +788,7 @@ that is, in situations where the prover computes a value outside provable code. #### Source -[lib/provable/foreign-field.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L138) +[lib/provable/foreign-field.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L138) *** @@ -810,7 +810,7 @@ Instance version of `Provable.toFields`, see Provable.toFields #### Source -[lib/provable/foreign-field.ts:400](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L400) +[lib/provable/foreign-field.ts:400](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L400) *** @@ -843,7 +843,7 @@ This is most efficient than when checking a multiple of 3 field elements at once #### Source -[lib/provable/foreign-field.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L177) +[lib/provable/foreign-field.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L177) *** @@ -867,7 +867,7 @@ static check(x: ForeignField): void #### Source -[lib/provable/foreign-field.ts:493](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L493) +[lib/provable/foreign-field.ts:493](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L493) *** @@ -895,7 +895,7 @@ Coerce the input to a [ForeignField](ForeignField.mdx). ##### Source -[lib/provable/foreign-field.ts:114](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L114) +[lib/provable/foreign-field.ts:114](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L114) #### from(x) @@ -917,7 +917,7 @@ static from(x: string | number | bigint | ForeignField): ForeignField ##### Source -[lib/provable/foreign-field.ts:115](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L115) +[lib/provable/foreign-field.ts:115](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L115) *** @@ -945,7 +945,7 @@ This method is provable! #### Source -[lib/provable/foreign-field.ts:382](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L382) +[lib/provable/foreign-field.ts:382](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L382) *** @@ -965,7 +965,7 @@ static random(): CanonicalForeignField #### Source -[lib/provable/foreign-field.ts:393](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L393) +[lib/provable/foreign-field.ts:393](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L393) *** @@ -1011,7 +1011,7 @@ than chaining calls to [ForeignField.add](ForeignField.mdx#add) and [ForeignFiel #### Source -[lib/provable/foreign-field.ts:259](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L259) +[lib/provable/foreign-field.ts:259](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L259) *** @@ -1035,4 +1035,4 @@ Coerce the input to an [AlmostForeignField](AlmostForeignField.mdx) without addi #### Source -[lib/provable/foreign-field.ts:503](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L503) +[lib/provable/foreign-field.ts:503](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L503) diff --git a/docs/zkapps/o1js-reference/classes/BaseMerkleWitness.mdx b/docs/zkapps/o1js-reference/classes/BaseMerkleWitness.mdx index 1c753c984..89b3d21ec 100644 --- a/docs/zkapps/o1js-reference/classes/BaseMerkleWitness.mdx +++ b/docs/zkapps/o1js-reference/classes/BaseMerkleWitness.mdx @@ -32,7 +32,7 @@ A circuit-compatible Witness. #### Source -[lib/provable/merkle-tree.ts:187](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L187) +[lib/provable/merkle-tree.ts:187](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L187) ## Properties @@ -44,7 +44,7 @@ isLeft: Bool[]; #### Source -[lib/provable/merkle-tree.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L177) +[lib/provable/merkle-tree.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L177) *** @@ -56,7 +56,7 @@ path: Field[]; #### Source -[lib/provable/merkle-tree.ts:176](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L176) +[lib/provable/merkle-tree.ts:176](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L176) *** @@ -68,7 +68,7 @@ static height: number; #### Source -[lib/provable/merkle-tree.ts:175](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L175) +[lib/provable/merkle-tree.ts:175](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L175) ## Methods @@ -92,7 +92,7 @@ assertEquals(x: this): void #### Source -[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L130) +[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L130) *** @@ -112,7 +112,7 @@ Index of the leaf. #### Source -[lib/provable/merkle-tree.ts:221](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L221) +[lib/provable/merkle-tree.ts:221](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L221) *** @@ -138,7 +138,7 @@ The calculated root. #### Source -[lib/provable/merkle-tree.ts:204](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L204) +[lib/provable/merkle-tree.ts:204](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L204) *** @@ -162,7 +162,7 @@ equals(x: this): Bool #### Source -[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L126) +[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L126) *** @@ -178,7 +178,7 @@ height(): number #### Source -[lib/provable/merkle-tree.ts:178](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L178) +[lib/provable/merkle-tree.ts:178](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L178) *** @@ -198,7 +198,7 @@ isConstant(): boolean #### Source -[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L134) +[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L134) *** @@ -218,7 +218,7 @@ toConstant(): this #### Source -[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L122) +[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L122) *** @@ -238,7 +238,7 @@ toFields(): Field[] #### Source -[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L85) +[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L85) *** @@ -258,7 +258,7 @@ toJSON(): any #### Source -[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L118) +[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L118) *** @@ -288,7 +288,7 @@ static check(this: T, v: InstanceType): void #### Source -[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L163) +[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L163) *** @@ -312,7 +312,7 @@ static empty(): InstanceType #### Source -[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L218) +[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L218) *** @@ -342,7 +342,7 @@ static fromFields(this: T, xs: Field[]): InstanceType #### Source -[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L138) +[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L138) *** @@ -372,7 +372,7 @@ static fromJSON(this: T, value: any): InstanceType #### Source -[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L196) +[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L196) *** @@ -402,7 +402,7 @@ static fromObject(this: T, value: NonMethods>): InstanceType< #### Source -[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L30) +[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L30) *** @@ -432,7 +432,7 @@ static fromValue(this: T, value: any): InstanceType #### Source -[lib/provable/types/circuit-value.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L98) +[lib/provable/types/circuit-value.ts:98](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L98) *** @@ -452,7 +452,7 @@ static sizeInFields(): number #### Source -[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L37) +[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L37) *** @@ -472,7 +472,7 @@ static toAuxiliary(): [] #### Source -[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L59) +[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L59) *** @@ -502,7 +502,7 @@ static toConstant(this: T, t: InstanceType): InstanceType #### Source -[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L177) +[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L177) *** @@ -532,7 +532,7 @@ static toFields(this: T, v: InstanceType): Field[] #### Source -[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L42) +[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L42) *** @@ -562,7 +562,7 @@ static toInput(this: T, v: InstanceType): HashInput #### Source -[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L63) +[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L63) *** @@ -592,7 +592,7 @@ static toJSON(this: T, v: InstanceType): any #### Source -[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L185) +[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L185) *** @@ -622,4 +622,4 @@ static toValue(this: T, v: InstanceType): any #### Source -[lib/provable/types/circuit-value.ts:89](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L89) +[lib/provable/types/circuit-value.ts:89](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L89) diff --git a/docs/zkapps/o1js-reference/classes/Bool.mdx b/docs/zkapps/o1js-reference/classes/Bool.mdx index 4461f5aa2..8b7d176eb 100644 --- a/docs/zkapps/o1js-reference/classes/Bool.mdx +++ b/docs/zkapps/o1js-reference/classes/Bool.mdx @@ -26,7 +26,7 @@ new Bool(x: boolean | FieldVar | Bool): Bool #### Source -[lib/provable/bool.ts:33](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L33) +[lib/provable/bool.ts:33](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L33) ## Properties @@ -38,7 +38,7 @@ value: FieldVar; #### Source -[lib/provable/bool.ts:31](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L31) +[lib/provable/bool.ts:31](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L31) *** @@ -69,7 +69,7 @@ a [Field](Field.mdx) #### Source -[lib/provable/bool.ts:373](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L373) +[lib/provable/bool.ts:373](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L373) *** @@ -81,7 +81,7 @@ static sizeInBytes: number = 1; #### Source -[lib/provable/bool.ts:367](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L367) +[lib/provable/bool.ts:367](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L367) ## Methods @@ -106,7 +106,7 @@ this [Bool](Bool.mdx) and `y` are also true. #### Source -[lib/provable/bool.ts:73](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L73) +[lib/provable/bool.ts:73](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L73) *** @@ -132,7 +132,7 @@ a [Bool](Bool.mdx). #### Source -[lib/provable/bool.ts:114](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L114) +[lib/provable/bool.ts:114](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L114) *** @@ -154,7 +154,7 @@ Proves that this [Bool](Bool.mdx) is `false`. #### Source -[lib/provable/bool.ts:145](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L145) +[lib/provable/bool.ts:145](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L145) *** @@ -176,7 +176,7 @@ Proves that this [Bool](Bool.mdx) is `true`. #### Source -[lib/provable/bool.ts:131](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L131) +[lib/provable/bool.ts:131](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L131) *** @@ -200,7 +200,7 @@ a [Bool](Bool.mdx). #### Source -[lib/provable/bool.ts:160](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L160) +[lib/provable/bool.ts:160](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L160) *** @@ -232,7 +232,7 @@ assert(isZero.implies(lessThan10), 'x = 0 implies x < 10'); #### Source -[lib/provable/bool.ts:106](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L106) +[lib/provable/bool.ts:106](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L106) *** @@ -248,7 +248,7 @@ isConstant(): this is Object #### Source -[lib/provable/bool.ts:45](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L45) +[lib/provable/bool.ts:45](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L45) *** @@ -266,7 +266,7 @@ a new [Bool](Bool.mdx) that is the negation of this [Bool](Bool.mdx). #### Source -[lib/provable/bool.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L59) +[lib/provable/bool.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L59) *** @@ -291,7 +291,7 @@ this [Bool](Bool.mdx) or `y` is true. #### Source -[lib/provable/bool.ts:86](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L86) +[lib/provable/bool.ts:86](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L86) *** @@ -309,7 +309,7 @@ Returns the size of this type. #### Source -[lib/provable/bool.ts:185](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L185) +[lib/provable/bool.ts:185](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L185) *** @@ -328,7 +328,7 @@ This can only be called on non-witness values. #### Source -[lib/provable/bool.ts:216](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L216) +[lib/provable/bool.ts:216](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L216) *** @@ -346,7 +346,7 @@ Converts a [Bool](Bool.mdx) to a [Field](Field.mdx). `false` becomes 0 and `true #### Source -[lib/provable/bool.ts:52](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L52) +[lib/provable/bool.ts:52](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L52) *** @@ -364,7 +364,7 @@ Serializes this [Bool](Bool.mdx) into [Field](Field.mdx) elements. #### Source -[lib/provable/bool.ts:192](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L192) +[lib/provable/bool.ts:192](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L192) *** @@ -383,7 +383,7 @@ This operation does _not_ affect the circuit and can't be used to prove anything #### Source -[lib/provable/bool.ts:208](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L208) +[lib/provable/bool.ts:208](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L208) *** @@ -402,7 +402,7 @@ This operation does _not_ affect the circuit and can't be used to prove anything #### Source -[lib/provable/bool.ts:200](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L200) +[lib/provable/bool.ts:200](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L200) *** @@ -426,7 +426,7 @@ Boolean AND operation. #### Source -[lib/provable/bool.ts:244](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L244) +[lib/provable/bool.ts:244](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L244) *** @@ -450,7 +450,7 @@ Asserts if both [Bool](Bool.mdx) are equal. #### Source -[lib/provable/bool.ts:264](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L264) +[lib/provable/bool.ts:264](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L264) *** @@ -470,7 +470,7 @@ static check(x: Bool): void #### Source -[lib/provable/bool.ts:369](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L369) +[lib/provable/bool.ts:369](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L369) *** @@ -486,7 +486,7 @@ static empty(): Bool #### Source -[lib/provable/bool.ts:344](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L344) +[lib/provable/bool.ts:344](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L344) *** @@ -510,7 +510,7 @@ Checks two [Bool](Bool.mdx) for equality. #### Source -[lib/provable/bool.ts:275](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L275) +[lib/provable/bool.ts:275](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L275) *** @@ -530,7 +530,7 @@ static fromBytes(bytes: number[]): Bool #### Source -[lib/provable/bool.ts:356](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L356) +[lib/provable/bool.ts:356](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L356) *** @@ -552,7 +552,7 @@ Creates a data structure from an array of serialized [Field](Field.mdx) elements #### Source -[lib/provable/bool.ts:299](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L299) +[lib/provable/bool.ts:299](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L299) *** @@ -575,7 +575,7 @@ This operation does _not_ affect the circuit and can't be used to prove anything #### Source -[lib/provable/bool.ts:333](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L333) +[lib/provable/bool.ts:333](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L333) *** @@ -597,7 +597,7 @@ static fromValue(b: boolean | Bool): Bool #### Source -[lib/provable/bool.ts:316](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L316) +[lib/provable/bool.ts:316](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L316) *** @@ -619,7 +619,7 @@ Boolean negation. #### Source -[lib/provable/bool.ts:234](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L234) +[lib/provable/bool.ts:234](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L234) *** @@ -643,7 +643,7 @@ Boolean OR operation. #### Source -[lib/provable/bool.ts:254](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L254) +[lib/provable/bool.ts:254](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L254) *** @@ -669,7 +669,7 @@ static readBytes(bytes: number[], offset: NonNegativeInteger): [Bool, numb #### Source -[lib/provable/bool.ts:360](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L360) +[lib/provable/bool.ts:360](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L360) *** @@ -687,7 +687,7 @@ Returns the size of this type. #### Source -[lib/provable/bool.ts:340](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L340) +[lib/provable/bool.ts:340](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L340) *** @@ -709,7 +709,7 @@ Static method to serialize a [Bool](Bool.mdx) into its auxiliary data. #### Source -[lib/provable/bool.ts:292](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L292) +[lib/provable/bool.ts:292](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L292) *** @@ -729,7 +729,7 @@ static toBytes(b: Bool): number[] #### Source -[lib/provable/bool.ts:352](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L352) +[lib/provable/bool.ts:352](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L352) *** @@ -749,7 +749,7 @@ static toField(x: boolean | Bool): Field #### Source -[lib/provable/bool.ts:227](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L227) +[lib/provable/bool.ts:227](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L227) *** @@ -771,7 +771,7 @@ Static method to serialize a [Bool](Bool.mdx) into an array of [Field](Field.mdx #### Source -[lib/provable/bool.ts:285](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L285) +[lib/provable/bool.ts:285](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L285) *** @@ -803,7 +803,7 @@ packed: [Field, number][]; #### Source -[lib/provable/bool.ts:348](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L348) +[lib/provable/bool.ts:348](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L348) *** @@ -826,7 +826,7 @@ This operation does _not_ affect the circuit and can't be used to prove anything #### Source -[lib/provable/bool.ts:325](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L325) +[lib/provable/bool.ts:325](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L325) *** @@ -848,4 +848,4 @@ static toValue(x: Bool): boolean #### Source -[lib/provable/bool.ts:309](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L309) +[lib/provable/bool.ts:309](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L309) diff --git a/docs/zkapps/o1js-reference/classes/CanonicalForeignField.mdx b/docs/zkapps/o1js-reference/classes/CanonicalForeignField.mdx index 3689b42b4..d418cdd4d 100644 --- a/docs/zkapps/o1js-reference/classes/CanonicalForeignField.mdx +++ b/docs/zkapps/o1js-reference/classes/CanonicalForeignField.mdx @@ -34,7 +34,7 @@ new CanonicalForeignField(x: #### Source -[lib/provable/foreign-field.ts:523](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L523) +[lib/provable/foreign-field.ts:523](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L523) ## Properties @@ -46,7 +46,7 @@ type: "FullyReduced"; #### Source -[lib/provable/foreign-field.ts:521](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L521) +[lib/provable/foreign-field.ts:521](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L521) *** @@ -64,7 +64,7 @@ The internal representation of a foreign field element, as a tuple of 3 limbs. #### Source -[lib/provable/foreign-field.ts:50](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L50) +[lib/provable/foreign-field.ts:50](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L50) *** @@ -80,7 +80,7 @@ static _Bigint: undefined | {} = undefined; #### Source -[lib/provable/foreign-field.ts:28](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L28) +[lib/provable/foreign-field.ts:28](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L28) *** @@ -96,7 +96,7 @@ static _modulus: undefined | bigint = undefined; #### Source -[lib/provable/foreign-field.ts:29](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L29) +[lib/provable/foreign-field.ts:29](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L29) *** @@ -112,7 +112,7 @@ static _provable: undefined | ProvablePureExtended.toFields`, see Provable.toFields #### Source -[lib/provable/foreign-field.ts:400](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L400) +[lib/provable/foreign-field.ts:400](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L400) *** @@ -846,7 +846,7 @@ This is most efficient than when checking a multiple of 3 field elements at once #### Source -[lib/provable/foreign-field.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L177) +[lib/provable/foreign-field.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L177) *** @@ -870,7 +870,7 @@ static check(x: ForeignField): void #### Source -[lib/provable/foreign-field.ts:535](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L535) +[lib/provable/foreign-field.ts:535](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L535) *** @@ -898,7 +898,7 @@ Coerce the input to a [ForeignField](ForeignField.mdx). ##### Source -[lib/provable/foreign-field.ts:114](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L114) +[lib/provable/foreign-field.ts:114](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L114) #### from(x) @@ -920,7 +920,7 @@ static from(x: string | number | bigint | ForeignField): ForeignField ##### Source -[lib/provable/foreign-field.ts:115](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L115) +[lib/provable/foreign-field.ts:115](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L115) *** @@ -948,7 +948,7 @@ This method is provable! #### Source -[lib/provable/foreign-field.ts:382](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L382) +[lib/provable/foreign-field.ts:382](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L382) *** @@ -968,7 +968,7 @@ static random(): CanonicalForeignField #### Source -[lib/provable/foreign-field.ts:393](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L393) +[lib/provable/foreign-field.ts:393](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L393) *** @@ -1014,7 +1014,7 @@ than chaining calls to [ForeignField.add](ForeignField.mdx#add) and [ForeignFiel #### Source -[lib/provable/foreign-field.ts:259](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L259) +[lib/provable/foreign-field.ts:259](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L259) *** @@ -1038,4 +1038,4 @@ Coerce the input to a [CanonicalForeignField](CanonicalForeignField.mdx) without #### Source -[lib/provable/foreign-field.ts:545](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L545) +[lib/provable/foreign-field.ts:545](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L545) diff --git a/docs/zkapps/o1js-reference/classes/Character.mdx b/docs/zkapps/o1js-reference/classes/Character.mdx index dc5dee2c9..32ecb0775 100644 --- a/docs/zkapps/o1js-reference/classes/Character.mdx +++ b/docs/zkapps/o1js-reference/classes/Character.mdx @@ -26,7 +26,7 @@ new Character(value: number | Field): Character #### Source -[lib/provable/string.ts:13](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L13) +[lib/provable/string.ts:13](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L13) ## Properties @@ -42,7 +42,7 @@ value: Field = Field; #### Source -[lib/provable/string.ts:12](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L12) +[lib/provable/string.ts:12](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L12) *** @@ -58,7 +58,7 @@ static _isStruct: true; #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) *** @@ -90,7 +90,7 @@ value: Field = Field; #### Source -[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L154) +[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L154) *** @@ -126,7 +126,7 @@ value: Field = Field; #### Source -[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L87) +[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L87) *** @@ -166,7 +166,7 @@ value: Field = Field; #### Source -[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L153) +[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L153) *** @@ -194,7 +194,7 @@ Convert provable type from a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L76) +[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L76) *** @@ -228,7 +228,7 @@ If not provided, a default value for auxiliary data is returned. #### Source -[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L37) +[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L37) *** @@ -261,7 +261,7 @@ the element of type `T` to generate the [Field](Field.mdx) array from. #### Source -[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L26) +[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L26) *** @@ -309,7 +309,7 @@ optional packed: [Field, number][]; #### Source -[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L148) +[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L148) *** @@ -349,7 +349,7 @@ value: string = Field; #### Source -[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L152) +[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L152) *** @@ -391,7 +391,7 @@ value: bigint = Field; #### Source -[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L71) +[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L71) ## Methods @@ -407,7 +407,7 @@ isNull(): Bool #### Source -[lib/provable/string.ts:17](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L17) +[lib/provable/string.ts:17](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L17) *** @@ -423,7 +423,7 @@ toField(): Field #### Source -[lib/provable/string.ts:21](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L21) +[lib/provable/string.ts:21](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L21) *** @@ -439,7 +439,7 @@ toString(): string #### Source -[lib/provable/string.ts:25](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L25) +[lib/provable/string.ts:25](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L25) *** @@ -467,7 +467,7 @@ static check(c: { #### Source -[lib/provable/string.ts:36](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L36) +[lib/provable/string.ts:36](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L36) *** @@ -487,7 +487,7 @@ static fromString(str: string): Character #### Source -[lib/provable/string.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L30) +[lib/provable/string.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L30) *** @@ -511,4 +511,4 @@ A `number` representing the size of the `T` type in terms of [Field](Field.mdx) #### Source -[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L56) +[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L56) diff --git a/docs/zkapps/o1js-reference/classes/Circuit.mdx b/docs/zkapps/o1js-reference/classes/Circuit.mdx index 0cab1396b..258a4cf5c 100644 --- a/docs/zkapps/o1js-reference/classes/Circuit.mdx +++ b/docs/zkapps/o1js-reference/classes/Circuit.mdx @@ -20,7 +20,7 @@ static _main: CircuitData; #### Source -[lib/proof-system/circuit.ts:22](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L22) +[lib/proof-system/circuit.ts:22](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L22) ## Methods @@ -44,7 +44,7 @@ const keypair = await MyCircuit.generateKeypair(); #### Source -[lib/proof-system/circuit.ts:31](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L31) +[lib/proof-system/circuit.ts:31](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L31) *** @@ -80,7 +80,7 @@ const proof = await MyCircuit.prove(privateInput, publicInput, keypair); #### Source -[lib/proof-system/circuit.ts:51](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L51) +[lib/proof-system/circuit.ts:51](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L51) *** @@ -117,4 +117,4 @@ const isValid = await MyCircuit.verify(publicInput, keypair.vk, proof); #### Source -[lib/proof-system/circuit.ts:82](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L82) +[lib/proof-system/circuit.ts:82](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L82) diff --git a/docs/zkapps/o1js-reference/classes/CircuitString.mdx b/docs/zkapps/o1js-reference/classes/CircuitString.mdx index e39dcce8b..4c98dd4be 100644 --- a/docs/zkapps/o1js-reference/classes/CircuitString.mdx +++ b/docs/zkapps/o1js-reference/classes/CircuitString.mdx @@ -30,7 +30,7 @@ new CircuitString(value: { #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) ## Properties @@ -46,7 +46,7 @@ values: Character[]; #### Source -[lib/provable/string.ts:61](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L61) +[lib/provable/string.ts:61](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L61) *** @@ -62,7 +62,7 @@ static _isStruct: true; #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) *** @@ -97,7 +97,7 @@ the element of type `T` to put assertions on. #### Source -[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L66) +[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L66) *** @@ -129,7 +129,7 @@ values: Character[]; #### Source -[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L154) +[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L154) *** @@ -165,7 +165,7 @@ values: Character[]; #### Source -[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L87) +[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L87) *** @@ -209,7 +209,7 @@ values: Character[]; #### Source -[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L153) +[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L153) *** @@ -235,7 +235,7 @@ Convert provable type from a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L76) +[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L76) *** @@ -247,7 +247,7 @@ static maxLength: number = DEFAULT_STRING_LENGTH; #### Source -[lib/provable/string.ts:68](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L68) +[lib/provable/string.ts:68](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L68) *** @@ -281,7 +281,7 @@ If not provided, a default value for auxiliary data is returned. #### Source -[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L37) +[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L37) *** @@ -314,7 +314,7 @@ the element of type `T` to generate the [Field](Field.mdx) array from. #### Source -[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L26) +[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L26) *** @@ -362,7 +362,7 @@ optional packed: [Field, number][]; #### Source -[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L148) +[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L148) *** @@ -408,7 +408,7 @@ values: { #### Source -[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L152) +[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L152) *** @@ -438,7 +438,7 @@ Convert provable type to a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L71) +[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L71) ## Methods @@ -461,7 +461,7 @@ within the `maxLength` of this string (the other string can have a different max #### Source -[lib/provable/string.ts:117](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L117) +[lib/provable/string.ts:117](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L117) *** @@ -497,7 +497,7 @@ mask: Bool[]; #### Source -[lib/provable/string.ts:80](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L80) +[lib/provable/string.ts:80](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L80) *** @@ -519,7 +519,7 @@ returns true if `this` has the same value as `other` #### Source -[lib/provable/string.ts:109](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L109) +[lib/provable/string.ts:109](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L109) *** @@ -535,7 +535,7 @@ hash(): Field #### Source -[lib/provable/string.ts:143](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L143) +[lib/provable/string.ts:143](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L143) *** @@ -551,7 +551,7 @@ length(): Field #### Source -[lib/provable/string.ts:102](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L102) +[lib/provable/string.ts:102](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L102) *** @@ -567,7 +567,7 @@ lengthMask(): Bool[] #### Source -[lib/provable/string.ts:99](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L99) +[lib/provable/string.ts:99](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L99) *** @@ -583,7 +583,7 @@ maxLength(): number #### Source -[lib/provable/string.ts:75](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L75) +[lib/provable/string.ts:75](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L75) *** @@ -605,7 +605,7 @@ substring(start: number, end: number): CircuitString #### Source -[lib/provable/string.ts:147](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L147) +[lib/provable/string.ts:147](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L147) *** @@ -621,7 +621,7 @@ toString(): string #### Source -[lib/provable/string.ts:151](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L151) +[lib/provable/string.ts:151](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L151) *** @@ -641,7 +641,7 @@ static fromCharacters(chars: Character[]): CircuitString #### Source -[lib/provable/string.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L71) +[lib/provable/string.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L71) *** @@ -661,7 +661,7 @@ static fromString(str: string): CircuitString #### Source -[lib/provable/string.ts:155](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/string.ts#L155) +[lib/provable/string.ts:155](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/string.ts#L155) *** @@ -685,4 +685,4 @@ A `number` representing the size of the `T` type in terms of [Field](Field.mdx) #### Source -[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L56) +[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L56) diff --git a/docs/zkapps/o1js-reference/classes/DynamicProof.mdx b/docs/zkapps/o1js-reference/classes/DynamicProof.mdx index 0f8646e81..a845ef38d 100644 --- a/docs/zkapps/o1js-reference/classes/DynamicProof.mdx +++ b/docs/zkapps/o1js-reference/classes/DynamicProof.mdx @@ -27,7 +27,7 @@ This pattern differs a lot from the usage of normal `Proof`, where the verificat src/examples/zkprogram/dynamic-keys-merkletree.ts for an example of how this can be done using merkle trees -Assertions generally only happen using the vk hash that is part of the `VerificationKey` struct along with the raw vk data as auxilary data. +Assertions generally only happen using the vk hash that is part of the `VerificationKey` struct along with the raw vk data as auxiliary data. When using verify() on a `DynamicProof`, Pickles makes sure that the verification key data matches the hash. Therefore all manual assertions have to be made on the vk's hash and it can be assumed that the vk's data is checked to match the hash if it is used with verify(). @@ -76,7 +76,7 @@ new DynamicProof(__namedParameters: { #### Source -[lib/proof-system/zkprogram.ts:111](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L111) +[lib/proof-system/zkprogram.ts:233](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L233) ## Properties @@ -92,7 +92,7 @@ maxProofsVerified: 0 | 1 | 2; #### Source -[lib/proof-system/zkprogram.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L98) +[lib/proof-system/zkprogram.ts:220](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L220) *** @@ -108,7 +108,7 @@ proof: unknown; #### Source -[lib/proof-system/zkprogram.ts:97](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L97) +[lib/proof-system/zkprogram.ts:219](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L219) *** @@ -124,7 +124,7 @@ publicInput: Input; #### Source -[lib/proof-system/zkprogram.ts:95](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L95) +[lib/proof-system/zkprogram.ts:217](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L217) *** @@ -140,7 +140,7 @@ publicOutput: Output; #### Source -[lib/proof-system/zkprogram.ts:96](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L96) +[lib/proof-system/zkprogram.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L218) *** @@ -156,7 +156,7 @@ shouldVerify: Bool; #### Source -[lib/proof-system/zkprogram.ts:99](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L99) +[lib/proof-system/zkprogram.ts:221](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L221) *** @@ -168,7 +168,32 @@ optional usedVerificationKey: VerificationKey; #### Source -[lib/proof-system/zkprogram.ts:250](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L250) +[lib/proof-system/zkprogram.ts:388](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L388) + +*** + +### featureFlags + +```ts +static featureFlags: FeatureFlags = FeatureFlags.allNone; +``` + +As the name indicates, feature flags are features of the proof system. + +If we want to side load proofs and verification keys, we first have to tell Pickles what _shape_ of proofs it should expect. + +For example, if we want to side load proofs that use foreign field arithmetic custom gates, we have to make Pickles aware of that by defining +these custom gates. + +_Note:_ Only proofs that use the exact same composition of custom gates which were expected by Pickles can be verified using side loading. +If you want to verify _any_ proof, no matter what custom gates it uses, you can use FeatureFlags.allMaybe. Please note that this might incur a significant overhead. + +You can also toggle specific feature flags manually by specifying them here. +Alternatively, you can use {@FeatureFlags.fromZkProgram} to compute the set of feature flags that are compatible with a given program. + +#### Source + +[lib/proof-system/zkprogram.ts:375](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L375) *** @@ -180,7 +205,7 @@ static maxProofsVerified: 0 | 1 | 2; #### Source -[lib/proof-system/zkprogram.ts:235](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L235) +[lib/proof-system/zkprogram.ts:357](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L357) *** @@ -196,7 +221,7 @@ static publicInputType: FlexibleProvablePure; #### Source -[lib/proof-system/zkprogram.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L87) +[lib/proof-system/zkprogram.ts:209](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L209) *** @@ -212,7 +237,7 @@ static publicOutputType: FlexibleProvablePure; #### Source -[lib/proof-system/zkprogram.ts:88](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L88) +[lib/proof-system/zkprogram.ts:210](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L210) ## Methods @@ -232,7 +257,7 @@ toJSON(): JsonProof #### Source -[lib/proof-system/zkprogram.ts:101](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L101) +[lib/proof-system/zkprogram.ts:223](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L223) *** @@ -256,7 +281,7 @@ The verification key this proof will be verified against #### Source -[lib/proof-system/zkprogram.ts:256](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L256) +[lib/proof-system/zkprogram.ts:394](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L394) *** @@ -278,7 +303,7 @@ verifyIf(vk: VerificationKey, condition: Bool): void #### Source -[lib/proof-system/zkprogram.ts:260](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L260) +[lib/proof-system/zkprogram.ts:398](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L398) *** @@ -315,7 +340,7 @@ domainLog2: number): Promise> #### Source -[lib/proof-system/zkprogram.ts:292](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L292) +[lib/proof-system/zkprogram.ts:430](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L430) *** @@ -341,7 +366,7 @@ static fromJSON(this: S, __namedParameters: JsonProof): Promise; @@ -76,11 +87,11 @@ static optional _provable: ProvablePureExtended @@ -128,17 +142,20 @@ get static provable(): ProvablePureExtended #### Source -[lib/provable/crypto/foreign-ecdsa.ts:180](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L180) +[lib/provable/crypto/foreign-ecdsa.ts:213](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L213) ## Methods -### toBigInt() +### ~~toBigInt()~~ ```ts toBigInt(): { @@ -158,13 +175,13 @@ Convert this signature to an object with bigint fields. } ``` -##### r +##### ~~r~~ ```ts r: bigint; ``` -##### s +##### ~~s~~ ```ts s: bigint; @@ -172,16 +189,96 @@ s: bigint; #### Source -[lib/provable/crypto/foreign-ecdsa.ts:65](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L65) +[lib/provable/crypto/foreign-ecdsa.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L71) *** -### verify() +### ~~verify()~~ ```ts verify(message: Bytes, publicKey: FlexiblePoint): Bool ``` +#### Parameters + +• **message**: `Bytes` + +• **publicKey**: `FlexiblePoint` + +#### Returns + +[`Bool`](Bool.mdx) + +#### Deprecated + +There is a security vulnerability in this method. Use [verifyV2](EcdsaSignature.mdx#verifyv2) instead. + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:78](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L78) + +*** + +### ~~verifySignedHash()~~ + +```ts +verifySignedHash(msgHash: bigint | AlmostForeignField, publicKey: FlexiblePoint): Bool +``` + +#### Parameters + +• **msgHash**: `bigint` \| [`AlmostForeignField`](AlmostForeignField.mdx) + +• **publicKey**: `FlexiblePoint` + +#### Returns + +[`Bool`](Bool.mdx) + +#### Deprecated + +There is a security vulnerability in this method. Use [verifySignedHashV2](EcdsaSignature.mdx#verifysignedhashv2) instead. + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:127](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L127) + +*** + +### ~~verifySignedHashV2()~~ + +```ts +verifySignedHashV2(msgHash: bigint | AlmostForeignField, publicKey: FlexiblePoint): Bool +``` + +Verify the ECDSA signature given the message hash (a [Scalar](Scalar.mdx)) and public key (a [Curve](EcdsaSignature.mdx#curve) point). + +This is a building block of [EcdsaSignature.verify](EcdsaSignature.mdx#verify), where the input message is also hashed. +In contrast, this method just takes the message hash (a curve scalar) as input, giving you flexibility in +choosing the hashing algorithm. + +#### Parameters + +• **msgHash**: `bigint` \| [`AlmostForeignField`](AlmostForeignField.mdx) + +• **publicKey**: `FlexiblePoint` + +#### Returns + +[`Bool`](Bool.mdx) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L148) + +*** + +### ~~verifyV2()~~ + +```ts +verifyV2(message: Bytes, publicKey: FlexiblePoint): Bool +``` + Verify the ECDSA signature given the message (an array of bytes) and public key (a [Curve](EcdsaSignature.mdx#curve) point). **Important:** This method returns a [Bool](Bool.mdx) which indicates whether the signature is valid. @@ -230,39 +327,11 @@ isValid.assertTrue('signature verifies'); #### Source -[lib/provable/crypto/foreign-ecdsa.ts:103](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L103) - -*** - -### verifySignedHash() - -```ts -verifySignedHash(msgHash: bigint | AlmostForeignField, publicKey: FlexiblePoint): Bool -``` - -Verify the ECDSA signature given the message hash (a [Scalar](Scalar.mdx)) and public key (a [Curve](EcdsaSignature.mdx#curve) point). - -This is a building block of [EcdsaSignature.verify](EcdsaSignature.mdx#verify), where the input message is also hashed. -In contrast, this method just takes the message hash (a curve scalar) as input, giving you flexibility in -choosing the hashing algorithm. - -#### Parameters - -• **msgHash**: `bigint` \| [`AlmostForeignField`](AlmostForeignField.mdx) - -• **publicKey**: `FlexiblePoint` - -#### Returns - -[`Bool`](Bool.mdx) - -#### Source - -[lib/provable/crypto/foreign-ecdsa.ts:116](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L116) +[lib/provable/crypto/foreign-ecdsa.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L118) *** -### check() +### ~~check()~~ ```ts static check(signature: EcdsaSignature): void @@ -278,11 +347,11 @@ static check(signature: EcdsaSignature): void #### Source -[lib/provable/crypto/foreign-ecdsa.ts:155](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L155) +[lib/provable/crypto/foreign-ecdsa.ts:187](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L187) *** -### from() +### ~~from()~~ ```ts static from(signature: FlexibleSignature): EcdsaSignature @@ -300,11 +369,11 @@ Coerce the input to a [EcdsaSignature](EcdsaSignature.mdx). #### Source -[lib/provable/crypto/foreign-ecdsa.ts:48](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L48) +[lib/provable/crypto/foreign-ecdsa.ts:54](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L54) *** -### fromHex() +### ~~fromHex()~~ ```ts static fromHex(rawSignature: string): EcdsaSignature @@ -323,11 +392,11 @@ Create an [EcdsaSignature](EcdsaSignature.mdx) from a raw 130-char hex string as #### Source -[lib/provable/crypto/foreign-ecdsa.ts:57](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L57) +[lib/provable/crypto/foreign-ecdsa.ts:63](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L63) *** -### sign() +### ~~sign()~~ ```ts static sign(message: Uint8Array | (number | bigint)[], privateKey: bigint): EcdsaSignature @@ -349,11 +418,11 @@ Note: This method is not provable, and only takes JS bigints as input. #### Source -[lib/provable/crypto/foreign-ecdsa.ts:135](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L135) +[lib/provable/crypto/foreign-ecdsa.ts:167](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L167) *** -### signHash() +### ~~signHash()~~ ```ts static signHash(msgHash: bigint, privateKey: bigint): EcdsaSignature @@ -379,4 +448,4 @@ Note: This method is not provable, and only takes JS bigints as input. #### Source -[lib/provable/crypto/foreign-ecdsa.ts:150](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L150) +[lib/provable/crypto/foreign-ecdsa.ts:182](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L182) diff --git a/docs/zkapps/o1js-reference/classes/EcdsaSignatureV2.mdx b/docs/zkapps/o1js-reference/classes/EcdsaSignatureV2.mdx new file mode 100644 index 000000000..59a4f3e84 --- /dev/null +++ b/docs/zkapps/o1js-reference/classes/EcdsaSignatureV2.mdx @@ -0,0 +1,509 @@ +## Deprecated + +`EcdsaSignature` is now deprecated and will be removed in a future release. Please use [EcdsaSignatureV2](EcdsaSignatureV2.mdx) instead. + +## Extends + +- [`EcdsaSignature`](EcdsaSignature.mdx) + +## Constructors + +### new EcdsaSignatureV2() + +```ts +new EcdsaSignatureV2(signature: { + "r": number | bigint | Field3 | AlmostForeignField; + "s": number | bigint | Field3 | AlmostForeignField; + }): EcdsaSignatureV2 +``` + +#### Parameters + +• **signature** + +• **signature.r**: `number` \| `bigint` \| `Field3` \| [`AlmostForeignField`](AlmostForeignField.mdx) + +• **signature.s**: `number` \| `bigint` \| `Field3` \| [`AlmostForeignField`](AlmostForeignField.mdx) + +#### Returns + +[`EcdsaSignatureV2`](EcdsaSignatureV2.mdx) + +#### Overrides + +[`EcdsaSignature`](EcdsaSignature.mdx).[`constructor`](EcdsaSignature.mdx#constructors) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:220](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L220) + +## Properties + +### ~~r~~ + +```ts +r: AlmostForeignField; +``` + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`r`](EcdsaSignature.mdx#r) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:36](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L36) + +*** + +### ~~s~~ + +```ts +s: AlmostForeignField; +``` + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`s`](EcdsaSignature.mdx#s) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L37) + +*** + +### ~~\_Curve?~~ + +```ts +static optional _Curve: typeof ForeignCurve; +``` + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`_Curve`](EcdsaSignature.mdx#_curve) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:196](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L196) + +*** + +### ~~\_provable?~~ + +```ts +static optional _provable: ProvablePureExtended; +``` + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`_provable`](EcdsaSignature.mdx#_provable) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:197](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L197) + +## Accessors + +### ~~Constructor~~ + +```ts +get Constructor(): typeof EcdsaSignature +``` + +#### Returns + +*typeof* [`EcdsaSignature`](EcdsaSignature.mdx) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:193](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L193) + +*** + +### ~~Curve~~ + +```ts +get static Curve(): typeof ForeignCurve +``` + +The [ForeignCurve](ForeignCurve.mdx) on which the ECDSA signature is defined. + +#### Returns + +*typeof* [`ForeignCurve`](ForeignCurve.mdx) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:206](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L206) + +*** + +### ~~provable~~ + +```ts +get static provable(): ProvablePureExtended +``` + +`Provable` + +#### Returns + +`ProvablePureExtended`\<[`EcdsaSignature`](EcdsaSignature.mdx), \{ + `"r"`: `bigint`; + `"s"`: `bigint`; + \}, \{ + `"r"`: `string`; + `"s"`: `string`; + \}\> + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:213](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L213) + +## Methods + +### ~~toBigInt()~~ + +```ts +toBigInt(): { + "r": bigint; + "s": bigint; +} +``` + +Convert this signature to an object with bigint fields. + +#### Returns + +```ts +{ + "r": bigint; + "s": bigint; +} +``` + +##### ~~r~~ + +```ts +r: bigint; +``` + +##### ~~s~~ + +```ts +s: bigint; +``` + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`toBigInt`](EcdsaSignature.mdx#tobigint) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L71) + +*** + +### ~~verify()~~ + +```ts +verify(message: Bytes, publicKey: FlexiblePoint): Bool +``` + +#### Parameters + +• **message**: `Bytes` + +• **publicKey**: `FlexiblePoint` + +#### Returns + +[`Bool`](Bool.mdx) + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`verify`](EcdsaSignature.mdx#verify) + +#### Deprecated + +There is a security vulnerability in this method. Use [verifyV2](EcdsaSignature.mdx#verifyv2) instead. + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:78](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L78) + +*** + +### ~~verifySignedHash()~~ + +```ts +verifySignedHash(msgHash: bigint | AlmostForeignField, publicKey: FlexiblePoint): Bool +``` + +#### Parameters + +• **msgHash**: `bigint` \| [`AlmostForeignField`](AlmostForeignField.mdx) + +• **publicKey**: `FlexiblePoint` + +#### Returns + +[`Bool`](Bool.mdx) + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`verifySignedHash`](EcdsaSignature.mdx#verifysignedhash) + +#### Deprecated + +There is a security vulnerability in this method. Use [verifySignedHashV2](EcdsaSignature.mdx#verifysignedhashv2) instead. + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:127](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L127) + +*** + +### ~~verifySignedHashV2()~~ + +```ts +verifySignedHashV2(msgHash: bigint | AlmostForeignField, publicKey: FlexiblePoint): Bool +``` + +Verify the ECDSA signature given the message hash (a [Scalar](Scalar.mdx)) and public key (a [Curve](EcdsaSignature.mdx#curve) point). + +This is a building block of [EcdsaSignature.verify](EcdsaSignature.mdx#verify), where the input message is also hashed. +In contrast, this method just takes the message hash (a curve scalar) as input, giving you flexibility in +choosing the hashing algorithm. + +#### Parameters + +• **msgHash**: `bigint` \| [`AlmostForeignField`](AlmostForeignField.mdx) + +• **publicKey**: `FlexiblePoint` + +#### Returns + +[`Bool`](Bool.mdx) + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`verifySignedHashV2`](EcdsaSignature.mdx#verifysignedhashv2) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L148) + +*** + +### ~~verifyV2()~~ + +```ts +verifyV2(message: Bytes, publicKey: FlexiblePoint): Bool +``` + +Verify the ECDSA signature given the message (an array of bytes) and public key (a [Curve](EcdsaSignature.mdx#curve) point). + +**Important:** This method returns a [Bool](Bool.mdx) which indicates whether the signature is valid. +So, to actually prove validity of a signature, you need to assert that the result is true. + +#### Parameters + +• **message**: `Bytes` + +• **publicKey**: `FlexiblePoint` + +#### Returns + +[`Bool`](Bool.mdx) + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`verifyV2`](EcdsaSignature.mdx#verifyv2) + +#### Throws + +if one of the signature scalars is zero or if the public key is not on the curve. + +#### Example + +```ts +// create classes for your curve +class Secp256k1 extends createForeignCurve(Crypto.CurveParams.Secp256k1) {} +class Scalar extends Secp256k1.Scalar {} +class Ecdsa extends createEcdsa(Secp256k1) {} + +let message = 'my message'; +let messageBytes = new TextEncoder().encode(message); + +// outside provable code: create inputs +let privateKey = Scalar.random(); +let publicKey = Secp256k1.generator.scale(privateKey); +let signature = Ecdsa.sign(messageBytes, privateKey.toBigInt()); + +// ... +// in provable code: create input witnesses (or use method inputs, or constants) +let pk = Provable.witness(Secp256k1.provable, () => publicKey); +let msg = Provable.witness(Provable.Array(Field, 9), () => messageBytes.map(Field)); +let sig = Provable.witness(Ecdsa.provable, () => signature); + +// verify signature +let isValid = sig.verify(msg, pk); +isValid.assertTrue('signature verifies'); +``` + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L118) + +*** + +### ~~check()~~ + +```ts +static check(signature: EcdsaSignatureV2): void +``` + +#### Parameters + +• **signature**: [`EcdsaSignatureV2`](EcdsaSignatureV2.mdx) + +#### Returns + +`void` + +#### Overrides + +[`EcdsaSignature`](EcdsaSignature.mdx).[`check`](EcdsaSignature.mdx#check) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:227](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L227) + +*** + +### ~~from()~~ + +```ts +static from(signature: FlexibleSignature): EcdsaSignature +``` + +Coerce the input to a [EcdsaSignature](EcdsaSignature.mdx). + +#### Parameters + +• **signature**: `FlexibleSignature` + +#### Returns + +[`EcdsaSignature`](EcdsaSignature.mdx) + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`from`](EcdsaSignature.mdx#from) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:54](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L54) + +*** + +### ~~fromHex()~~ + +```ts +static fromHex(rawSignature: string): EcdsaSignature +``` + +Create an [EcdsaSignature](EcdsaSignature.mdx) from a raw 130-char hex string as used in +[Ethereum transactions](https://ethereum.org/en/developers/docs/transactions/#typed-transaction-envelope). + +#### Parameters + +• **rawSignature**: `string` + +#### Returns + +[`EcdsaSignature`](EcdsaSignature.mdx) + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`fromHex`](EcdsaSignature.mdx#fromhex) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:63](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L63) + +*** + +### ~~sign()~~ + +```ts +static sign(message: Uint8Array | (number | bigint)[], privateKey: bigint): EcdsaSignature +``` + +Create an [EcdsaSignature](EcdsaSignature.mdx) by signing a message with a private key. + +Note: This method is not provable, and only takes JS bigints as input. + +#### Parameters + +• **message**: `Uint8Array` \| (`number` \| `bigint`)[] + +• **privateKey**: `bigint` + +#### Returns + +[`EcdsaSignature`](EcdsaSignature.mdx) + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`sign`](EcdsaSignature.mdx#sign) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:167](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L167) + +*** + +### ~~signHash()~~ + +```ts +static signHash(msgHash: bigint, privateKey: bigint): EcdsaSignature +``` + +Create an [EcdsaSignature](EcdsaSignature.mdx) by signing a message hash with a private key. + +This is a building block of [EcdsaSignature.sign](EcdsaSignature.mdx#sign), where the input message is also hashed. +In contrast, this method just takes the message hash (a curve scalar) as input, giving you flexibility in +choosing the hashing algorithm. + +Note: This method is not provable, and only takes JS bigints as input. + +#### Parameters + +• **msgHash**: `bigint` + +• **privateKey**: `bigint` + +#### Returns + +[`EcdsaSignature`](EcdsaSignature.mdx) + +#### Inherited from + +[`EcdsaSignature`](EcdsaSignature.mdx).[`signHash`](EcdsaSignature.mdx#signhash) + +#### Source + +[lib/provable/crypto/foreign-ecdsa.ts:182](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L182) diff --git a/docs/zkapps/o1js-reference/classes/Field.mdx b/docs/zkapps/o1js-reference/classes/Field.mdx index 444768d4a..0dd2a20d3 100644 --- a/docs/zkapps/o1js-reference/classes/Field.mdx +++ b/docs/zkapps/o1js-reference/classes/Field.mdx @@ -66,7 +66,7 @@ Coerce anything "field-like" (bigint, number, string, and [Field](Field.mdx)) to #### Source -[lib/provable/field.ts:97](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L97) +[lib/provable/field.ts:97](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L97) ## Properties @@ -78,7 +78,7 @@ value: FieldVar; #### Source -[lib/provable/field.ts:86](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L86) +[lib/provable/field.ts:86](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L86) *** @@ -93,7 +93,7 @@ Order of the [Field](Field.mdx) is 289480223093290488558927462521719769633630564 #### Source -[lib/provable/field.ts:92](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L92) +[lib/provable/field.ts:92](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L92) *** @@ -107,7 +107,7 @@ The size of a [Field](Field.mdx) element in bits - 255. #### Source -[lib/provable/field.ts:1127](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1127) +[lib/provable/field.ts:1127](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1127) *** @@ -121,7 +121,7 @@ The size of a [Field](Field.mdx) element in bytes - 32. #### Source -[lib/provable/field.ts:1122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1122) +[lib/provable/field.ts:1122](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1122) ## Methods @@ -169,7 +169,7 @@ sum.sub(Field(-7)).assertEquals(x); #### Source -[lib/provable/field.ts:250](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L250) +[lib/provable/field.ts:250](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L250) *** @@ -194,7 +194,7 @@ If the assertion fails, the code throws an error. #### Source -[lib/provable/field.ts:780](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L780) +[lib/provable/field.ts:780](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L780) *** @@ -222,7 +222,7 @@ See [Field.equals](Field.mdx#equals) for more details. #### Source -[lib/provable/field.ts:208](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L208) +[lib/provable/field.ts:208](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L208) *** @@ -251,7 +251,7 @@ See [Field.greaterThan](Field.mdx#greaterthan) for more details. #### Source -[lib/provable/field.ts:714](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L714) +[lib/provable/field.ts:714](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L714) *** @@ -280,7 +280,7 @@ See [Field.greaterThanOrEqual](Field.mdx#greaterthanorequal) for more details. #### Source -[lib/provable/field.ts:729](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L729) +[lib/provable/field.ts:729](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L729) *** @@ -293,7 +293,7 @@ assertLessThan(y: string | number | bigint | Field, message?: string): void Assert that this [Field](Field.mdx) is less than another "field-like" value. Note: This uses fewer constraints than `x.lessThan(y).assertTrue()`. -See [Field.lessThan](Field.mdx#lessthan) for more details. +See [lessThan](Field.mdx#lessthan) for more details. **Important**: If an assertion fails, the code throws an error. @@ -309,7 +309,7 @@ See [Field.lessThan](Field.mdx#lessthan) for more details. #### Source -[lib/provable/field.ts:664](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L664) +[lib/provable/field.ts:664](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L664) *** @@ -338,7 +338,7 @@ See [Field.lessThanOrEqual](Field.mdx#lessthanorequal) for more details. #### Source -[lib/provable/field.ts:689](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L689) +[lib/provable/field.ts:689](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L689) *** @@ -370,7 +370,7 @@ x.assertNotEquals(0, "expect x to be non-zero"); #### Source -[lib/provable/field.ts:746](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L746) +[lib/provable/field.ts:746](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L746) *** @@ -421,7 +421,7 @@ quotient.mul(y).assertEquals(x); #### Source -[lib/provable/field.ts:442](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L442) +[lib/provable/field.ts:442](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L442) *** @@ -452,7 +452,7 @@ Field(5).equals(5).assertEquals(Bool(true)); #### Source -[lib/provable/field.ts:522](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L522) +[lib/provable/field.ts:522](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L522) *** @@ -491,7 +491,7 @@ let isFalse = Field(1).div(2).greaterThan(Field(1).div(3); // in fact, 1/3 > 1/2 #### Source -[lib/provable/field.ts:625](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L625) +[lib/provable/field.ts:625](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L625) *** @@ -530,7 +530,7 @@ let isFalse = Field(1).div(2).greaterThanOrEqual(Field(1).div(3); // in fact, 1/ #### Source -[lib/provable/field.ts:649](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L649) +[lib/provable/field.ts:649](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L649) *** @@ -556,14 +556,14 @@ A [Field](Field.mdx) element that is equivalent to one divided by this element. ```ts const someField = Field(42); const inverse = someField.inv(); -inverse.assertEquals(Field(1).div(example)); // This statement is always true regardless of the value of `someField` +inverse.assertEquals(Field(1).div(someField)); // This statement is always true regardless of the value of `someField` ``` **Warning**: This is a modular inverse. See [div](Field.mdx#div) method for more details. #### Source -[lib/provable/field.ts:396](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L396) +[lib/provable/field.ts:396](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L396) *** @@ -598,7 +598,7 @@ console.log(Field(42).isConstant()); // true #### Source -[lib/provable/field.ts:142](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L142) +[lib/provable/field.ts:142](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L142) *** @@ -626,7 +626,7 @@ b.isEven(); // true #### Source -[lib/provable/field.ts:339](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L339) +[lib/provable/field.ts:339](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L339) *** @@ -646,7 +646,7 @@ See [Field.isEven](Field.mdx#iseven) for examples. #### Source -[lib/provable/field.ts:323](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L323) +[lib/provable/field.ts:323](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L323) *** @@ -685,7 +685,7 @@ let isFalse = Field(1).div(3).lessThan(Field(1).div(2)); // in fact, 1/3 > 1/2 #### Source -[lib/provable/field.ts:571](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L571) +[lib/provable/field.ts:571](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L571) *** @@ -724,7 +724,7 @@ let isFalse = Field(1).div(3).lessThanOrEqual(Field(1).div(2)); // in fact, 1/3 #### Source -[lib/provable/field.ts:598](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L598) +[lib/provable/field.ts:598](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L598) *** @@ -757,7 +757,7 @@ product.assertEquals(Field(15)); #### Source -[lib/provable/field.ts:358](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L358) +[lib/provable/field.ts:358](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L358) *** @@ -793,7 +793,7 @@ someField.neg().assertEquals(someField.mul(Field(-1))); // This statement is alw #### Source -[lib/provable/field.ts:278](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L278) +[lib/provable/field.ts:278](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L278) *** @@ -819,7 +819,7 @@ A [Field](Field.mdx) element that is equal to the result of AST that was previou #### Source -[lib/provable/field.ts:872](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L872) +[lib/provable/field.ts:872](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L872) *** @@ -852,7 +852,7 @@ Therefore, this method leaves an adversarial prover the choice between two diffe #### Source -[lib/provable/field.ts:492](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L492) +[lib/provable/field.ts:492](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L492) *** @@ -883,7 +883,7 @@ square.assertEquals(someField.mul(someField)); // This statement is always true #### Source -[lib/provable/field.ts:463](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L463) +[lib/provable/field.ts:463](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L463) *** @@ -929,7 +929,7 @@ difference.add(Field(2)).assertEquals(x); #### Source -[lib/provable/field.ts:314](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L314) +[lib/provable/field.ts:314](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L314) *** @@ -949,7 +949,7 @@ As the primitive [Field](Field.mdx) type has no auxiliary data associated with i #### Source -[lib/provable/field.ts:1005](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1005) +[lib/provable/field.ts:1005](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1005) *** @@ -978,7 +978,7 @@ console.log(someField.toBigInt()); #### Source -[lib/provable/field.ts:176](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L176) +[lib/provable/field.ts:176](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L176) *** @@ -1010,7 +1010,7 @@ An array of [Bool](Bool.mdx) element representing little endian binary represent #### Source -[lib/provable/field.ts:810](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L810) +[lib/provable/field.ts:810](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L810) *** @@ -1039,7 +1039,7 @@ someField.toConstant().assertEquals(someField); // Always true #### Source -[lib/provable/field.ts:159](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L159) +[lib/provable/field.ts:159](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L159) *** @@ -1061,7 +1061,7 @@ A [Field](Field.mdx) array of length 1 created from this [Field](Field.mdx). #### Source -[lib/provable/field.ts:996](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L996) +[lib/provable/field.ts:996](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L996) *** @@ -1090,7 +1090,7 @@ console.log(someField.toJSON()); #### Source -[lib/provable/field.ts:1028](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1028) +[lib/provable/field.ts:1028](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1028) *** @@ -1119,7 +1119,7 @@ console.log(someField.toString()); #### Source -[lib/provable/field.ts:194](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L194) +[lib/provable/field.ts:194](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L194) *** @@ -1139,7 +1139,7 @@ As any field element can be a [Field](Field.mdx), this function does not create #### Source -[lib/provable/field.ts:966](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L966) +[lib/provable/field.ts:966](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L966) *** @@ -1155,7 +1155,7 @@ static empty(): Field #### Source -[lib/provable/field.ts:1011](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1011) +[lib/provable/field.ts:1011](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1011) *** @@ -1175,7 +1175,7 @@ static from(x: string | number | bigint | Field): Field #### Source -[lib/provable/field.ts:119](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L119) +[lib/provable/field.ts:119](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L119) *** @@ -1203,7 +1203,7 @@ A [Field](Field.mdx) element matching the [little endian binary representation]( #### Source -[lib/provable/field.ts:843](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L843) +[lib/provable/field.ts:843](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L843) *** @@ -1232,7 +1232,7 @@ A new [Field](Field.mdx) element created using the [little-endian](https://en.wi #### Source -[lib/provable/field.ts:1115](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1115) +[lib/provable/field.ts:1115](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1115) *** @@ -1262,7 +1262,7 @@ The first [Field](Field.mdx) element of the given array. #### Source -[lib/provable/field.ts:955](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L955) +[lib/provable/field.ts:955](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L955) *** @@ -1288,7 +1288,7 @@ A [Field](Field.mdx) coerced from the given JSON string. #### Source -[lib/provable/field.ts:1060](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1060) +[lib/provable/field.ts:1060](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1060) *** @@ -1310,7 +1310,7 @@ static fromValue(x: string | number | bigint | Field): Field #### Source -[lib/provable/field.ts:985](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L985) +[lib/provable/field.ts:985](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L985) *** @@ -1336,7 +1336,7 @@ console.log(Field.random().toBigInt()); // Run this code twice! #### Source -[lib/provable/field.ts:894](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L894) +[lib/provable/field.ts:894](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L894) *** @@ -1366,7 +1366,7 @@ Part of the `Binable` interface. #### Source -[lib/provable/field.ts:1098](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1098) +[lib/provable/field.ts:1098](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1098) *** @@ -1395,7 +1395,7 @@ console.log(Field.sizeInFields()); // Prints 1 #### Source -[lib/provable/field.ts:940](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L940) +[lib/provable/field.ts:940](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L940) *** @@ -1415,7 +1415,7 @@ As the primitive [Field](Field.mdx) type has no auxiliary data associated with i #### Source -[lib/provable/field.ts:923](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L923) +[lib/provable/field.ts:923](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L923) *** @@ -1437,7 +1437,7 @@ Convert a [Field](Field.mdx) element to a bigint. #### Source -[lib/provable/field.ts:978](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L978) +[lib/provable/field.ts:978](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L978) *** @@ -1462,7 +1462,7 @@ An array of digits equal to the [little-endian](https://en.wikipedia.org/wiki/En #### Source -[lib/provable/field.ts:1089](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1089) +[lib/provable/field.ts:1089](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1089) *** @@ -1489,7 +1489,7 @@ A [Field](Field.mdx) array of length 1 created from this [Field](Field.mdx). #### Source -[lib/provable/field.ts:912](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L912) +[lib/provable/field.ts:912](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L912) *** @@ -1527,7 +1527,7 @@ fields: Field[]; #### Source -[lib/provable/field.ts:1074](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1074) +[lib/provable/field.ts:1074](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1074) *** @@ -1560,7 +1560,7 @@ console.log(Field.toJSON(someField)); #### Source -[lib/provable/field.ts:1047](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1047) +[lib/provable/field.ts:1047](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1047) *** @@ -1582,4 +1582,4 @@ static toValue(x: Field): bigint #### Source -[lib/provable/field.ts:971](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L971) +[lib/provable/field.ts:971](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L971) diff --git a/docs/zkapps/o1js-reference/classes/ForeignCurve.mdx b/docs/zkapps/o1js-reference/classes/ForeignCurve.mdx index 4afbc767d..88ab88172 100644 --- a/docs/zkapps/o1js-reference/classes/ForeignCurve.mdx +++ b/docs/zkapps/o1js-reference/classes/ForeignCurve.mdx @@ -1,3 +1,11 @@ +## Deprecated + +`ForeignCurve` is now deprecated and will be removed in a future release. Please use [ForeignCurveV2](ForeignCurveV2.mdx) instead. + +## Extended by + +- [`ForeignCurveV2`](ForeignCurveV2.mdx) + ## Constructors ### new ForeignCurve() @@ -35,11 +43,11 @@ let x = new ForeignCurve({ x: 1n, y: 1n }); #### Source -[lib/provable/crypto/foreign-curve.ts:45](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L45) +[lib/provable/crypto/foreign-curve.ts:54](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L54) ## Properties -### x +### ~~x~~ ```ts x: AlmostForeignField; @@ -47,11 +55,11 @@ x: AlmostForeignField; #### Source -[lib/provable/crypto/foreign-curve.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L30) +[lib/provable/crypto/foreign-curve.ts:39](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L39) *** -### y +### ~~y~~ ```ts y: AlmostForeignField; @@ -59,11 +67,11 @@ y: AlmostForeignField; #### Source -[lib/provable/crypto/foreign-curve.ts:31](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L31) +[lib/provable/crypto/foreign-curve.ts:40](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L40) *** -### \_Bigint? +### ~~\_Bigint?~~ ```ts static optional _Bigint: {}; @@ -71,11 +79,11 @@ static optional _Bigint: {}; #### Source -[lib/provable/crypto/foreign-curve.ts:240](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L240) +[lib/provable/crypto/foreign-curve.ts:249](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L249) *** -### \_Field? +### ~~\_Field?~~ ```ts static optional _Field: typeof AlmostForeignField; @@ -83,11 +91,11 @@ static optional _Field: typeof AlmostForeignField; #### Source -[lib/provable/crypto/foreign-curve.ts:241](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L241) +[lib/provable/crypto/foreign-curve.ts:250](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L250) *** -### \_Scalar? +### ~~\_Scalar?~~ ```ts static optional _Scalar: typeof AlmostForeignField; @@ -95,14 +103,17 @@ static optional _Scalar: typeof AlmostForeignField; #### Source -[lib/provable/crypto/foreign-curve.ts:242](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L242) +[lib/provable/crypto/foreign-curve.ts:251](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L251) *** -### \_provable? +### ~~\_provable?~~ ```ts static optional _provable: ProvablePureExtended; @@ -110,11 +121,11 @@ static optional _provable: ProvablePureExtended @@ -254,17 +268,20 @@ get static provable(): ProvablePureExtended #### Source -[lib/provable/crypto/foreign-curve.ts:272](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L272) +[lib/provable/crypto/foreign-curve.ts:282](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L282) ## Methods -### add() +### ~~add()~~ ```ts add(h: ForeignCurve | FlexiblePoint): ForeignCurve @@ -298,11 +315,11 @@ if the inputs are inverses of each other. #### Source -[lib/provable/crypto/foreign-curve.ts:121](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L121) +[lib/provable/crypto/foreign-curve.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L130) *** -### addSafe() +### ~~addSafe()~~ ```ts addSafe(h: ForeignCurve | FlexiblePoint): ForeignCurve @@ -330,11 +347,11 @@ if the inputs are equal or inverses of each other. #### Source -[lib/provable/crypto/foreign-curve.ts:139](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L139) +[lib/provable/crypto/foreign-curve.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L148) *** -### assertInSubgroup() +### ~~assertInSubgroup()~~ ```ts assertInSubgroup(): void @@ -351,11 +368,11 @@ it performs the full scalar multiplication `order*P` and is expensive. #### Source -[lib/provable/crypto/foreign-curve.ts:219](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L219) +[lib/provable/crypto/foreign-curve.ts:228](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L228) *** -### assertOnCurve() +### ~~assertOnCurve()~~ ```ts assertOnCurve(): void @@ -370,11 +387,11 @@ Assert that this point lies on the elliptic curve, which means it satisfies the #### Source -[lib/provable/crypto/foreign-curve.ts:203](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L203) +[lib/provable/crypto/foreign-curve.ts:212](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L212) *** -### double() +### ~~double()~~ ```ts double(): ForeignCurve @@ -394,11 +411,11 @@ let r = p.double(); // r = 2 * p #### Source -[lib/provable/crypto/foreign-curve.ts:158](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L158) +[lib/provable/crypto/foreign-curve.ts:167](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L167) *** -### isConstant() +### ~~isConstant()~~ ```ts isConstant(): boolean @@ -414,11 +431,11 @@ See FieldVar to understand constants vs variables. #### Source -[lib/provable/crypto/foreign-curve.ts:90](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L90) +[lib/provable/crypto/foreign-curve.ts:99](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L99) *** -### negate() +### ~~negate()~~ ```ts negate(): ForeignCurve @@ -438,11 +455,11 @@ let r = p.negate(); // r = -p #### Source -[lib/provable/crypto/foreign-curve.ts:172](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L172) +[lib/provable/crypto/foreign-curve.ts:181](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L181) *** -### scale() +### ~~scale()~~ ```ts scale(scalar: number | bigint | AlmostForeignField): ForeignCurve @@ -472,11 +489,11 @@ let r = p.scale(s); // r = s * p #### Source -[lib/provable/crypto/foreign-curve.ts:188](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L188) +[lib/provable/crypto/foreign-curve.ts:197](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L197) *** -### toBigint() +### ~~toBigint()~~ ```ts toBigint(): GroupAffine @@ -490,11 +507,11 @@ Convert this curve point to a point with bigint coordinates. #### Source -[lib/provable/crypto/foreign-curve.ts:97](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L97) +[lib/provable/crypto/foreign-curve.ts:106](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L106) *** -### assertInSubgroup() +### ~~assertInSubgroup()~~ ```ts static assertInSubgroup(g: ForeignCurve): void @@ -510,11 +527,11 @@ static assertInSubgroup(g: ForeignCurve): void #### Source -[lib/provable/crypto/foreign-curve.ts:207](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L207) +[lib/provable/crypto/foreign-curve.ts:216](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L216) *** -### assertOnCurve() +### ~~assertOnCurve()~~ ```ts static assertOnCurve(g: ForeignCurve): void @@ -530,11 +547,11 @@ static assertOnCurve(g: ForeignCurve): void #### Source -[lib/provable/crypto/foreign-curve.ts:195](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L195) +[lib/provable/crypto/foreign-curve.ts:204](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L204) *** -### check() +### ~~check()~~ ```ts static check(g: ForeignCurve): void @@ -555,11 +572,11 @@ Check that this is a valid element of the target subgroup of the curve: #### Source -[lib/provable/crypto/foreign-curve.ts:229](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L229) +[lib/provable/crypto/foreign-curve.ts:238](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L238) *** -### from() +### ~~from()~~ ```ts static from(g: ForeignCurve | FlexiblePoint): ForeignCurve @@ -577,4 +594,4 @@ Coerce the input to a [ForeignCurve](ForeignCurve.mdx). #### Source -[lib/provable/crypto/foreign-curve.ts:61](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L61) +[lib/provable/crypto/foreign-curve.ts:70](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L70) diff --git a/docs/zkapps/o1js-reference/classes/ForeignCurveV2.mdx b/docs/zkapps/o1js-reference/classes/ForeignCurveV2.mdx new file mode 100644 index 000000000..ef4ed0230 --- /dev/null +++ b/docs/zkapps/o1js-reference/classes/ForeignCurveV2.mdx @@ -0,0 +1,665 @@ +## Deprecated + +`ForeignCurve` is now deprecated and will be removed in a future release. Please use [ForeignCurveV2](ForeignCurveV2.mdx) instead. + +## Extends + +- [`ForeignCurve`](ForeignCurve.mdx) + +## Constructors + +### new ForeignCurveV2() + +```ts +new ForeignCurveV2(g: { + "x": number | bigint | Field3 | AlmostForeignField; + "y": number | bigint | Field3 | AlmostForeignField; + }): ForeignCurveV2 +``` + +#### Parameters + +• **g** + +• **g.x**: `number` \| `bigint` \| `Field3` \| [`AlmostForeignField`](AlmostForeignField.mdx) + +• **g.y**: `number` \| `bigint` \| `Field3` \| [`AlmostForeignField`](AlmostForeignField.mdx) + +#### Returns + +[`ForeignCurveV2`](ForeignCurveV2.mdx) + +#### Overrides + +[`ForeignCurve`](ForeignCurve.mdx).[`constructor`](ForeignCurve.mdx#constructors) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:289](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L289) + +## Properties + +### ~~x~~ + +```ts +x: AlmostForeignField; +``` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`x`](ForeignCurve.mdx#x) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:39](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L39) + +*** + +### ~~y~~ + +```ts +y: AlmostForeignField; +``` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`y`](ForeignCurve.mdx#y) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:40](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L40) + +*** + +### ~~\_Bigint?~~ + +```ts +static optional _Bigint: {}; +``` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`_Bigint`](ForeignCurve.mdx#_bigint) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:249](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L249) + +*** + +### ~~\_Field?~~ + +```ts +static optional _Field: typeof AlmostForeignField; +``` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`_Field`](ForeignCurve.mdx#_field) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:250](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L250) + +*** + +### ~~\_Scalar?~~ + +```ts +static optional _Scalar: typeof AlmostForeignField; +``` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`_Scalar`](ForeignCurve.mdx#_scalar) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:251](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L251) + +*** + +### ~~\_provable?~~ + +```ts +static optional _provable: ProvablePureExtended; +``` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`_provable`](ForeignCurve.mdx#_provable) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:252](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L252) + +## Accessors + +### ~~Constructor~~ + +```ts +get Constructor(): typeof ForeignCurve +``` + +#### Returns + +*typeof* [`ForeignCurve`](ForeignCurve.mdx) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:246](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L246) + +*** + +### ~~modulus~~ + +```ts +get modulus(): bigint +``` + +The size of the curve's base field. + +#### Returns + +`bigint` + +#### Source + +[lib/provable/crypto/foreign-curve.ts:90](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L90) + +*** + +### ~~Bigint~~ + +```ts +get static Bigint(): {} +``` + +Curve arithmetic on JS bigints. + +#### Returns + +```ts +{} +``` + +#### Source + +[lib/provable/crypto/foreign-curve.ts:261](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L261) + +*** + +### ~~Field~~ + +```ts +get static Field(): typeof AlmostForeignField +``` + +The base field of this curve as a [ForeignField](ForeignField.mdx). + +#### Returns + +*typeof* [`AlmostForeignField`](AlmostForeignField.mdx) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:268](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L268) + +*** + +### ~~Scalar~~ + +```ts +get static Scalar(): typeof AlmostForeignField +``` + +The scalar field of this curve as a [ForeignField](ForeignField.mdx). + +#### Returns + +*typeof* [`AlmostForeignField`](AlmostForeignField.mdx) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:275](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L275) + +*** + +### ~~generator~~ + +```ts +get static generator(): ForeignCurve +``` + +The constant generator point. + +#### Returns + +[`ForeignCurve`](ForeignCurve.mdx) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:78](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L78) + +*** + +### ~~modulus~~ + +```ts +get static modulus(): bigint +``` + +The size of the curve's base field. + +#### Returns + +`bigint` + +#### Source + +[lib/provable/crypto/foreign-curve.ts:84](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L84) + +*** + +### ~~provable~~ + +```ts +get static provable(): ProvablePureExtended +``` + +`Provable` + +#### Returns + +`ProvablePureExtended`\<[`ForeignCurve`](ForeignCurve.mdx), \{ + `"x"`: `bigint`; + `"y"`: `bigint`; + \}, \{ + `"x"`: `string`; + `"y"`: `string`; + \}\> + +#### Source + +[lib/provable/crypto/foreign-curve.ts:282](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L282) + +## Methods + +### ~~add()~~ + +```ts +add(h: ForeignCurve | FlexiblePoint): ForeignCurve +``` + +Elliptic curve addition. + +```ts +let r = p.add(q); // r = p + q +``` + +**Important**: this is _incomplete addition_ and does not handle the degenerate cases: +- Inputs are equal, `g = h` (where you would use [double](ForeignCurve.mdx#double)). + In this case, the result of this method is garbage and can be manipulated arbitrarily by a malicious prover. +- Inputs are inverses of each other, `g = -h`, so that the result would be the zero point. + In this case, the proof fails. + +If you want guaranteed soundness regardless of the input, use [addSafe](ForeignCurve.mdx#addsafe) instead. + +#### Parameters + +• **h**: [`ForeignCurve`](ForeignCurve.mdx) \| `FlexiblePoint` + +#### Returns + +[`ForeignCurve`](ForeignCurve.mdx) + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`add`](ForeignCurve.mdx#add) + +#### Throws + +if the inputs are inverses of each other. + +#### Source + +[lib/provable/crypto/foreign-curve.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L130) + +*** + +### ~~addSafe()~~ + +```ts +addSafe(h: ForeignCurve | FlexiblePoint): ForeignCurve +``` + +Safe elliptic curve addition. + +This is the same as [add](ForeignCurve.mdx#add), but additionally proves that the inputs are not equal. +Therefore, the method is guaranteed to either fail or return a valid addition result. + +**Beware**: this is more expensive than [add](ForeignCurve.mdx#add), and is still incomplete in that +it does not succeed on equal or inverse inputs. + +#### Parameters + +• **h**: [`ForeignCurve`](ForeignCurve.mdx) \| `FlexiblePoint` + +#### Returns + +[`ForeignCurve`](ForeignCurve.mdx) + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`addSafe`](ForeignCurve.mdx#addsafe) + +#### Throws + +if the inputs are equal or inverses of each other. + +#### Source + +[lib/provable/crypto/foreign-curve.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L148) + +*** + +### ~~assertInSubgroup()~~ + +```ts +assertInSubgroup(): void +``` + +Assert that this point lies in the subgroup defined by `order*P = 0`. + +Note: this is a no-op if the curve has cofactor equal to 1. Otherwise +it performs the full scalar multiplication `order*P` and is expensive. + +#### Returns + +`void` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`assertInSubgroup`](ForeignCurve.mdx#assertinsubgroup) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:228](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L228) + +*** + +### ~~assertOnCurve()~~ + +```ts +assertOnCurve(): void +``` + +Assert that this point lies on the elliptic curve, which means it satisfies the equation +`y^2 = x^3 + ax + b` + +#### Returns + +`void` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`assertOnCurve`](ForeignCurve.mdx#assertoncurve) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:212](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L212) + +*** + +### ~~double()~~ + +```ts +double(): ForeignCurve +``` + +Elliptic curve doubling. + +#### Returns + +[`ForeignCurve`](ForeignCurve.mdx) + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`double`](ForeignCurve.mdx#double) + +#### Example + +```ts +let r = p.double(); // r = 2 * p +``` + +#### Source + +[lib/provable/crypto/foreign-curve.ts:167](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L167) + +*** + +### ~~isConstant()~~ + +```ts +isConstant(): boolean +``` + +Checks whether this curve point is constant. + +See FieldVar to understand constants vs variables. + +#### Returns + +`boolean` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`isConstant`](ForeignCurve.mdx#isconstant) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:99](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L99) + +*** + +### ~~negate()~~ + +```ts +negate(): ForeignCurve +``` + +Elliptic curve negation. + +#### Returns + +[`ForeignCurve`](ForeignCurve.mdx) + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`negate`](ForeignCurve.mdx#negate) + +#### Example + +```ts +let r = p.negate(); // r = -p +``` + +#### Source + +[lib/provable/crypto/foreign-curve.ts:181](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L181) + +*** + +### ~~scale()~~ + +```ts +scale(scalar: number | bigint | AlmostForeignField): ForeignCurve +``` + +Elliptic curve scalar multiplication, where the scalar is represented as a [ForeignField](ForeignField.mdx) element. + +**Important**: this proves that the result of the scalar multiplication is not the zero point. + +#### Parameters + +• **scalar**: `number` \| `bigint` \| [`AlmostForeignField`](AlmostForeignField.mdx) + +#### Returns + +[`ForeignCurve`](ForeignCurve.mdx) + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`scale`](ForeignCurve.mdx#scale) + +#### Throws + +if the scalar multiplication results in the zero point; for example, if the scalar is zero. + +#### Example + +```ts +let r = p.scale(s); // r = s * p +``` + +#### Source + +[lib/provable/crypto/foreign-curve.ts:197](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L197) + +*** + +### ~~toBigint()~~ + +```ts +toBigint(): GroupAffine +``` + +Convert this curve point to a point with bigint coordinates. + +#### Returns + +`GroupAffine` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`toBigint`](ForeignCurve.mdx#tobigint) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:106](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L106) + +*** + +### ~~assertInSubgroup()~~ + +```ts +static assertInSubgroup(g: ForeignCurve): void +``` + +#### Parameters + +• **g**: [`ForeignCurve`](ForeignCurve.mdx) + +#### Returns + +`void` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`assertInSubgroup`](ForeignCurve.mdx#assertinsubgroup-1) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:216](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L216) + +*** + +### ~~assertOnCurve()~~ + +```ts +static assertOnCurve(g: ForeignCurve): void +``` + +#### Parameters + +• **g**: [`ForeignCurve`](ForeignCurve.mdx) + +#### Returns + +`void` + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`assertOnCurve`](ForeignCurve.mdx#assertoncurve-1) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:204](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L204) + +*** + +### ~~check()~~ + +```ts +static check(g: ForeignCurveV2): void +``` + +Check that this is a valid element of the target subgroup of the curve: +- Check that the coordinates are valid field elements +- Use [()](ForeignCurve.mdx#assertoncurve-1) to check that the point lies on the curve +- If the curve has cofactor unequal to 1, use [()](ForeignCurve.mdx#assertinsubgroup-1). + +#### Parameters + +• **g**: [`ForeignCurveV2`](ForeignCurveV2.mdx) + +#### Returns + +`void` + +#### Overrides + +[`ForeignCurve`](ForeignCurve.mdx).[`check`](ForeignCurve.mdx#check) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:296](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L296) + +*** + +### ~~from()~~ + +```ts +static from(g: ForeignCurve | FlexiblePoint): ForeignCurve +``` + +Coerce the input to a [ForeignCurve](ForeignCurve.mdx). + +#### Parameters + +• **g**: [`ForeignCurve`](ForeignCurve.mdx) \| `FlexiblePoint` + +#### Returns + +[`ForeignCurve`](ForeignCurve.mdx) + +#### Inherited from + +[`ForeignCurve`](ForeignCurve.mdx).[`from`](ForeignCurve.mdx#from) + +#### Source + +[lib/provable/crypto/foreign-curve.ts:70](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L70) diff --git a/docs/zkapps/o1js-reference/classes/ForeignField.mdx b/docs/zkapps/o1js-reference/classes/ForeignField.mdx index ad5b5b7c0..1481a77d9 100644 --- a/docs/zkapps/o1js-reference/classes/ForeignField.mdx +++ b/docs/zkapps/o1js-reference/classes/ForeignField.mdx @@ -34,7 +34,7 @@ let x = new ForeignField(5); #### Source -[lib/provable/foreign-field.ts:96](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L96) +[lib/provable/foreign-field.ts:96](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L96) ## Properties @@ -48,7 +48,7 @@ The internal representation of a foreign field element, as a tuple of 3 limbs. #### Source -[lib/provable/foreign-field.ts:50](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L50) +[lib/provable/foreign-field.ts:50](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L50) *** @@ -60,7 +60,7 @@ static _Bigint: undefined | {} = undefined; #### Source -[lib/provable/foreign-field.ts:28](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L28) +[lib/provable/foreign-field.ts:28](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L28) *** @@ -72,7 +72,7 @@ static _modulus: undefined | bigint = undefined; #### Source -[lib/provable/foreign-field.ts:29](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L29) +[lib/provable/foreign-field.ts:29](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L29) *** @@ -84,7 +84,7 @@ static _provable: any = undefined; #### Source -[lib/provable/foreign-field.ts:408](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L408) +[lib/provable/foreign-field.ts:408](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L408) *** @@ -102,7 +102,7 @@ Sibling classes that represent different ranges of field elements. #### Source -[lib/provable/foreign-field.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L59) +[lib/provable/foreign-field.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L59) ## Accessors @@ -118,7 +118,7 @@ get Constructor(): typeof ForeignField #### Source -[lib/provable/foreign-field.ts:52](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L52) +[lib/provable/foreign-field.ts:52](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L52) *** @@ -134,7 +134,7 @@ get modulus(): bigint #### Source -[lib/provable/foreign-field.ts:40](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L40) +[lib/provable/foreign-field.ts:40](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L40) *** @@ -152,7 +152,7 @@ Constructor for field elements that are "almost reduced", i.e. lie in the range #### Source -[lib/provable/foreign-field.ts:77](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L77) +[lib/provable/foreign-field.ts:77](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L77) *** @@ -170,7 +170,7 @@ get static Bigint(): {} #### Source -[lib/provable/foreign-field.ts:32](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L32) +[lib/provable/foreign-field.ts:32](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L32) *** @@ -188,7 +188,7 @@ Constructor for field elements that are fully reduced, i.e. lie in the range [0, #### Source -[lib/provable/foreign-field.ts:84](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L84) +[lib/provable/foreign-field.ts:84](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L84) *** @@ -206,7 +206,7 @@ Constructor for unreduced field elements. #### Source -[lib/provable/foreign-field.ts:70](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L70) +[lib/provable/foreign-field.ts:70](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L70) *** @@ -222,7 +222,7 @@ get static modulus(): bigint #### Source -[lib/provable/foreign-field.ts:36](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L36) +[lib/provable/foreign-field.ts:36](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L36) *** @@ -240,7 +240,7 @@ get static provable(): any #### Source -[lib/provable/foreign-field.ts:413](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L413) +[lib/provable/foreign-field.ts:413](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L413) *** @@ -256,7 +256,7 @@ get static sizeInBits(): number #### Source -[lib/provable/foreign-field.ts:43](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L43) +[lib/provable/foreign-field.ts:43](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L43) ## Methods @@ -284,7 +284,7 @@ x.add(2); // x + 2 mod p #### Source -[lib/provable/foreign-field.ts:208](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L208) +[lib/provable/foreign-field.ts:208](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L208) *** @@ -312,7 +312,7 @@ ensuring validity of all our non-native field arithmetic methods. #### Source -[lib/provable/foreign-field.ts:163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L163) +[lib/provable/foreign-field.ts:163](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L163) *** @@ -333,7 +333,7 @@ Returns the field element as a [CanonicalForeignField](CanonicalForeignField.mdx #### Source -[lib/provable/foreign-field.ts:194](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L194) +[lib/provable/foreign-field.ts:194](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L194) *** @@ -375,7 +375,7 @@ xChecked satisfies CanonicalForeignField; ##### Source -[lib/provable/foreign-field.ts:286](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L286) +[lib/provable/foreign-field.ts:286](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L286) #### assertEquals(y, message) @@ -395,7 +395,7 @@ assertEquals(y: AlmostForeignField, message?: string): AlmostForeignField ##### Source -[lib/provable/foreign-field.ts:290](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L290) +[lib/provable/foreign-field.ts:290](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L290) #### assertEquals(y, message) @@ -415,7 +415,7 @@ assertEquals(y: ForeignField, message?: string): ForeignField ##### Source -[lib/provable/foreign-field.ts:291](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L291) +[lib/provable/foreign-field.ts:291](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L291) *** @@ -447,7 +447,7 @@ x.assertLessThan(10); #### Source -[lib/provable/foreign-field.ts:333](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L333) +[lib/provable/foreign-field.ts:333](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L333) *** @@ -467,7 +467,7 @@ See FieldVar to understand constants vs variables. #### Source -[lib/provable/foreign-field.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L126) +[lib/provable/foreign-field.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L126) *** @@ -491,7 +491,7 @@ x.neg(); // -x mod p = p - x #### Source -[lib/provable/foreign-field.ts:219](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L219) +[lib/provable/foreign-field.ts:219](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L219) *** @@ -519,7 +519,7 @@ x.sub(1); // x - 1 mod p #### Source -[lib/provable/foreign-field.ts:234](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L234) +[lib/provable/foreign-field.ts:234](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L234) *** @@ -537,7 +537,7 @@ Convert this field element to a bigint. #### Source -[lib/provable/foreign-field.ts:146](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L146) +[lib/provable/foreign-field.ts:146](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L146) *** @@ -561,7 +561,7 @@ This method is provable! #### Source -[lib/provable/foreign-field.ts:352](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L352) +[lib/provable/foreign-field.ts:352](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L352) *** @@ -584,7 +584,7 @@ that is, in situations where the prover computes a value outside provable code. #### Source -[lib/provable/foreign-field.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L138) +[lib/provable/foreign-field.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L138) *** @@ -602,7 +602,7 @@ Instance version of `Provable.toFields`, see Provable.toFields #### Source -[lib/provable/foreign-field.ts:400](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L400) +[lib/provable/foreign-field.ts:400](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L400) *** @@ -631,7 +631,7 @@ This is most efficient than when checking a multiple of 3 field elements at once #### Source -[lib/provable/foreign-field.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L177) +[lib/provable/foreign-field.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L177) *** @@ -651,7 +651,7 @@ static check(_: ForeignField): void #### Source -[lib/provable/foreign-field.ts:404](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L404) +[lib/provable/foreign-field.ts:404](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L404) *** @@ -675,7 +675,7 @@ Coerce the input to a [ForeignField](ForeignField.mdx). ##### Source -[lib/provable/foreign-field.ts:114](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L114) +[lib/provable/foreign-field.ts:114](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L114) #### from(x) @@ -693,7 +693,7 @@ static from(x: string | number | bigint | ForeignField): ForeignField ##### Source -[lib/provable/foreign-field.ts:115](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L115) +[lib/provable/foreign-field.ts:115](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L115) *** @@ -717,7 +717,7 @@ This method is provable! #### Source -[lib/provable/foreign-field.ts:382](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L382) +[lib/provable/foreign-field.ts:382](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L382) *** @@ -733,7 +733,7 @@ static random(): CanonicalForeignField #### Source -[lib/provable/foreign-field.ts:393](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L393) +[lib/provable/foreign-field.ts:393](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L393) *** @@ -775,4 +775,4 @@ than chaining calls to [ForeignField.add](ForeignField.mdx#add) and [ForeignFiel #### Source -[lib/provable/foreign-field.ts:259](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L259) +[lib/provable/foreign-field.ts:259](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L259) diff --git a/docs/zkapps/o1js-reference/classes/Group.mdx b/docs/zkapps/o1js-reference/classes/Group.mdx index 2c221b2ea..b52b3c905 100644 --- a/docs/zkapps/o1js-reference/classes/Group.mdx +++ b/docs/zkapps/o1js-reference/classes/Group.mdx @@ -45,7 +45,7 @@ Coerces anything group-like to a [Group](Group.mdx). #### Source -[lib/provable/group.ts:50](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L50) +[lib/provable/group.ts:50](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L50) ## Properties @@ -57,7 +57,7 @@ x: Field; #### Source -[lib/provable/group.ts:21](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L21) +[lib/provable/group.ts:21](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L21) *** @@ -69,7 +69,7 @@ y: Field; #### Source -[lib/provable/group.ts:22](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L22) +[lib/provable/group.ts:22](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L22) ## Accessors @@ -87,7 +87,7 @@ The generator `g` of the Group. #### Source -[lib/provable/group.ts:27](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L27) +[lib/provable/group.ts:27](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L27) *** @@ -114,7 +114,7 @@ g.add(zero).assertEquals(g); #### Source -[lib/provable/group.ts:43](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L43) +[lib/provable/group.ts:43](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L43) ## Methods @@ -141,7 +141,7 @@ let g2 = g1.add(g1) #### Source -[lib/provable/group.ts:97](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L97) +[lib/provable/group.ts:97](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L97) *** @@ -171,7 +171,7 @@ This case has to be prevented or handled separately by the caller of this method #### Source -[lib/provable/group.ts:136](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L136) +[lib/provable/group.ts:136](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L136) *** @@ -200,7 +200,7 @@ g1.assertEquals(g2); #### Source -[lib/provable/group.ts:200](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L200) +[lib/provable/group.ts:200](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L200) *** @@ -227,7 +227,7 @@ g1.equals(g1); // Bool(true) #### Source -[lib/provable/group.ts:216](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L216) +[lib/provable/group.ts:216](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L216) *** @@ -245,7 +245,7 @@ Checks if this element is the `zero` element `{x: 0, y: 0}`. #### Source -[lib/provable/group.ts:84](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L84) +[lib/provable/group.ts:84](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L84) *** @@ -263,7 +263,7 @@ Negates this [Group](Group.mdx). Under the hood, it simply negates the `y` coord #### Source -[lib/provable/group.ts:165](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L165) +[lib/provable/group.ts:165](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L165) *** @@ -290,7 +290,7 @@ let 5g = g.scale(s); #### Source -[lib/provable/group.ts:179](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L179) +[lib/provable/group.ts:179](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L179) *** @@ -312,7 +312,7 @@ Subtracts another [Group](Group.mdx) element from this one. #### Source -[lib/provable/group.ts:158](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L158) +[lib/provable/group.ts:158](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L158) *** @@ -332,7 +332,7 @@ Returns an array containing this [Group](Group.mdx) element as an array of [Fiel #### Source -[lib/provable/group.ts:253](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L253) +[lib/provable/group.ts:253](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L253) *** @@ -372,7 +372,7 @@ y: string; #### Source -[lib/provable/group.ts:238](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L238) +[lib/provable/group.ts:238](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L238) *** @@ -394,7 +394,7 @@ Checks that a [Group](Group.mdx) element is constraint properly by checking that #### Source -[lib/provable/group.ts:330](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L330) +[lib/provable/group.ts:330](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L330) *** @@ -410,7 +410,7 @@ static empty(): Group #### Source -[lib/provable/group.ts:356](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L356) +[lib/provable/group.ts:356](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L356) *** @@ -454,7 +454,7 @@ Coerces two x and y coordinates into a [Group](Group.mdx) element. #### Source -[lib/provable/group.ts:260](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L260) +[lib/provable/group.ts:260](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L260) *** @@ -478,7 +478,7 @@ Deserializes a [Group](Group.mdx) element from a list of field elements. #### Source -[lib/provable/group.ts:290](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L290) +[lib/provable/group.ts:290](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L290) *** @@ -527,7 +527,7 @@ This operation does NOT affect the circuit and can't be used to prove anything a #### Source -[lib/provable/group.ts:317](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L317) +[lib/provable/group.ts:317](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L317) *** @@ -553,7 +553,7 @@ static fromValue(g: Group | { #### Source -[lib/provable/group.ts:227](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L227) +[lib/provable/group.ts:227](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L227) *** @@ -573,7 +573,7 @@ Returns 2. #### Source -[lib/provable/group.ts:299](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L299) +[lib/provable/group.ts:299](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L299) *** @@ -597,7 +597,7 @@ Returns an empty array. #### Source -[lib/provable/group.ts:281](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L281) +[lib/provable/group.ts:281](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L281) *** @@ -621,7 +621,7 @@ Returns an array containing a [Group](Group.mdx) element as an array of [Field]( #### Source -[lib/provable/group.ts:272](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L272) +[lib/provable/group.ts:272](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L272) *** @@ -653,7 +653,7 @@ fields: Field[]; #### Source -[lib/provable/group.ts:350](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L350) +[lib/provable/group.ts:350](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L350) *** @@ -697,7 +697,7 @@ y: string; #### Source -[lib/provable/group.ts:308](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L308) +[lib/provable/group.ts:308](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L308) *** @@ -737,4 +737,4 @@ y: bigint; #### Source -[lib/provable/group.ts:223](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/group.ts#L223) +[lib/provable/group.ts:223](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/group.ts#L223) diff --git a/docs/zkapps/o1js-reference/classes/Hashed.mdx b/docs/zkapps/o1js-reference/classes/Hashed.mdx index 4474524fc..8e35f32ed 100644 --- a/docs/zkapps/o1js-reference/classes/Hashed.mdx +++ b/docs/zkapps/o1js-reference/classes/Hashed.mdx @@ -48,7 +48,7 @@ new Hashed(hash: Field, value: Unconstrained): Hashed #### Source -[lib/provable/packed.ts:210](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L210) +[lib/provable/packed.ts:210](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L210) ## Properties @@ -60,7 +60,7 @@ hash: Field; #### Source -[lib/provable/packed.ts:175](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L175) +[lib/provable/packed.ts:175](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L175) *** @@ -72,7 +72,7 @@ value: Unconstrained; #### Source -[lib/provable/packed.ts:176](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L176) +[lib/provable/packed.ts:176](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L176) *** @@ -84,7 +84,7 @@ static _innerProvable: undefined | ProvableHashable; #### Source -[lib/provable/packed.ts:257](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L257) +[lib/provable/packed.ts:257](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L257) *** @@ -96,7 +96,7 @@ static _provable: undefined | ProvableHashable>; #### Source -[lib/provable/packed.ts:256](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L256) +[lib/provable/packed.ts:256](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L256) ## Accessors @@ -112,7 +112,7 @@ get Constructor(): typeof Hashed #### Source -[lib/provable/packed.ts:259](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L259) +[lib/provable/packed.ts:259](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L259) *** @@ -128,7 +128,7 @@ get static innerProvable(): ProvableHashable #### Source -[lib/provable/packed.ts:263](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L263) +[lib/provable/packed.ts:263](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L263) ## Methods @@ -144,7 +144,7 @@ toFields(): Field[] #### Source -[lib/provable/packed.ts:251](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L251) +[lib/provable/packed.ts:251](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L251) *** @@ -162,7 +162,7 @@ Unwrap a value from its hashed variant. #### Source -[lib/provable/packed.ts:239](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L239) +[lib/provable/packed.ts:239](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L239) *** @@ -182,7 +182,7 @@ static _hash(_: any): Field #### Source -[lib/provable/packed.ts:215](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L215) +[lib/provable/packed.ts:215](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L215) *** @@ -214,7 +214,7 @@ Create a hashed representation of `type`. You can then use `HashedType.hash(x)` #### Source -[lib/provable/packed.ts:181](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L181) +[lib/provable/packed.ts:181](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L181) *** @@ -248,4 +248,4 @@ Optionally, if you already have the hash, you can pass it in and avoid recomputi #### Source -[lib/provable/packed.ts:228](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L228) +[lib/provable/packed.ts:228](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L228) diff --git a/docs/zkapps/o1js-reference/classes/Int64.mdx b/docs/zkapps/o1js-reference/classes/Int64.mdx index 028f25920..473cdd45d 100644 --- a/docs/zkapps/o1js-reference/classes/Int64.mdx +++ b/docs/zkapps/o1js-reference/classes/Int64.mdx @@ -32,7 +32,7 @@ new Int64(magnitude: UInt64, sgn: Sign): Int64 #### Source -[lib/provable/int.ts:1047](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1047) +[lib/provable/int.ts:1051](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1051) ## Properties @@ -48,7 +48,7 @@ magnitude: UInt64; #### Source -[lib/provable/int.ts:1024](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1024) +[lib/provable/int.ts:1028](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1028) *** @@ -64,7 +64,7 @@ sgn: Sign; #### Source -[lib/provable/int.ts:1025](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1025) +[lib/provable/int.ts:1029](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1029) ## Accessors @@ -82,7 +82,7 @@ Static method to create a [Int64](Int64.mdx) with value `-1`. #### Source -[lib/provable/int.ts:1122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1122) +[lib/provable/int.ts:1126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1126) *** @@ -100,7 +100,7 @@ Static method to create a [Int64](Int64.mdx) with value `1`. #### Source -[lib/provable/int.ts:1116](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1116) +[lib/provable/int.ts:1120](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1120) *** @@ -118,7 +118,7 @@ Static method to create a [Int64](Int64.mdx) with value `0`. #### Source -[lib/provable/int.ts:1110](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1110) +[lib/provable/int.ts:1114](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1114) ## Methods @@ -152,7 +152,7 @@ Addition with overflow checking. #### Source -[lib/provable/int.ts:1156](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1156) +[lib/provable/int.ts:1173](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1173) *** @@ -192,7 +192,7 @@ Asserts that two values are equal. #### Source -[lib/provable/int.ts:1210](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1210) +[lib/provable/int.ts:1243](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1243) *** @@ -212,6 +212,7 @@ Integer division. `x.div(y)` returns the floor of `x / y`, that is, the greatest `z` such that `z * y <= x`. +On negative numbers, this rounds towards zero. #### Parameters @@ -229,7 +230,7 @@ Integer division. #### Source -[lib/provable/int.ts:1181](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1181) +[lib/provable/int.ts:1198](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1198) *** @@ -267,7 +268,7 @@ Checks if two values are equal. #### Source -[lib/provable/int.ts:1203](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1203) +[lib/provable/int.ts:1236](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1236) *** @@ -287,17 +288,38 @@ isConstant(): boolean #### Source -[lib/provable/int.ts:1099](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1099) +[lib/provable/int.ts:1103](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1103) *** -### isPositive() +### ~~isPositive()~~ ```ts isPositive(): Bool ``` -Checks if the value is positive. +#### Returns + +[`Bool`](Bool.mdx) + +#### Deprecated + +Use [isPositiveV2](Int64.mdx#ispositivev2) instead. +The current implementation actually tests for non-negativity, but is wrong for the negative representation of 0. + +#### Source + +[lib/provable/int.ts:1254](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1254) + +*** + +### isPositiveV2() + +```ts +isPositiveV2(): Bool +``` + +Checks if the value is positive (x > 0). #### Returns @@ -305,11 +327,11 @@ Checks if the value is positive. #### Source -[lib/provable/int.ts:1220](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1220) +[lib/provable/int.ts:1261](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1261) *** -### mod() +### ~~mod()~~ ```ts mod(y: @@ -320,6 +342,42 @@ mod(y: | UInt32): Int64 ``` +#### Parameters + +• **y**: + \| `string` + \| `number` + \| `bigint` + \| [`UInt64`](UInt64.mdx) + \| [`UInt32`](UInt32.mdx) + +#### Returns + +[`Int64`](Int64.mdx) + +#### Deprecated + +Use [()](Int64.mdx#modv2) instead. +This implementation is vulnerable whenever `this` is zero. +It allows the prover to return `y` instead of 0 as the result. + +#### Source + +[lib/provable/int.ts:1210](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1210) + +*** + +### modV2() + +```ts +modV2(y: + | string + | number + | bigint + | UInt64 + | UInt32): Int64 +``` + Integer remainder. `x.mod(y)` returns the value `z` such that `0 <= z < y` and @@ -340,7 +398,7 @@ Integer remainder. #### Source -[lib/provable/int.ts:1193](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1193) +[lib/provable/int.ts:1223](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1223) *** @@ -374,16 +432,37 @@ Multiplication with overflow checking. #### Source -[lib/provable/int.ts:1170](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1170) +[lib/provable/int.ts:1187](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1187) *** -### neg() +### ~~neg()~~ ```ts neg(): Int64 ``` +#### Returns + +[`Int64`](Int64.mdx) + +#### Deprecated + +Use [()](Int64.mdx#negv2) instead. +The current implementation will not be backwards-compatible with v2. + +#### Source + +[lib/provable/int.ts:1152](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1152) + +*** + +### negV2() + +```ts +negV2(): Int64 +``` + Negates the value. `Int64.from(5).neg()` will turn into `Int64.from(-5)` @@ -394,7 +473,7 @@ Negates the value. #### Source -[lib/provable/int.ts:1149](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1149) +[lib/provable/int.ts:1162](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1162) *** @@ -428,7 +507,7 @@ Subtraction with underflow checking. #### Source -[lib/provable/int.ts:1163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1163) +[lib/provable/int.ts:1180](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1180) *** @@ -448,7 +527,7 @@ toConstant(): this #### Source -[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L122) +[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L122) *** @@ -466,7 +545,7 @@ Returns the [Field](../variables/Field.mdx) value. #### Source -[lib/provable/int.ts:1129](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1129) +[lib/provable/int.ts:1133](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1133) *** @@ -486,7 +565,7 @@ toFields(): Field[] #### Source -[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L85) +[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L85) *** @@ -506,7 +585,7 @@ toJSON(): any #### Source -[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L118) +[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L118) *** @@ -524,7 +603,7 @@ Turns the [Int64](Int64.mdx) into a string. #### Source -[lib/provable/int.ts:1094](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1094) +[lib/provable/int.ts:1098](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1098) *** @@ -554,7 +633,36 @@ static check(this: T, v: InstanceType): void #### Source -[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L163) +[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L163) + +*** + +### checkV2() + +```ts +static checkV2(__namedParameters: { + "magnitude": UInt64; + "sgn": Sign; + }): void +``` + +Checks if the value is negative (x < 0). + +#### Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.magnitude**: [`UInt64`](UInt64.mdx) + +• **\_\_namedParameters.sgn**: [`Sign`](Sign.mdx) + +#### Returns + +`void` + +#### Source + +[lib/provable/int.ts:1284](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1284) *** @@ -578,7 +686,7 @@ static empty(): InstanceType #### Source -[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L218) +[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L218) *** @@ -616,7 +724,7 @@ Check the range if the argument is a constant. #### Source -[lib/provable/int.ts:1084](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1084) +[lib/provable/int.ts:1088](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1088) *** @@ -638,7 +746,7 @@ Static method to create a [Int64](Int64.mdx) from a [Field](../variables/Field.m #### Source -[lib/provable/int.ts:1135](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1135) +[lib/provable/int.ts:1139](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1139) *** @@ -668,7 +776,7 @@ static fromFields(this: T, xs: Field[]): InstanceType #### Source -[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L138) +[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L138) *** @@ -698,7 +806,7 @@ static fromJSON(this: T, value: any): InstanceType #### Source -[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L196) +[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L196) *** @@ -728,7 +836,7 @@ static fromObject(this: T, value: NonMethods>): InstanceType< #### Source -[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L30) +[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L30) *** @@ -752,7 +860,7 @@ Creates a new [Int64](Int64.mdx) from a [Field](../variables/Field.mdx). #### Source -[lib/provable/int.ts:1074](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1074) +[lib/provable/int.ts:1078](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1078) *** @@ -782,7 +890,7 @@ static fromValue(this: T, value: any): InstanceType #### Source -[lib/provable/types/circuit-value.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L98) +[lib/provable/types/circuit-value.ts:98](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L98) *** @@ -802,7 +910,7 @@ static sizeInFields(): number #### Source -[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L37) +[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L37) *** @@ -822,7 +930,7 @@ static toAuxiliary(): [] #### Source -[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L59) +[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L59) *** @@ -852,7 +960,7 @@ static toConstant(this: T, t: InstanceType): InstanceType #### Source -[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L177) +[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L177) *** @@ -882,7 +990,7 @@ static toFields(this: T, v: InstanceType): Field[] #### Source -[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L42) +[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L42) *** @@ -912,7 +1020,7 @@ static toInput(this: T, v: InstanceType): HashInput #### Source -[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L63) +[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L63) *** @@ -942,7 +1050,7 @@ static toJSON(this: T, v: InstanceType): any #### Source -[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L185) +[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L185) *** @@ -972,4 +1080,4 @@ static toValue(this: T, v: InstanceType): any #### Source -[lib/provable/types/circuit-value.ts:89](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L89) +[lib/provable/types/circuit-value.ts:89](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L89) diff --git a/docs/zkapps/o1js-reference/classes/Keypair.mdx b/docs/zkapps/o1js-reference/classes/Keypair.mdx index c16de2c06..0905df5a0 100644 --- a/docs/zkapps/o1js-reference/classes/Keypair.mdx +++ b/docs/zkapps/o1js-reference/classes/Keypair.mdx @@ -16,7 +16,7 @@ new Keypair(value: unknown): Keypair #### Source -[lib/proof-system/circuit.ts:104](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L104) +[lib/proof-system/circuit.ts:104](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L104) ## Properties @@ -28,7 +28,7 @@ value: unknown; #### Source -[lib/proof-system/circuit.ts:102](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L102) +[lib/proof-system/circuit.ts:102](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L102) ## Methods @@ -54,7 +54,7 @@ const json = MyProvable.witnessFromKeypair(keypair); #### Source -[lib/proof-system/circuit.ts:123](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L123) +[lib/proof-system/circuit.ts:123](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L123) *** @@ -70,4 +70,4 @@ verificationKey(): VerificationKey #### Source -[lib/proof-system/circuit.ts:108](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L108) +[lib/proof-system/circuit.ts:108](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L108) diff --git a/docs/zkapps/o1js-reference/classes/Ledger.mdx b/docs/zkapps/o1js-reference/classes/Ledger.mdx index d6de995d8..98cc8c9fb 100644 --- a/docs/zkapps/o1js-reference/classes/Ledger.mdx +++ b/docs/zkapps/o1js-reference/classes/Ledger.mdx @@ -34,7 +34,7 @@ Adds an account and its balance to the ledger. #### Source -[snarky.d.ts:492](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/snarky.d.ts#L492) +[snarky.d.ts:492](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/snarky.d.ts#L492) *** @@ -63,7 +63,7 @@ Applies a JSON transaction to the ledger. #### Source -[snarky.d.ts:497](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/snarky.d.ts#L497) +[snarky.d.ts:497](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/snarky.d.ts#L497) *** @@ -87,7 +87,7 @@ Returns an account. #### Source -[snarky.d.ts:506](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/snarky.d.ts#L506) +[snarky.d.ts:506](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/snarky.d.ts#L506) *** @@ -105,4 +105,4 @@ Creates a fresh ledger. #### Source -[snarky.d.ts:487](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/snarky.d.ts#L487) +[snarky.d.ts:487](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/snarky.d.ts#L487) diff --git a/docs/zkapps/o1js-reference/classes/MerkleList.mdx b/docs/zkapps/o1js-reference/classes/MerkleList.mdx index 9c8623973..24ed0c1e8 100644 --- a/docs/zkapps/o1js-reference/classes/MerkleList.mdx +++ b/docs/zkapps/o1js-reference/classes/MerkleList.mdx @@ -50,7 +50,7 @@ new MerkleList(__namedParameters: MerkleListBase): MerkleList #### Source -[lib/provable/merkle-list.ts:83](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L83) +[lib/provable/merkle-list.ts:83](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L83) ## Properties @@ -66,7 +66,7 @@ data: Unconstrained[]>; #### Source -[lib/provable/merkle-list.ts:81](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L81) +[lib/provable/merkle-list.ts:81](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L81) *** @@ -82,7 +82,7 @@ hash: Field; #### Source -[lib/provable/merkle-list.ts:80](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L80) +[lib/provable/merkle-list.ts:80](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L80) *** @@ -94,7 +94,7 @@ static _emptyHash: undefined | Field; #### Source -[lib/provable/merkle-list.ts:297](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L297) +[lib/provable/merkle-list.ts:297](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L297) *** @@ -106,7 +106,7 @@ static _innerProvable: undefined | ProvableHashable; #### Source -[lib/provable/merkle-list.ts:300](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L300) +[lib/provable/merkle-list.ts:300](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L300) *** @@ -118,7 +118,7 @@ static _nextHash: undefined | (hash: Field, t: any) => Field; #### Source -[lib/provable/merkle-list.ts:296](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L296) +[lib/provable/merkle-list.ts:296](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L296) *** @@ -130,7 +130,7 @@ static _provable: undefined | ProvableHashable>; #### Source -[lib/provable/merkle-list.ts:299](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L299) +[lib/provable/merkle-list.ts:299](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L299) ## Accessors @@ -146,7 +146,7 @@ get Constructor(): typeof MerkleList #### Source -[lib/provable/merkle-list.ts:302](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L302) +[lib/provable/merkle-list.ts:302](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L302) *** @@ -162,7 +162,7 @@ get innerProvable(): ProvableHashable #### Source -[lib/provable/merkle-list.ts:319](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L319) +[lib/provable/merkle-list.ts:319](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L319) *** @@ -178,7 +178,7 @@ get static emptyHash(): Field #### Source -[lib/provable/merkle-list.ts:314](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L314) +[lib/provable/merkle-list.ts:314](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L314) ## Methods @@ -194,7 +194,7 @@ clone(): MerkleList #### Source -[lib/provable/merkle-list.ts:189](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L189) +[lib/provable/merkle-list.ts:189](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L189) *** @@ -224,7 +224,7 @@ to handle the `isDummy` flag separately. #### Source -[lib/provable/merkle-list.ts:203](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L203) +[lib/provable/merkle-list.ts:203](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L203) *** @@ -240,7 +240,7 @@ isEmpty(): Bool #### Source -[lib/provable/merkle-list.ts:88](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L88) +[lib/provable/merkle-list.ts:88](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L88) *** @@ -262,7 +262,7 @@ nextHash(hash: Field, value: T): Field #### Source -[lib/provable/merkle-list.ts:306](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L306) +[lib/provable/merkle-list.ts:306](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L306) *** @@ -282,7 +282,7 @@ If the list is empty, returns a dummy element. #### Source -[lib/provable/merkle-list.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L154) +[lib/provable/merkle-list.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L154) *** @@ -302,7 +302,7 @@ This proves that the list is non-empty, and fails otherwise. #### Source -[lib/provable/merkle-list.ts:139](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L139) +[lib/provable/merkle-list.ts:139](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L139) *** @@ -326,7 +326,7 @@ If the list is empty, returns a dummy element. #### Source -[lib/provable/merkle-list.ts:173](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L173) +[lib/provable/merkle-list.ts:173](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L173) *** @@ -348,7 +348,7 @@ Push a new element to the list. #### Source -[lib/provable/merkle-list.ts:95](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L95) +[lib/provable/merkle-list.ts:95](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L95) *** @@ -372,7 +372,7 @@ Push a new element to the list, if the `condition` is true. #### Source -[lib/provable/merkle-list.ts:107](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L107) +[lib/provable/merkle-list.ts:107](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L107) *** @@ -388,7 +388,7 @@ startIterating(): MerkleListIterator #### Source -[lib/provable/merkle-list.ts:217](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L217) +[lib/provable/merkle-list.ts:217](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L217) *** @@ -404,7 +404,7 @@ startIteratingFromLast(): MerkleListIterator #### Source -[lib/provable/merkle-list.ts:222](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L222) +[lib/provable/merkle-list.ts:222](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L222) *** @@ -457,4 +457,4 @@ class MyList extends MerkleList.create(Field, (hash, x) => #### Source -[lib/provable/merkle-list.ts:239](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L239) +[lib/provable/merkle-list.ts:239](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L239) diff --git a/docs/zkapps/o1js-reference/classes/MerkleListIterator.mdx b/docs/zkapps/o1js-reference/classes/MerkleListIterator.mdx index 69f064aed..2be957549 100644 --- a/docs/zkapps/o1js-reference/classes/MerkleListIterator.mdx +++ b/docs/zkapps/o1js-reference/classes/MerkleListIterator.mdx @@ -39,7 +39,7 @@ new MerkleListIterator(value: MerkleListIteratorBase): MerkleListIterator< #### Source -[lib/provable/merkle-list.ts:373](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L373) +[lib/provable/merkle-list.ts:373](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L373) ## Properties @@ -55,7 +55,7 @@ currentHash: Field; #### Source -[lib/provable/merkle-list.ts:370](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L370) +[lib/provable/merkle-list.ts:370](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L370) *** @@ -71,7 +71,7 @@ currentIndex: Unconstrained; #### Source -[lib/provable/merkle-list.ts:371](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L371) +[lib/provable/merkle-list.ts:371](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L371) *** @@ -87,7 +87,7 @@ readonly data: Unconstrained[]>; #### Source -[lib/provable/merkle-list.ts:366](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L366) +[lib/provable/merkle-list.ts:366](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L366) *** @@ -103,7 +103,7 @@ readonly hash: Field; #### Source -[lib/provable/merkle-list.ts:367](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L367) +[lib/provable/merkle-list.ts:367](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L367) *** @@ -115,7 +115,7 @@ static _emptyHash: undefined | Field; #### Source -[lib/provable/merkle-list.ts:666](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L666) +[lib/provable/merkle-list.ts:666](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L666) *** @@ -127,7 +127,7 @@ static _innerProvable: undefined | ProvableHashable; #### Source -[lib/provable/merkle-list.ts:669](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L669) +[lib/provable/merkle-list.ts:669](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L669) *** @@ -139,7 +139,7 @@ static _nextHash: undefined | (hash: Field, value: any) => Field; #### Source -[lib/provable/merkle-list.ts:665](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L665) +[lib/provable/merkle-list.ts:665](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L665) *** @@ -151,7 +151,7 @@ static _provable: undefined | ProvableHashable>; #### Source -[lib/provable/merkle-list.ts:668](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L668) +[lib/provable/merkle-list.ts:668](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L668) ## Accessors @@ -167,7 +167,7 @@ get Constructor(): typeof MerkleListIterator #### Source -[lib/provable/merkle-list.ts:671](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L671) +[lib/provable/merkle-list.ts:671](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L671) *** @@ -263,7 +263,7 @@ isDummy: Bool; #### Source -[lib/provable/merkle-list.ts:503](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L503) +[lib/provable/merkle-list.ts:503](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L503) *** @@ -279,7 +279,7 @@ get innerProvable(): ProvableHashable #### Source -[lib/provable/merkle-list.ts:688](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L688) +[lib/provable/merkle-list.ts:688](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L688) *** @@ -295,7 +295,7 @@ get static emptyHash(): Field #### Source -[lib/provable/merkle-list.ts:683](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L683) +[lib/provable/merkle-list.ts:683](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L683) ## Methods @@ -317,7 +317,7 @@ _index(direction: "next" | "previous", i?: number): number #### Source -[lib/provable/merkle-list.ts:430](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L430) +[lib/provable/merkle-list.ts:430](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L430) *** @@ -337,7 +337,7 @@ _updateIndex(direction: "next" | "previous"): void #### Source -[lib/provable/merkle-list.ts:438](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L438) +[lib/provable/merkle-list.ts:438](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L438) *** @@ -357,7 +357,7 @@ assertAtEnd(message?: string): void #### Source -[lib/provable/merkle-list.ts:399](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L399) +[lib/provable/merkle-list.ts:399](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L399) *** @@ -373,7 +373,7 @@ assertAtStart(): void #### Source -[lib/provable/merkle-list.ts:377](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L377) +[lib/provable/merkle-list.ts:377](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L377) *** @@ -389,7 +389,7 @@ clone(): MerkleListIterator #### Source -[lib/provable/merkle-list.ts:560](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L560) +[lib/provable/merkle-list.ts:560](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L560) *** @@ -405,7 +405,7 @@ isAtEnd(): Bool #### Source -[lib/provable/merkle-list.ts:381](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L381) +[lib/provable/merkle-list.ts:381](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L381) *** @@ -421,7 +421,7 @@ isAtStart(): Bool #### Source -[lib/provable/merkle-list.ts:406](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L406) +[lib/provable/merkle-list.ts:406](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L406) *** @@ -437,7 +437,7 @@ jumpToEnd(): void #### Source -[lib/provable/merkle-list.ts:385](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L385) +[lib/provable/merkle-list.ts:385](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L385) *** @@ -457,7 +457,7 @@ jumpToEndIf(condition: Bool): void #### Source -[lib/provable/merkle-list.ts:390](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L390) +[lib/provable/merkle-list.ts:390](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L390) *** @@ -473,7 +473,7 @@ jumpToStart(): void #### Source -[lib/provable/merkle-list.ts:410](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L410) +[lib/provable/merkle-list.ts:410](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L410) *** @@ -493,7 +493,7 @@ jumpToStartIf(condition: Bool): void #### Source -[lib/provable/merkle-list.ts:417](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L417) +[lib/provable/merkle-list.ts:417](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L417) *** @@ -509,7 +509,7 @@ next(): T #### Source -[lib/provable/merkle-list.ts:476](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L476) +[lib/provable/merkle-list.ts:476](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L476) *** @@ -531,7 +531,7 @@ nextHash(hash: Field, value: T): Field #### Source -[lib/provable/merkle-list.ts:675](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L675) +[lib/provable/merkle-list.ts:675](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L675) *** @@ -547,7 +547,7 @@ previous(): T #### Source -[lib/provable/merkle-list.ts:445](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L445) +[lib/provable/merkle-list.ts:445](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L445) *** @@ -592,7 +592,7 @@ Create a Merkle array type #### Source -[lib/provable/merkle-list.ts:574](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L574) +[lib/provable/merkle-list.ts:574](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L574) *** @@ -628,4 +628,4 @@ static createFromList(merkleList: typeof MerkleList): typeof MerkleListIterat #### Source -[lib/provable/merkle-list.ts:656](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L656) +[lib/provable/merkle-list.ts:656](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L656) diff --git a/docs/zkapps/o1js-reference/classes/MerkleMap.mdx b/docs/zkapps/o1js-reference/classes/MerkleMap.mdx index 7ce1cdc74..28f3eb2ac 100644 --- a/docs/zkapps/o1js-reference/classes/MerkleMap.mdx +++ b/docs/zkapps/o1js-reference/classes/MerkleMap.mdx @@ -14,9 +14,15 @@ Creates a new, empty Merkle Map. A new MerkleMap +#### Example + +```ts +const merkleMap = new MerkleMap(); +``` + #### Source -[lib/provable/merkle-map.ts:17](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L17) +[lib/provable/merkle-map.ts:21](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L21) ## Properties @@ -28,7 +34,7 @@ tree: MerkleTree; #### Source -[lib/provable/merkle-map.ts:11](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L11) +[lib/provable/merkle-map.ts:11](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L11) ## Methods @@ -48,7 +54,7 @@ _keyToIndex(key: Field): bigint #### Source -[lib/provable/merkle-map.ts:21](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L21) +[lib/provable/merkle-map.ts:25](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L25) *** @@ -72,9 +78,17 @@ The key to get the value from. The value stored at the key. +#### Example + +```ts +const key = Field(5); +const value = merkleMap.get(key); +console.log(value); // Output: the value at key 5 or Field(0) if key does not exist +``` + #### Source -[lib/provable/merkle-map.ts:48](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L48) +[lib/provable/merkle-map.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L71) *** @@ -92,9 +106,15 @@ Returns the root of the Merkle Map. The root of the Merkle Map. +#### Example + +```ts +const root = merkleMap.getRoot(); +``` + #### Source -[lib/provable/merkle-map.ts:57](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L57) +[lib/provable/merkle-map.ts:84](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L84) *** @@ -118,9 +138,16 @@ The key to make a witness for. A MerkleMapWitness, which can be used to assert changes to the MerkleMap, and the witness's key. +#### Example + +```ts +const key = Field(5); +const witness = merkleMap.getWitness(key); +``` + #### Source -[lib/provable/merkle-map.ts:66](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L66) +[lib/provable/merkle-map.ts:98](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L98) *** @@ -146,6 +173,14 @@ The value to set. `void` +#### Example + +```ts +const key = Field(5); +const value = Field(10); +merkleMap.set(key, value); +``` + #### Source -[lib/provable/merkle-map.ts:38](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L38) +[lib/provable/merkle-map.ts:55](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L55) diff --git a/docs/zkapps/o1js-reference/classes/MerkleMapWitness.mdx b/docs/zkapps/o1js-reference/classes/MerkleMapWitness.mdx index 6387c07aa..10478bf09 100644 --- a/docs/zkapps/o1js-reference/classes/MerkleMapWitness.mdx +++ b/docs/zkapps/o1js-reference/classes/MerkleMapWitness.mdx @@ -26,7 +26,7 @@ new MerkleMapWitness(isLefts: Bool[], siblings: Field[]): MerkleMapWitness #### Source -[lib/provable/merkle-map.ts:78](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L78) +[lib/provable/merkle-map.ts:110](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L110) ## Properties @@ -38,7 +38,7 @@ isLefts: Bool[]; #### Source -[lib/provable/merkle-map.ts:75](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L75) +[lib/provable/merkle-map.ts:107](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L107) *** @@ -50,7 +50,7 @@ siblings: Field[]; #### Source -[lib/provable/merkle-map.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L76) +[lib/provable/merkle-map.ts:108](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L108) ## Methods @@ -74,17 +74,41 @@ assertEquals(x: this): void #### Source -[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L130) +[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L130) *** -### computeRootAndKey() +### ~~computeRootAndKey()~~ ```ts computeRootAndKey(value: Field): Field[] ``` -computes the merkle tree root for a given value and the key for this witness +#### Parameters + +• **value**: [`Field`](Field.mdx) + +#### Returns + +[`Field`](Field.mdx)[] + +#### Deprecated + +This method is deprecated and will be removed in the next release. Please use [computeRootAndKeyV2](MerkleMapWitness.mdx#computerootandkeyv2) instead. + +#### Source + +[lib/provable/merkle-map.ts:119](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L119) + +*** + +### computeRootAndKeyV2() + +```ts +computeRootAndKeyV2(value: Field): Field[] +``` + +Computes the merkle tree root for a given value and the key for this witness #### Parameters @@ -100,7 +124,7 @@ A tuple of the computed merkle root, and the key that is connected to the path u #### Source -[lib/provable/merkle-map.ts:89](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-map.ts#L89) +[lib/provable/merkle-map.ts:145](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-map.ts#L145) *** @@ -124,7 +148,7 @@ equals(x: this): Bool #### Source -[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L126) +[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L126) *** @@ -144,7 +168,7 @@ isConstant(): boolean #### Source -[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L134) +[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L134) *** @@ -164,7 +188,7 @@ toConstant(): this #### Source -[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L122) +[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L122) *** @@ -184,7 +208,7 @@ toFields(): Field[] #### Source -[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L85) +[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L85) *** @@ -204,7 +228,7 @@ toJSON(): any #### Source -[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L118) +[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L118) *** @@ -234,7 +258,7 @@ static check(this: T, v: InstanceType): void #### Source -[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L163) +[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L163) *** @@ -258,7 +282,7 @@ static empty(): InstanceType #### Source -[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L218) +[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L218) *** @@ -288,7 +312,7 @@ static fromFields(this: T, xs: Field[]): InstanceType #### Source -[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L138) +[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L138) *** @@ -318,7 +342,7 @@ static fromJSON(this: T, value: any): InstanceType #### Source -[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L196) +[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L196) *** @@ -348,7 +372,7 @@ static fromObject(this: T, value: NonMethods>): InstanceType< #### Source -[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L30) +[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L30) *** @@ -378,7 +402,7 @@ static fromValue(this: T, value: any): InstanceType #### Source -[lib/provable/types/circuit-value.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L98) +[lib/provable/types/circuit-value.ts:98](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L98) *** @@ -398,7 +422,7 @@ static sizeInFields(): number #### Source -[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L37) +[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L37) *** @@ -418,7 +442,7 @@ static toAuxiliary(): [] #### Source -[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L59) +[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L59) *** @@ -448,7 +472,7 @@ static toConstant(this: T, t: InstanceType): InstanceType #### Source -[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L177) +[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L177) *** @@ -478,7 +502,7 @@ static toFields(this: T, v: InstanceType): Field[] #### Source -[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L42) +[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L42) *** @@ -508,7 +532,7 @@ static toInput(this: T, v: InstanceType): HashInput #### Source -[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L63) +[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L63) *** @@ -538,7 +562,7 @@ static toJSON(this: T, v: InstanceType): any #### Source -[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L185) +[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L185) *** @@ -568,4 +592,4 @@ static toValue(this: T, v: InstanceType): any #### Source -[lib/provable/types/circuit-value.ts:89](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L89) +[lib/provable/types/circuit-value.ts:89](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L89) diff --git a/docs/zkapps/o1js-reference/classes/MerkleTree.mdx b/docs/zkapps/o1js-reference/classes/MerkleTree.mdx index a3e934a69..2b60318f4 100644 --- a/docs/zkapps/o1js-reference/classes/MerkleTree.mdx +++ b/docs/zkapps/o1js-reference/classes/MerkleTree.mdx @@ -31,7 +31,7 @@ A new MerkleTree #### Source -[lib/provable/merkle-tree.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L37) +[lib/provable/merkle-tree.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L37) ## Properties @@ -45,7 +45,7 @@ The height of Merkle Tree. #### Source -[lib/provable/merkle-tree.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L37) +[lib/provable/merkle-tree.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L37) *** @@ -57,7 +57,7 @@ nodes: Record> = {}; #### Source -[lib/provable/merkle-tree.ts:29](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L29) +[lib/provable/merkle-tree.ts:29](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L29) *** @@ -69,7 +69,7 @@ zeroes: Field[]; #### Source -[lib/provable/merkle-tree.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L30) +[lib/provable/merkle-tree.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L30) ## Accessors @@ -89,7 +89,7 @@ Amount of leaf nodes. #### Source -[lib/provable/merkle-tree.ts:166](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L166) +[lib/provable/merkle-tree.ts:166](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L166) ## Methods @@ -107,7 +107,7 @@ Return a new MerkleTree with the same contents as this one. #### Source -[lib/provable/merkle-tree.ts:48](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L48) +[lib/provable/merkle-tree.ts:48](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L48) *** @@ -131,7 +131,7 @@ Values to fill the leaves with. #### Source -[lib/provable/merkle-tree.ts:156](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L156) +[lib/provable/merkle-tree.ts:156](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L156) *** @@ -155,7 +155,7 @@ The data of the leaf. #### Source -[lib/provable/merkle-tree.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L71) +[lib/provable/merkle-tree.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L71) *** @@ -185,7 +185,7 @@ The data of the node. #### Source -[lib/provable/merkle-tree.ts:62](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L62) +[lib/provable/merkle-tree.ts:62](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L62) *** @@ -205,7 +205,7 @@ The root of the Merkle Tree. #### Source -[lib/provable/merkle-tree.ts:79](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L79) +[lib/provable/merkle-tree.ts:79](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L79) *** @@ -231,7 +231,7 @@ The witness that belongs to the leaf. #### Source -[lib/provable/merkle-tree.ts:117](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L117) +[lib/provable/merkle-tree.ts:117](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L117) *** @@ -259,7 +259,7 @@ New value. #### Source -[lib/provable/merkle-tree.ts:94](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L94) +[lib/provable/merkle-tree.ts:94](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L94) *** @@ -285,4 +285,4 @@ True if the witness for the leaf node is valid. #### Source -[lib/provable/merkle-tree.ts:139](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L139) +[lib/provable/merkle-tree.ts:139](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L139) diff --git a/docs/zkapps/o1js-reference/classes/Nullifier.mdx b/docs/zkapps/o1js-reference/classes/Nullifier.mdx index 22530616a..7e363c5dd 100644 --- a/docs/zkapps/o1js-reference/classes/Nullifier.mdx +++ b/docs/zkapps/o1js-reference/classes/Nullifier.mdx @@ -80,7 +80,7 @@ new Nullifier(value: { #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) ## Properties @@ -129,7 +129,7 @@ h_m_pk_r: Group = Group; #### Source -[lib/provable/crypto/nullifier.ts:26](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L26) +[lib/provable/crypto/nullifier.ts:26](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L26) *** @@ -171,7 +171,7 @@ s: Scalar = Scalar; #### Source -[lib/provable/crypto/nullifier.ts:22](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L22) +[lib/provable/crypto/nullifier.ts:22](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L22) *** @@ -198,7 +198,7 @@ publicKey: Group = Group; #### Source -[lib/provable/crypto/nullifier.ts:21](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L21) +[lib/provable/crypto/nullifier.ts:21](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L21) *** @@ -225,7 +225,7 @@ static _isStruct: true; #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) *** @@ -294,7 +294,7 @@ the element of type `T` to put assertions on. #### Source -[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L66) +[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L66) *** @@ -404,7 +404,7 @@ publicKey: Group = Group; #### Source -[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L154) +[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L154) *** @@ -518,7 +518,7 @@ publicKey: Group = Group; #### Source -[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L87) +[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L87) *** @@ -602,7 +602,7 @@ Convert provable type from a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L76) +[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L76) *** @@ -670,7 +670,7 @@ If not provided, a default value for auxiliary data is returned. #### Source -[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L37) +[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L37) *** @@ -737,7 +737,7 @@ the element of type `T` to generate the [Field](Field.mdx) array from. #### Source -[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L26) +[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L26) *** @@ -819,7 +819,7 @@ optional packed: [Field, number][]; #### Source -[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L148) +[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L148) *** @@ -1020,7 +1020,7 @@ y: string; #### Source -[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L152) +[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L152) *** @@ -1223,7 +1223,7 @@ y: bigint; #### Source -[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L71) +[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L71) ## Methods @@ -1254,7 +1254,7 @@ nullifier.assertUnused(); #### Source -[lib/provable/crypto/nullifier.ts:128](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L128) +[lib/provable/crypto/nullifier.ts:128](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L128) *** @@ -1278,7 +1278,7 @@ let pk = nullifier.getPublicKey(); #### Source -[lib/provable/crypto/nullifier.ts:157](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L157) +[lib/provable/crypto/nullifier.ts:157](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L157) *** @@ -1309,7 +1309,7 @@ let isUnused = nullifier.isUnused(); #### Source -[lib/provable/crypto/nullifier.ts:108](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L108) +[lib/provable/crypto/nullifier.ts:108](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L108) *** @@ -1335,7 +1335,7 @@ let key = nullifier.key(); #### Source -[lib/provable/crypto/nullifier.ts:95](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L95) +[lib/provable/crypto/nullifier.ts:95](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L95) *** @@ -1364,7 +1364,7 @@ let newRoot = nullifier.setUsed(witness); #### Source -[lib/provable/crypto/nullifier.ts:143](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L143) +[lib/provable/crypto/nullifier.ts:143](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L143) *** @@ -1394,7 +1394,7 @@ nullifier.verify(nullifierMessage); #### Source -[lib/provable/crypto/nullifier.ts:47](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L47) +[lib/provable/crypto/nullifier.ts:47](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L47) *** @@ -1423,7 +1423,7 @@ https://eprint.iacr.org/2022/1255.pdf chapter 3 page 14 #### Source -[lib/provable/crypto/nullifier.ts:170](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L170) +[lib/provable/crypto/nullifier.ts:170](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L170) *** @@ -1458,7 +1458,7 @@ static fromJSON(json: Nullifier): Nullifier #### Source -[lib/provable/crypto/nullifier.ts:32](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/nullifier.ts#L32) +[lib/provable/crypto/nullifier.ts:32](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/nullifier.ts#L32) *** @@ -1493,4 +1493,4 @@ A `number` representing the size of the `T` type in terms of [Field](Field.mdx) #### Source -[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L56) +[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L56) diff --git a/docs/zkapps/o1js-reference/classes/Packed.mdx b/docs/zkapps/o1js-reference/classes/Packed.mdx index ce22867c5..ebe94ab0b 100644 --- a/docs/zkapps/o1js-reference/classes/Packed.mdx +++ b/docs/zkapps/o1js-reference/classes/Packed.mdx @@ -54,7 +54,7 @@ new Packed(packed: Field[], value: Unconstrained): Packed #### Source -[lib/provable/packed.ts:77](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L77) +[lib/provable/packed.ts:77](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L77) ## Properties @@ -66,7 +66,7 @@ packed: Field[]; #### Source -[lib/provable/packed.ts:46](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L46) +[lib/provable/packed.ts:46](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L46) *** @@ -78,7 +78,7 @@ value: Unconstrained; #### Source -[lib/provable/packed.ts:47](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L47) +[lib/provable/packed.ts:47](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L47) *** @@ -90,7 +90,7 @@ static _innerProvable: undefined | ProvableExtended; #### Source -[lib/provable/packed.ts:119](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L119) +[lib/provable/packed.ts:119](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L119) *** @@ -102,7 +102,7 @@ static _provable: undefined | ProvableHashable>; #### Source -[lib/provable/packed.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L118) +[lib/provable/packed.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L118) ## Accessors @@ -118,7 +118,7 @@ get Constructor(): typeof Packed #### Source -[lib/provable/packed.ts:121](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L121) +[lib/provable/packed.ts:121](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L121) *** @@ -134,7 +134,7 @@ get static innerProvable(): ProvableExtended #### Source -[lib/provable/packed.ts:125](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L125) +[lib/provable/packed.ts:125](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L125) ## Methods @@ -150,7 +150,7 @@ toFields(): Field[] #### Source -[lib/provable/packed.ts:113](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L113) +[lib/provable/packed.ts:113](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L113) *** @@ -168,7 +168,7 @@ Unpack a value. #### Source -[lib/provable/packed.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L98) +[lib/provable/packed.ts:98](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L98) *** @@ -198,7 +198,7 @@ Create a packed representation of `type`. You can then use `PackedType.pack(x)` #### Source -[lib/provable/packed.ts:52](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L52) +[lib/provable/packed.ts:52](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L52) *** @@ -224,4 +224,4 @@ Pack a value. #### Source -[lib/provable/packed.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/packed.ts#L85) +[lib/provable/packed.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/packed.ts#L85) diff --git a/docs/zkapps/o1js-reference/classes/PrivateKey.mdx b/docs/zkapps/o1js-reference/classes/PrivateKey.mdx index 022023a32..900d4a2fb 100644 --- a/docs/zkapps/o1js-reference/classes/PrivateKey.mdx +++ b/docs/zkapps/o1js-reference/classes/PrivateKey.mdx @@ -26,7 +26,7 @@ new PrivateKey(s: Scalar): PrivateKey #### Source -[lib/provable/crypto/signature.ts:25](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L25) +[lib/provable/crypto/signature.ts:25](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L25) ## Properties @@ -38,7 +38,7 @@ s: Scalar; #### Source -[lib/provable/crypto/signature.ts:23](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L23) +[lib/provable/crypto/signature.ts:23](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L23) ## Methods @@ -62,7 +62,7 @@ assertEquals(x: this): void #### Source -[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L130) +[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L130) *** @@ -86,7 +86,7 @@ equals(x: this): Bool #### Source -[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L126) +[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L126) *** @@ -106,7 +106,7 @@ isConstant(): boolean #### Source -[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L134) +[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L134) *** @@ -126,7 +126,7 @@ a base58 encoded string #### Source -[lib/provable/crypto/signature.ts:105](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L105) +[lib/provable/crypto/signature.ts:105](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L105) *** @@ -144,7 +144,7 @@ Convert this [PrivateKey](PrivateKey.mdx) to a bigint #### Source -[lib/provable/crypto/signature.ts:68](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L68) +[lib/provable/crypto/signature.ts:68](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L68) *** @@ -164,7 +164,7 @@ toConstant(): this #### Source -[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L122) +[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L122) *** @@ -184,7 +184,7 @@ toFields(): Field[] #### Source -[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L85) +[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L85) *** @@ -204,7 +204,7 @@ toJSON(): any #### Source -[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L118) +[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L118) *** @@ -224,7 +224,7 @@ a [PublicKey](PublicKey.mdx). #### Source -[lib/provable/crypto/signature.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L87) +[lib/provable/crypto/signature.ts:87](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L87) *** @@ -254,7 +254,7 @@ static check(this: T, v: InstanceType): void #### Source -[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L163) +[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L163) *** @@ -278,7 +278,7 @@ static empty(): InstanceType #### Source -[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L218) +[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L218) *** @@ -302,7 +302,7 @@ a [PrivateKey](PrivateKey.mdx). #### Source -[lib/provable/crypto/signature.ts:96](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L96) +[lib/provable/crypto/signature.ts:96](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L96) *** @@ -327,7 +327,7 @@ Be careful that you don't use this method to create private keys that were sampl #### Source -[lib/provable/crypto/signature.ts:78](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L78) +[lib/provable/crypto/signature.ts:78](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L78) *** @@ -353,7 +353,7 @@ a [PrivateKey](PrivateKey.mdx). #### Source -[lib/provable/crypto/signature.ts:61](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L61) +[lib/provable/crypto/signature.ts:61](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L61) *** @@ -383,7 +383,7 @@ static fromFields(this: T, xs: Field[]): InstanceType #### Source -[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L138) +[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L138) *** @@ -413,7 +413,7 @@ static fromJSON(this: T, value: any): InstanceType #### Source -[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L196) +[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L196) *** @@ -443,7 +443,7 @@ static fromObject(this: T, value: NonMethods>): InstanceType< #### Source -[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L30) +[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L30) *** @@ -473,7 +473,7 @@ static fromValue(this: T, v: bigint | PrivateKey): InstanceType #### Source -[lib/provable/crypto/signature.ts:121](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L121) +[lib/provable/crypto/signature.ts:121](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L121) *** @@ -499,7 +499,7 @@ a new [PrivateKey](PrivateKey.mdx). #### Source -[lib/provable/crypto/signature.ts:40](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L40) +[lib/provable/crypto/signature.ts:40](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L40) *** @@ -540,7 +540,7 @@ publicKey: PublicKey; #### Source -[lib/provable/crypto/signature.ts:50](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L50) +[lib/provable/crypto/signature.ts:50](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L50) *** @@ -560,7 +560,7 @@ static sizeInFields(): number #### Source -[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L37) +[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L37) *** @@ -580,7 +580,7 @@ static toAuxiliary(): [] #### Source -[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L59) +[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L59) *** @@ -608,7 +608,7 @@ a base58 encoded string #### Source -[lib/provable/crypto/signature.ts:114](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L114) +[lib/provable/crypto/signature.ts:114](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L114) *** @@ -638,7 +638,7 @@ static toConstant(this: T, t: InstanceType): InstanceType #### Source -[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L177) +[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L177) *** @@ -668,7 +668,7 @@ static toFields(this: T, v: InstanceType): Field[] #### Source -[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L42) +[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L42) *** @@ -698,7 +698,7 @@ static toInput(this: T, v: InstanceType): HashInput #### Source -[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L63) +[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L63) *** @@ -728,7 +728,7 @@ static toJSON(this: T, v: InstanceType): any #### Source -[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L185) +[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L185) *** @@ -752,4 +752,4 @@ static toValue(v: PrivateKey): bigint #### Source -[lib/provable/crypto/signature.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L118) +[lib/provable/crypto/signature.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L118) diff --git a/docs/zkapps/o1js-reference/classes/Proof.mdx b/docs/zkapps/o1js-reference/classes/Proof.mdx index f04c0115d..686ff47ae 100644 --- a/docs/zkapps/o1js-reference/classes/Proof.mdx +++ b/docs/zkapps/o1js-reference/classes/Proof.mdx @@ -43,7 +43,7 @@ new Proof(__namedParameters: { #### Source -[lib/proof-system/zkprogram.ts:111](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L111) +[lib/proof-system/zkprogram.ts:233](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L233) ## Properties @@ -59,7 +59,7 @@ maxProofsVerified: 0 | 1 | 2; #### Source -[lib/proof-system/zkprogram.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L98) +[lib/proof-system/zkprogram.ts:220](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L220) *** @@ -75,7 +75,7 @@ proof: unknown; #### Source -[lib/proof-system/zkprogram.ts:97](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L97) +[lib/proof-system/zkprogram.ts:219](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L219) *** @@ -91,7 +91,7 @@ publicInput: Input; #### Source -[lib/proof-system/zkprogram.ts:95](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L95) +[lib/proof-system/zkprogram.ts:217](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L217) *** @@ -107,7 +107,7 @@ publicOutput: Output; #### Source -[lib/proof-system/zkprogram.ts:96](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L96) +[lib/proof-system/zkprogram.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L218) *** @@ -123,7 +123,7 @@ shouldVerify: Bool; #### Source -[lib/proof-system/zkprogram.ts:99](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L99) +[lib/proof-system/zkprogram.ts:221](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L221) *** @@ -139,7 +139,7 @@ static publicInputType: FlexibleProvablePure; #### Source -[lib/proof-system/zkprogram.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L87) +[lib/proof-system/zkprogram.ts:209](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L209) *** @@ -155,7 +155,7 @@ static publicOutputType: FlexibleProvablePure; #### Source -[lib/proof-system/zkprogram.ts:88](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L88) +[lib/proof-system/zkprogram.ts:210](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L210) *** @@ -187,7 +187,7 @@ name: string; #### Source -[lib/proof-system/zkprogram.ts:89](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L89) +[lib/proof-system/zkprogram.ts:211](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L211) ## Methods @@ -207,7 +207,7 @@ toJSON(): JsonProof #### Source -[lib/proof-system/zkprogram.ts:101](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L101) +[lib/proof-system/zkprogram.ts:223](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L223) *** @@ -223,7 +223,7 @@ verify(): void #### Source -[lib/proof-system/zkprogram.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L130) +[lib/proof-system/zkprogram.ts:252](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L252) *** @@ -243,7 +243,7 @@ verifyIf(condition: Bool): void #### Source -[lib/proof-system/zkprogram.ts:133](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L133) +[lib/proof-system/zkprogram.ts:255](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L255) *** @@ -299,7 +299,7 @@ must match your ZkProgram. `maxProofsVerified` is the maximum number of proofs t #### Source -[lib/proof-system/zkprogram.ts:185](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L185) +[lib/proof-system/zkprogram.ts:307](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L307) *** @@ -325,4 +325,4 @@ static fromJSON(this: S, __namedParameters: JsonProof): Promise(__namedParameters: { #### Source -[lib/proof-system/zkprogram.ts:111](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L111) +[lib/proof-system/zkprogram.ts:233](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L233) ## Properties @@ -52,7 +52,7 @@ maxProofsVerified: 0 | 1 | 2; #### Source -[lib/proof-system/zkprogram.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L98) +[lib/proof-system/zkprogram.ts:220](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L220) *** @@ -64,7 +64,7 @@ proof: unknown; #### Source -[lib/proof-system/zkprogram.ts:97](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L97) +[lib/proof-system/zkprogram.ts:219](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L219) *** @@ -76,7 +76,7 @@ publicInput: Input; #### Source -[lib/proof-system/zkprogram.ts:95](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L95) +[lib/proof-system/zkprogram.ts:217](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L217) *** @@ -88,7 +88,7 @@ publicOutput: Output; #### Source -[lib/proof-system/zkprogram.ts:96](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L96) +[lib/proof-system/zkprogram.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L218) *** @@ -100,7 +100,7 @@ shouldVerify: Bool; #### Source -[lib/proof-system/zkprogram.ts:99](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L99) +[lib/proof-system/zkprogram.ts:221](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L221) *** @@ -112,7 +112,7 @@ static publicInputType: FlexibleProvablePure; #### Source -[lib/proof-system/zkprogram.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L87) +[lib/proof-system/zkprogram.ts:209](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L209) *** @@ -124,7 +124,7 @@ static publicOutputType: FlexibleProvablePure; #### Source -[lib/proof-system/zkprogram.ts:88](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L88) +[lib/proof-system/zkprogram.ts:210](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L210) *** @@ -152,7 +152,7 @@ name: string; #### Source -[lib/proof-system/zkprogram.ts:89](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L89) +[lib/proof-system/zkprogram.ts:211](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L211) ## Methods @@ -168,4 +168,4 @@ toJSON(): JsonProof #### Source -[lib/proof-system/zkprogram.ts:101](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L101) +[lib/proof-system/zkprogram.ts:223](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L223) diff --git a/docs/zkapps/o1js-reference/classes/PublicKey.mdx b/docs/zkapps/o1js-reference/classes/PublicKey.mdx index 9c085fd4b..15eb40738 100644 --- a/docs/zkapps/o1js-reference/classes/PublicKey.mdx +++ b/docs/zkapps/o1js-reference/classes/PublicKey.mdx @@ -27,7 +27,7 @@ new PublicKey(...props: any[]): PublicKey #### Source -[lib/provable/types/circuit-value.ts:13](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L13) +[lib/provable/types/circuit-value.ts:13](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L13) ## Properties @@ -39,7 +39,7 @@ isOdd: Bool; #### Source -[lib/provable/crypto/signature.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L138) +[lib/provable/crypto/signature.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L138) *** @@ -51,7 +51,7 @@ x: Field; #### Source -[lib/provable/crypto/signature.ts:137](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L137) +[lib/provable/crypto/signature.ts:137](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L137) ## Methods @@ -75,7 +75,7 @@ assertEquals(x: this): void #### Source -[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L130) +[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L130) *** @@ -99,7 +99,7 @@ equals(x: this): Bool #### Source -[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L126) +[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L126) *** @@ -119,7 +119,7 @@ isConstant(): boolean #### Source -[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L134) +[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L134) *** @@ -139,7 +139,7 @@ a [Bool](../variables/Bool.mdx) #### Source -[lib/provable/crypto/signature.ts:193](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L193) +[lib/provable/crypto/signature.ts:193](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L193) *** @@ -159,7 +159,7 @@ a base58 encoded [PublicKey](PublicKey.mdx) #### Source -[lib/provable/crypto/signature.ts:211](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L211) +[lib/provable/crypto/signature.ts:211](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L211) *** @@ -179,7 +179,7 @@ toConstant(): this #### Source -[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L122) +[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L122) *** @@ -199,7 +199,7 @@ toFields(): Field[] #### Source -[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L85) +[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L85) *** @@ -219,7 +219,7 @@ A [Group](../variables/Group.mdx) #### Source -[lib/provable/crypto/signature.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L144) +[lib/provable/crypto/signature.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L144) *** @@ -239,7 +239,7 @@ toJSON(): any #### Source -[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L118) +[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L118) *** @@ -269,7 +269,7 @@ static check(this: T, v: InstanceType): void #### Source -[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L163) +[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L163) *** @@ -297,7 +297,7 @@ an empty [PublicKey](PublicKey.mdx) #### Source -[lib/provable/crypto/signature.ts:185](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L185) +[lib/provable/crypto/signature.ts:185](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L185) *** @@ -328,7 +328,7 @@ a [PublicKey](PublicKey.mdx). #### Source -[lib/provable/crypto/signature.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L177) +[lib/provable/crypto/signature.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L177) *** @@ -352,7 +352,7 @@ a [PublicKey](PublicKey.mdx) #### Source -[lib/provable/crypto/signature.ts:202](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L202) +[lib/provable/crypto/signature.ts:202](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L202) *** @@ -382,7 +382,7 @@ static fromFields(this: T, xs: Field[]): InstanceType #### Source -[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L138) +[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L138) *** @@ -406,7 +406,7 @@ a [PublicKey](PublicKey.mdx). #### Source -[lib/provable/crypto/signature.ts:161](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L161) +[lib/provable/crypto/signature.ts:161](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L161) *** @@ -440,7 +440,7 @@ a JSON string #### Source -[lib/provable/crypto/signature.ts:239](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L239) +[lib/provable/crypto/signature.ts:239](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L239) *** @@ -470,7 +470,7 @@ static fromObject(this: T, value: NonMethods>): InstanceType< #### Source -[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L30) +[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L30) *** @@ -494,7 +494,7 @@ a [PublicKey](PublicKey.mdx). #### Source -[lib/provable/crypto/signature.ts:169](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L169) +[lib/provable/crypto/signature.ts:169](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L169) *** @@ -531,7 +531,7 @@ static fromValue(this: T, __namedParameters: { #### Source -[lib/provable/crypto/signature.ts:246](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L246) +[lib/provable/crypto/signature.ts:246](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L246) *** @@ -551,7 +551,7 @@ static sizeInFields(): number #### Source -[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L37) +[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L37) *** @@ -571,7 +571,7 @@ static toAuxiliary(): [] #### Source -[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L59) +[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L59) *** @@ -595,7 +595,7 @@ a base58 encoded [PublicKey](PublicKey.mdx) #### Source -[lib/provable/crypto/signature.ts:219](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L219) +[lib/provable/crypto/signature.ts:219](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L219) *** @@ -625,7 +625,7 @@ static toConstant(this: T, t: InstanceType): InstanceType #### Source -[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L177) +[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L177) *** @@ -655,7 +655,7 @@ static toFields(this: T, v: InstanceType): Field[] #### Source -[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L42) +[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L42) *** @@ -685,7 +685,7 @@ static toInput(this: T, v: InstanceType): HashInput #### Source -[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L63) +[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L63) *** @@ -713,7 +713,7 @@ a JSON string #### Source -[lib/provable/crypto/signature.ts:231](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L231) +[lib/provable/crypto/signature.ts:231](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L231) *** @@ -757,4 +757,4 @@ x: bigint; #### Source -[lib/provable/crypto/signature.ts:243](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L243) +[lib/provable/crypto/signature.ts:243](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L243) diff --git a/docs/zkapps/o1js-reference/classes/Scalar.mdx b/docs/zkapps/o1js-reference/classes/Scalar.mdx index 8c7743518..8519c0f8d 100644 --- a/docs/zkapps/o1js-reference/classes/Scalar.mdx +++ b/docs/zkapps/o1js-reference/classes/Scalar.mdx @@ -18,7 +18,7 @@ high254: Field; #### Source -[lib/provable/scalar.ts:31](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L31) +[lib/provable/scalar.ts:31](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L31) *** @@ -38,7 +38,7 @@ The reason is that we can efficiently compute the scalar multiplication `(t + 2^ #### Source -[lib/provable/scalar.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L30) +[lib/provable/scalar.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L30) *** @@ -50,7 +50,7 @@ static ORDER: bigint = Fq.modulus; #### Source -[lib/provable/scalar.ts:33](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L33) +[lib/provable/scalar.ts:33](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L33) ## Methods @@ -74,7 +74,7 @@ Add scalar field elements. #### Source -[lib/provable/scalar.ts:135](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L135) +[lib/provable/scalar.ts:135](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L135) *** @@ -99,7 +99,7 @@ Throws if the denominator is zero. #### Source -[lib/provable/scalar.ts:172](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L172) +[lib/provable/scalar.ts:172](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L172) *** @@ -118,7 +118,7 @@ If a [Scalar](Scalar.mdx) is constructed outside provable code, it is a constant #### Source -[lib/provable/scalar.ts:67](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L67) +[lib/provable/scalar.ts:67](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L67) *** @@ -142,7 +142,7 @@ Multiply scalar field elements. #### Source -[lib/provable/scalar.ts:159](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L159) +[lib/provable/scalar.ts:159](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L159) *** @@ -162,7 +162,7 @@ Negate a scalar field element. #### Source -[lib/provable/scalar.ts:124](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L124) +[lib/provable/scalar.ts:124](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L124) *** @@ -186,7 +186,7 @@ Subtract scalar field elements. #### Source -[lib/provable/scalar.ts:147](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L147) +[lib/provable/scalar.ts:147](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L147) *** @@ -204,7 +204,7 @@ Convert this [Scalar](Scalar.mdx) into a bigint #### Source -[lib/provable/scalar.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L87) +[lib/provable/scalar.ts:87](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L87) *** @@ -226,7 +226,7 @@ See FieldVar for an explanation of constants vs. variables. #### Source -[lib/provable/scalar.ts:79](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L79) +[lib/provable/scalar.ts:79](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L79) *** @@ -251,7 +251,7 @@ that can be used outside proofs. #### Source -[lib/provable/scalar.ts:225](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L225) +[lib/provable/scalar.ts:225](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L225) *** @@ -294,7 +294,7 @@ highBit: Bool; #### Source -[lib/provable/scalar.ts:188](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L188) +[lib/provable/scalar.ts:188](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L188) *** @@ -312,7 +312,7 @@ Serializes this Scalar to a string #### Source -[lib/provable/scalar.ts:309](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L309) +[lib/provable/scalar.ts:309](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L309) *** @@ -334,7 +334,7 @@ Part of the [Provable](../type-aliases/Provable.mdx) interface. #### Source -[lib/provable/scalar.ts:279](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L279) +[lib/provable/scalar.ts:279](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L279) *** @@ -350,7 +350,7 @@ static empty(): Scalar #### Source -[lib/provable/scalar.ts:321](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L321) +[lib/provable/scalar.ts:321](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L321) *** @@ -374,7 +374,7 @@ If the input is too large, it is reduced modulo the scalar field size. #### Source -[lib/provable/scalar.ts:45](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L45) +[lib/provable/scalar.ts:45](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L45) *** @@ -397,7 +397,7 @@ This method is provable. #### Source -[lib/provable/scalar.ts:97](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L97) +[lib/provable/scalar.ts:97](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L97) *** @@ -421,7 +421,7 @@ This is always possible and unambiguous, since the scalar field is larger than t #### Source -[lib/provable/scalar.ts:58](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L58) +[lib/provable/scalar.ts:58](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L58) *** @@ -445,7 +445,7 @@ Creates a data structure from an array of serialized [Field](Field.mdx) elements #### Source -[lib/provable/scalar.ts:257](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L257) +[lib/provable/scalar.ts:257](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L257) *** @@ -468,7 +468,7 @@ This operation does _not_ affect the circuit and can't be used to prove anything #### Source -[lib/provable/scalar.ts:317](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L317) +[lib/provable/scalar.ts:317](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L317) *** @@ -488,7 +488,7 @@ static fromValue(x: bigint): Scalar #### Source -[lib/provable/scalar.ts:291](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L291) +[lib/provable/scalar.ts:291](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L291) *** @@ -507,7 +507,7 @@ Randomness can not be proven inside a circuit! #### Source -[lib/provable/scalar.ts:113](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L113) +[lib/provable/scalar.ts:113](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L113) *** @@ -527,7 +527,7 @@ Returns the size of this type in [Field](Field.mdx) elements. #### Source -[lib/provable/scalar.ts:272](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L272) +[lib/provable/scalar.ts:272](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L272) *** @@ -547,7 +547,7 @@ Serialize a [Scalar](Scalar.mdx) into its auxiliary data, which are empty. #### Source -[lib/provable/scalar.ts:248](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L248) +[lib/provable/scalar.ts:248](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L248) *** @@ -575,7 +575,7 @@ The fields are not constrained to be boolean. #### Source -[lib/provable/scalar.ts:211](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L211) +[lib/provable/scalar.ts:211](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L211) *** @@ -601,7 +601,7 @@ An object where the `fields` key is a [Field](Field.mdx) array of length 1 creat #### Source -[lib/provable/scalar.ts:239](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L239) +[lib/provable/scalar.ts:239](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L239) *** @@ -624,7 +624,7 @@ This operation does _not_ affect the circuit and can't be used to prove anything #### Source -[lib/provable/scalar.ts:301](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L301) +[lib/provable/scalar.ts:301](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L301) *** @@ -644,4 +644,4 @@ static toValue(x: Scalar): bigint #### Source -[lib/provable/scalar.ts:287](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L287) +[lib/provable/scalar.ts:287](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L287) diff --git a/docs/zkapps/o1js-reference/classes/SelfProof.mdx b/docs/zkapps/o1js-reference/classes/SelfProof.mdx index 28494e84b..526742273 100644 --- a/docs/zkapps/o1js-reference/classes/SelfProof.mdx +++ b/docs/zkapps/o1js-reference/classes/SelfProof.mdx @@ -43,7 +43,7 @@ new SelfProof(__namedParameters: { #### Source -[lib/proof-system/zkprogram.ts:111](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L111) +[lib/proof-system/zkprogram.ts:233](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L233) ## Properties @@ -59,7 +59,7 @@ maxProofsVerified: 0 | 1 | 2; #### Source -[lib/proof-system/zkprogram.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L98) +[lib/proof-system/zkprogram.ts:220](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L220) *** @@ -75,7 +75,7 @@ proof: unknown; #### Source -[lib/proof-system/zkprogram.ts:97](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L97) +[lib/proof-system/zkprogram.ts:219](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L219) *** @@ -91,7 +91,7 @@ publicInput: PublicInput; #### Source -[lib/proof-system/zkprogram.ts:95](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L95) +[lib/proof-system/zkprogram.ts:217](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L217) *** @@ -107,7 +107,7 @@ publicOutput: PublicOutput; #### Source -[lib/proof-system/zkprogram.ts:96](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L96) +[lib/proof-system/zkprogram.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L218) *** @@ -123,7 +123,7 @@ shouldVerify: Bool; #### Source -[lib/proof-system/zkprogram.ts:99](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L99) +[lib/proof-system/zkprogram.ts:221](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L221) *** @@ -139,7 +139,7 @@ static publicInputType: FlexibleProvablePure; #### Source -[lib/proof-system/zkprogram.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L87) +[lib/proof-system/zkprogram.ts:209](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L209) *** @@ -155,7 +155,7 @@ static publicOutputType: FlexibleProvablePure; #### Source -[lib/proof-system/zkprogram.ts:88](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L88) +[lib/proof-system/zkprogram.ts:210](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L210) *** @@ -187,7 +187,7 @@ name: string; #### Source -[lib/proof-system/zkprogram.ts:89](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L89) +[lib/proof-system/zkprogram.ts:211](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L211) ## Methods @@ -207,7 +207,7 @@ toJSON(): JsonProof #### Source -[lib/proof-system/zkprogram.ts:101](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L101) +[lib/proof-system/zkprogram.ts:223](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L223) *** @@ -227,7 +227,7 @@ verify(): void #### Source -[lib/proof-system/zkprogram.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L130) +[lib/proof-system/zkprogram.ts:252](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L252) *** @@ -251,7 +251,7 @@ verifyIf(condition: Bool): void #### Source -[lib/proof-system/zkprogram.ts:133](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L133) +[lib/proof-system/zkprogram.ts:255](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L255) *** @@ -311,7 +311,7 @@ must match your ZkProgram. `maxProofsVerified` is the maximum number of proofs t #### Source -[lib/proof-system/zkprogram.ts:185](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L185) +[lib/proof-system/zkprogram.ts:307](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L307) *** @@ -341,4 +341,4 @@ static fromJSON(this: S, __namedParameters: JsonProof): Promise(): InstanceType #### Source -[lib/provable/int.ts:974](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L974) +[lib/provable/int.ts:974](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L974) *** @@ -342,7 +358,7 @@ static fromFields(this: T, xs: Field[]): InstanceType #### Source -[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L138) +[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L138) *** @@ -370,7 +386,7 @@ static fromJSON(x: "Positive" | "Negative"): InstanceType #### Source -[lib/provable/int.ts:985](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L985) +[lib/provable/int.ts:985](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L985) *** @@ -400,7 +416,7 @@ static fromObject(this: T, value: NonMethods>): InstanceType< #### Source -[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L30) +[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L30) *** @@ -428,7 +444,7 @@ static fromValue(x: bigint | Sign): InstanceType #### Source -[lib/provable/int.ts:1007](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1007) +[lib/provable/int.ts:1011](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1011) *** @@ -448,7 +464,7 @@ static sizeInFields(): number #### Source -[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L37) +[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L37) *** @@ -468,7 +484,7 @@ static toAuxiliary(): [] #### Source -[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L59) +[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L59) *** @@ -498,7 +514,7 @@ static toConstant(this: T, t: InstanceType): InstanceType #### Source -[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L177) +[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L177) *** @@ -528,7 +544,7 @@ static toFields(this: T, v: InstanceType): Field[] #### Source -[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L42) +[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L42) *** @@ -552,7 +568,7 @@ static toInput(x: Sign): HashInput #### Source -[lib/provable/int.ts:977](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L977) +[lib/provable/int.ts:977](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L977) *** @@ -576,7 +592,7 @@ static toJSON(x: Sign): "Positive" | "Negative" #### Source -[lib/provable/int.ts:980](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L980) +[lib/provable/int.ts:980](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L980) *** @@ -600,4 +616,4 @@ static toValue(x: Sign): Sign #### Source -[lib/provable/int.ts:1003](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1003) +[lib/provable/int.ts:1007](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1007) diff --git a/docs/zkapps/o1js-reference/classes/Signature.mdx b/docs/zkapps/o1js-reference/classes/Signature.mdx index af0ab466a..bd0aad3d6 100644 --- a/docs/zkapps/o1js-reference/classes/Signature.mdx +++ b/docs/zkapps/o1js-reference/classes/Signature.mdx @@ -26,7 +26,7 @@ new Signature(...props: any[]): Signature #### Source -[lib/provable/types/circuit-value.ts:13](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L13) +[lib/provable/types/circuit-value.ts:13](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L13) ## Properties @@ -38,7 +38,7 @@ r: Field; #### Source -[lib/provable/crypto/signature.ts:258](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L258) +[lib/provable/crypto/signature.ts:258](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L258) *** @@ -50,7 +50,7 @@ s: Scalar; #### Source -[lib/provable/crypto/signature.ts:259](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L259) +[lib/provable/crypto/signature.ts:259](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L259) ## Methods @@ -74,7 +74,7 @@ assertEquals(x: this): void #### Source -[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L130) +[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L130) *** @@ -98,7 +98,7 @@ equals(x: this): Bool #### Source -[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L126) +[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L126) *** @@ -118,7 +118,7 @@ isConstant(): boolean #### Source -[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L134) +[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L134) *** @@ -136,7 +136,7 @@ Encodes a [Signature](Signature.mdx) in base58 format. #### Source -[lib/provable/crypto/signature.ts:321](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L321) +[lib/provable/crypto/signature.ts:321](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L321) *** @@ -156,7 +156,7 @@ toConstant(): this #### Source -[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L122) +[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L122) *** @@ -176,7 +176,7 @@ toFields(): Field[] #### Source -[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L85) +[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L85) *** @@ -196,7 +196,7 @@ toJSON(): any #### Source -[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L118) +[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L118) *** @@ -222,7 +222,7 @@ a [Bool](../variables/Bool.mdx) #### Source -[lib/provable/crypto/signature.ts:296](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L296) +[lib/provable/crypto/signature.ts:296](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L296) *** @@ -252,7 +252,7 @@ static check(this: T, v: InstanceType): void #### Source -[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L163) +[lib/provable/types/circuit-value.ts:163](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L163) *** @@ -278,7 +278,7 @@ a [Signature](Signature.mdx) #### Source -[lib/provable/crypto/signature.ts:265](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L265) +[lib/provable/crypto/signature.ts:265](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L265) *** @@ -302,7 +302,7 @@ static empty(): InstanceType #### Source -[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L218) +[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L218) *** @@ -324,7 +324,7 @@ Decodes a base58 encoded signature into a [Signature](Signature.mdx). #### Source -[lib/provable/crypto/signature.ts:314](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/signature.ts#L314) +[lib/provable/crypto/signature.ts:314](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/signature.ts#L314) *** @@ -354,7 +354,7 @@ static fromFields(this: T, xs: Field[]): InstanceType #### Source -[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L138) +[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L138) *** @@ -384,7 +384,7 @@ static fromJSON(this: T, value: any): InstanceType #### Source -[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L196) +[lib/provable/types/circuit-value.ts:196](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L196) *** @@ -414,7 +414,7 @@ static fromObject(this: T, value: NonMethods>): InstanceType< #### Source -[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L30) +[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L30) *** @@ -444,7 +444,7 @@ static fromValue(this: T, value: any): InstanceType #### Source -[lib/provable/types/circuit-value.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L98) +[lib/provable/types/circuit-value.ts:98](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L98) *** @@ -464,7 +464,7 @@ static sizeInFields(): number #### Source -[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L37) +[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L37) *** @@ -484,7 +484,7 @@ static toAuxiliary(): [] #### Source -[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L59) +[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L59) *** @@ -514,7 +514,7 @@ static toConstant(this: T, t: InstanceType): InstanceType #### Source -[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L177) +[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L177) *** @@ -544,7 +544,7 @@ static toFields(this: T, v: InstanceType): Field[] #### Source -[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L42) +[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L42) *** @@ -574,7 +574,7 @@ static toInput(this: T, v: InstanceType): HashInput #### Source -[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L63) +[lib/provable/types/circuit-value.ts:63](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L63) *** @@ -604,7 +604,7 @@ static toJSON(this: T, v: InstanceType): any #### Source -[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L185) +[lib/provable/types/circuit-value.ts:185](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L185) *** @@ -634,4 +634,4 @@ static toValue(this: T, v: InstanceType): any #### Source -[lib/provable/types/circuit-value.ts:89](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L89) +[lib/provable/types/circuit-value.ts:89](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L89) diff --git a/docs/zkapps/o1js-reference/classes/SmartContract.mdx b/docs/zkapps/o1js-reference/classes/SmartContract.mdx index cf3f161ab..85d8430e1 100644 --- a/docs/zkapps/o1js-reference/classes/SmartContract.mdx +++ b/docs/zkapps/o1js-reference/classes/SmartContract.mdx @@ -34,7 +34,7 @@ new SmartContract(address: PublicKey, tokenId?: Field): SmartContract #### Source -[lib/mina/zkapp.ts:614](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L614) +[lib/mina/zkapp.ts:614](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L614) ## Properties @@ -46,7 +46,7 @@ address: PublicKey; #### Source -[lib/mina/zkapp.ts:579](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L579) +[lib/mina/zkapp.ts:579](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L579) *** @@ -64,7 +64,7 @@ A list of event types that can be emitted using this.emitEvent()`. #### Source -[lib/mina/zkapp.ts:967](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L967) +[lib/mina/zkapp.ts:967](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L967) *** @@ -105,7 +105,7 @@ A malicious prover could use any other public key without affecting the validity #### Source -[lib/mina/zkapp.ts:870](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L870) +[lib/mina/zkapp.ts:870](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L870) *** @@ -117,7 +117,7 @@ tokenId: Field; #### Source -[lib/mina/zkapp.ts:580](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L580) +[lib/mina/zkapp.ts:580](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L580) *** @@ -129,7 +129,7 @@ static optional _maxProofsVerified: 0 | 2 | 1; #### Source -[lib/mina/zkapp.ts:599](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L599) +[lib/mina/zkapp.ts:599](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L599) *** @@ -146,7 +146,7 @@ static optional _methodMetadata: Record void): void #### Source -[lib/mina/zkapp.ts:1113](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L1113) +[lib/mina/zkapp.ts:1113](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L1113) diff --git a/docs/zkapps/o1js-reference/classes/TokenAccountUpdateIterator.mdx b/docs/zkapps/o1js-reference/classes/TokenAccountUpdateIterator.mdx index 9929841ed..e6962e8da 100644 --- a/docs/zkapps/o1js-reference/classes/TokenAccountUpdateIterator.mdx +++ b/docs/zkapps/o1js-reference/classes/TokenAccountUpdateIterator.mdx @@ -46,7 +46,7 @@ new TokenAccountUpdateIterator( #### Source -[lib/mina/token/forest-iterator.ts:56](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/forest-iterator.ts#L56) +[lib/mina/token/forest-iterator.ts:56](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/forest-iterator.ts#L56) ## Properties @@ -58,7 +58,7 @@ currentLayer: Layer; #### Source -[lib/mina/token/forest-iterator.ts:52](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/forest-iterator.ts#L52) +[lib/mina/token/forest-iterator.ts:52](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/forest-iterator.ts#L52) *** @@ -70,7 +70,7 @@ selfToken: Field; #### Source -[lib/mina/token/forest-iterator.ts:54](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/forest-iterator.ts#L54) +[lib/mina/token/forest-iterator.ts:54](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/forest-iterator.ts#L54) *** @@ -82,7 +82,7 @@ unfinishedParentLayers: MerkleList; #### Source -[lib/mina/token/forest-iterator.ts:53](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/forest-iterator.ts#L53) +[lib/mina/token/forest-iterator.ts:53](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/forest-iterator.ts#L53) ## Methods @@ -102,7 +102,7 @@ assertFinished(message?: string): void #### Source -[lib/mina/token/forest-iterator.ts:137](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/forest-iterator.ts#L137) +[lib/mina/token/forest-iterator.ts:137](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/forest-iterator.ts#L137) *** @@ -148,7 +148,7 @@ usesThisToken: Bool; #### Source -[lib/mina/token/forest-iterator.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/forest-iterator.ts#L85) +[lib/mina/token/forest-iterator.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/forest-iterator.ts#L85) *** @@ -170,4 +170,4 @@ static create(forest: AccountUpdateForest, selfToken: Field): TokenAccountUpdate #### Source -[lib/mina/token/forest-iterator.ts:66](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/forest-iterator.ts#L66) +[lib/mina/token/forest-iterator.ts:66](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/forest-iterator.ts#L66) diff --git a/docs/zkapps/o1js-reference/classes/TokenContract.mdx b/docs/zkapps/o1js-reference/classes/TokenContract.mdx index f51a263c6..bdbf772d1 100644 --- a/docs/zkapps/o1js-reference/classes/TokenContract.mdx +++ b/docs/zkapps/o1js-reference/classes/TokenContract.mdx @@ -30,7 +30,7 @@ new TokenContract(address: PublicKey, tokenId?: Field): TokenContract #### Source -[lib/mina/zkapp.ts:614](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L614) +[lib/mina/zkapp.ts:614](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L614) ## Properties @@ -46,7 +46,7 @@ address: PublicKey; #### Source -[lib/mina/zkapp.ts:579](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L579) +[lib/mina/zkapp.ts:579](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L579) *** @@ -68,7 +68,7 @@ A list of event types that can be emitted using this.emitEvent()`. #### Source -[lib/mina/zkapp.ts:967](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L967) +[lib/mina/zkapp.ts:967](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L967) *** @@ -113,7 +113,7 @@ A malicious prover could use any other public key without affecting the validity #### Source -[lib/mina/zkapp.ts:870](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L870) +[lib/mina/zkapp.ts:870](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L870) *** @@ -129,7 +129,7 @@ tokenId: Field; #### Source -[lib/mina/zkapp.ts:580](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L580) +[lib/mina/zkapp.ts:580](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L580) *** @@ -145,7 +145,7 @@ static optional _maxProofsVerified: 0 | 2 | 1; #### Source -[lib/mina/zkapp.ts:599](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L599) +[lib/mina/zkapp.ts:599](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L599) *** @@ -166,7 +166,7 @@ static optional _methodMetadata: Record #### Source -[lib/mina/token/token-contract.ts:83](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/token-contract.ts#L83) +[lib/mina/token/token-contract.ts:83](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/token-contract.ts#L83) *** @@ -571,7 +571,7 @@ This is provided out of the box as it is both a good example, and probably the m #### Source -[lib/mina/token/token-contract.ts:121](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/token-contract.ts#L121) +[lib/mina/token/token-contract.ts:121](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/token-contract.ts#L121) *** @@ -615,7 +615,7 @@ async deploy() { #### Source -[lib/mina/token/token-contract.ts:51](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/token-contract.ts#L51) +[lib/mina/token/token-contract.ts:51](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/token-contract.ts#L51) *** @@ -633,7 +633,7 @@ Returns the `tokenId` of the token managed by this contract. #### Source -[lib/mina/token/token-contract.ts:69](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/token-contract.ts#L69) +[lib/mina/token/token-contract.ts:69](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/token-contract.ts#L69) *** @@ -665,7 +665,7 @@ Emits an event. Events will be emitted as a part of the transaction and can be c #### Source -[lib/mina/zkapp.ts:973](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L973) +[lib/mina/zkapp.ts:973](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L973) *** @@ -744,7 +744,7 @@ console.log(events); #### Source -[lib/mina/zkapp.ts:1019](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L1019) +[lib/mina/zkapp.ts:1019](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L1019) *** @@ -770,7 +770,7 @@ This method is provable and is suitable as a base for implementing `approveUpdat #### Source -[lib/mina/token/token-contract.ts:90](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/token-contract.ts#L90) +[lib/mina/token/token-contract.ts:90](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/token-contract.ts#L90) *** @@ -802,7 +802,7 @@ class MyContract extends SmartContract { #### Source -[lib/mina/zkapp.ts:773](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L773) +[lib/mina/zkapp.ts:773](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L773) *** @@ -828,7 +828,7 @@ Same as `SmartContract.self` but explicitly creates a new [AccountUpdate](Accoun #### Source -[lib/mina/zkapp.ts:860](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L860) +[lib/mina/zkapp.ts:860](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L860) *** @@ -858,7 +858,7 @@ with the only difference being that quick mock proofs are filled in instead of r #### Source -[lib/mina/zkapp.ts:806](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L806) +[lib/mina/zkapp.ts:806](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L806) *** @@ -889,7 +889,7 @@ send(args: { #### Source -[lib/mina/zkapp.ts:951](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L951) +[lib/mina/zkapp.ts:951](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L951) *** @@ -916,7 +916,7 @@ authorization flow. #### Source -[lib/mina/zkapp.ts:818](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L818) +[lib/mina/zkapp.ts:818](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L818) *** @@ -945,7 +945,7 @@ Transfer `amount` of tokens from `from` to `to`. #### Source -[lib/mina/token/token-contract.ts:157](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/token/token-contract.ts#L157) +[lib/mina/token/token-contract.ts:157](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/token/token-contract.ts#L157) *** @@ -967,7 +967,7 @@ Returns a Proof type that belongs to this [SmartContract](SmartContract.mdx). #### Source -[lib/mina/zkapp.ts:605](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L605) +[lib/mina/zkapp.ts:605](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L605) *** @@ -1023,7 +1023,7 @@ an object, keyed by method name, each entry containing: #### Source -[lib/mina/zkapp.ts:1138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L1138) +[lib/mina/zkapp.ts:1138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L1138) *** @@ -1125,7 +1125,7 @@ up to several minutes if your circuit is large or your hardware is not optimal f #### Source -[lib/mina/zkapp.ts:642](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L642) +[lib/mina/zkapp.ts:642](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L642) *** @@ -1151,7 +1151,7 @@ the digest, as a hex string #### Source -[lib/mina/zkapp.ts:683](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L683) +[lib/mina/zkapp.ts:683](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L683) *** @@ -1175,4 +1175,4 @@ static runOutsideCircuit(run: () => void): void #### Source -[lib/mina/zkapp.ts:1113](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L1113) +[lib/mina/zkapp.ts:1113](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L1113) diff --git a/docs/zkapps/o1js-reference/classes/TokenSymbol.mdx b/docs/zkapps/o1js-reference/classes/TokenSymbol.mdx index 7bd317916..c9c1b4dd8 100644 --- a/docs/zkapps/o1js-reference/classes/TokenSymbol.mdx +++ b/docs/zkapps/o1js-reference/classes/TokenSymbol.mdx @@ -34,7 +34,7 @@ new TokenSymbol(value: { #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) ## Properties @@ -50,7 +50,7 @@ field: Field; #### Source -[lib/provable/crypto/poseidon.ts:206](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/poseidon.ts#L206) +[lib/provable/crypto/poseidon.ts:206](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/poseidon.ts#L206) *** @@ -66,7 +66,7 @@ symbol: string; #### Source -[lib/provable/crypto/poseidon.ts:206](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/poseidon.ts#L206) +[lib/provable/crypto/poseidon.ts:206](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/poseidon.ts#L206) *** @@ -82,7 +82,7 @@ static _isStruct: true; #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) *** @@ -120,7 +120,7 @@ the element of type `T` to put assertions on. #### Source -[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L66) +[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L66) *** @@ -160,7 +160,7 @@ symbol: string; #### Source -[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L154) +[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L154) *** @@ -214,7 +214,7 @@ symbol: string; #### Source -[lib/provable/types/provable-intf.ts:49](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L49) +[lib/provable/types/provable-intf.ts:49](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L49) *** @@ -258,7 +258,7 @@ symbol: string; #### Source -[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L153) +[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L153) *** @@ -288,7 +288,7 @@ Convert provable type from a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L76) +[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L76) *** @@ -325,7 +325,7 @@ If not provided, a default value for auxiliary data is returned. #### Source -[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L37) +[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L37) *** @@ -361,7 +361,7 @@ the element of type `T` to generate the [Field](Field.mdx) array from. #### Source -[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L26) +[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L26) *** @@ -412,7 +412,7 @@ optional packed: [Field, number][]; #### Source -[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L148) +[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L148) *** @@ -443,7 +443,7 @@ static toJSON: (x: { #### Source -[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L152) +[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L152) *** @@ -476,7 +476,7 @@ Convert provable type to a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L71) +[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L71) ## Methods @@ -496,7 +496,7 @@ static from(value: string | TokenSymbol): TokenSymbol #### Source -[lib/provable/crypto/poseidon.ts:253](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/poseidon.ts#L253) +[lib/provable/crypto/poseidon.ts:253](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/poseidon.ts#L253) *** @@ -520,4 +520,4 @@ A `number` representing the size of the `T` type in terms of [Field](Field.mdx) #### Source -[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L56) +[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L56) diff --git a/docs/zkapps/o1js-reference/classes/UInt32.mdx b/docs/zkapps/o1js-reference/classes/UInt32.mdx index 516300a1f..a80c2b1de 100644 --- a/docs/zkapps/o1js-reference/classes/UInt32.mdx +++ b/docs/zkapps/o1js-reference/classes/UInt32.mdx @@ -41,7 +41,7 @@ The max value of a [UInt32](UInt32.mdx) is `2^32 - 1 = UInt32.MAXINT()`. #### Source -[lib/provable/int.ts:514](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L514) +[lib/provable/int.ts:514](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L514) ## Properties @@ -53,7 +53,7 @@ value: Field; #### Source -[lib/provable/int.ts:505](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L505) +[lib/provable/int.ts:505](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L505) *** @@ -65,7 +65,7 @@ static NUM_BITS: number = 32; #### Source -[lib/provable/int.ts:506](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L506) +[lib/provable/int.ts:506](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L506) *** @@ -94,7 +94,7 @@ Only use this if you know what you are doing, otherwise use the safe [UInt32.fro #### Source -[lib/provable/int.ts:522](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L522) +[lib/provable/int.ts:522](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L522) ## Accessors @@ -112,7 +112,7 @@ Static method to create a [UInt32](UInt32.mdx) with value `0`. #### Source -[lib/provable/int.ts:544](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L544) +[lib/provable/int.ts:544](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L544) *** @@ -130,7 +130,7 @@ Static method to create a [UInt32](UInt32.mdx) with value `0`. #### Source -[lib/provable/int.ts:537](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L537) +[lib/provable/int.ts:537](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L537) ## Methods @@ -152,7 +152,7 @@ Addition with overflow checking. #### Source -[lib/provable/int.ts:691](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L691) +[lib/provable/int.ts:691](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L691) *** @@ -174,7 +174,7 @@ Addition modulo 2^32. Check Gadgets.addMod32 for a detailed description. #### Source -[lib/provable/int.ts:617](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L617) +[lib/provable/int.ts:617](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L617) *** @@ -218,7 +218,7 @@ c.assertEquals(1); #### Source -[lib/provable/int.ts:862](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L862) +[lib/provable/int.ts:862](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L862) *** @@ -242,7 +242,7 @@ assertEquals(x: this): void #### Source -[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L130) +[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L130) *** @@ -266,7 +266,7 @@ Asserts that a [UInt32](UInt32.mdx) is greater than another one. #### Source -[lib/provable/int.ts:932](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L932) +[lib/provable/int.ts:932](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L932) *** @@ -290,7 +290,7 @@ Asserts that a [UInt32](UInt32.mdx) is greater than or equal to another one. #### Source -[lib/provable/int.ts:946](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L946) +[lib/provable/int.ts:946](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L946) *** @@ -314,7 +314,7 @@ Asserts that a [UInt32](UInt32.mdx) is less than another one. #### Source -[lib/provable/int.ts:909](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L909) +[lib/provable/int.ts:909](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L909) *** @@ -338,7 +338,7 @@ Asserts that a [UInt32](UInt32.mdx) is less than or equal to another one. #### Source -[lib/provable/int.ts:881](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L881) +[lib/provable/int.ts:881](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L881) *** @@ -363,7 +363,7 @@ Integer division. #### Source -[lib/provable/int.ts:668](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L668) +[lib/provable/int.ts:668](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L668) *** @@ -407,7 +407,7 @@ rest: UInt32; #### Source -[lib/provable/int.ts:626](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L626) +[lib/provable/int.ts:626](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L626) *** @@ -431,7 +431,7 @@ equals(x: this): Bool #### Source -[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L126) +[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L126) *** @@ -453,7 +453,7 @@ Checks if a [UInt32](UInt32.mdx) is greater than another one. #### Source -[lib/provable/int.ts:925](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L925) +[lib/provable/int.ts:925](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L925) *** @@ -475,7 +475,7 @@ Checks if a [UInt32](UInt32.mdx) is greater than or equal to another one. #### Source -[lib/provable/int.ts:939](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L939) +[lib/provable/int.ts:939](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L939) *** @@ -495,7 +495,7 @@ isConstant(): boolean #### Source -[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L134) +[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L134) *** @@ -534,7 +534,7 @@ y.assertEquals(0b110000); // 48 in binary #### Source -[lib/provable/int.ts:810](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L810) +[lib/provable/int.ts:810](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L810) *** @@ -556,7 +556,7 @@ Checks if a [UInt32](UInt32.mdx) is less than another one. #### Source -[lib/provable/int.ts:897](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L897) +[lib/provable/int.ts:897](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L897) *** @@ -578,7 +578,7 @@ Checks if a [UInt32](UInt32.mdx) is less than or equal to another one. #### Source -[lib/provable/int.ts:869](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L869) +[lib/provable/int.ts:869](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L869) *** @@ -603,7 +603,7 @@ Integer remainder. #### Source -[lib/provable/int.ts:677](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L677) +[lib/provable/int.ts:677](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L677) *** @@ -625,7 +625,7 @@ Multiplication with overflow checking. #### Source -[lib/provable/int.ts:683](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L683) +[lib/provable/int.ts:683](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L683) *** @@ -666,7 +666,7 @@ console.log(b.toBigInt().toString(2)); #### Source -[lib/provable/int.ts:755](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L755) +[lib/provable/int.ts:755](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L755) *** @@ -705,7 +705,7 @@ y.assertEquals(0b000011); // 48 in binary #### Source -[lib/provable/int.ts:833](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L833) +[lib/provable/int.ts:833](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L833) *** @@ -755,7 +755,7 @@ z.assertEquals(0b000011); #### Source -[lib/provable/int.ts:787](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L787) +[lib/provable/int.ts:787](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L787) *** @@ -777,7 +777,7 @@ Subtraction with underflow checking. #### Source -[lib/provable/int.ts:699](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L699) +[lib/provable/int.ts:699](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L699) *** @@ -795,7 +795,7 @@ Turns the [UInt32](UInt32.mdx) into a BigInt. #### Source -[lib/provable/int.ts:556](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L556) +[lib/provable/int.ts:556](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L556) *** @@ -815,7 +815,7 @@ toConstant(): this #### Source -[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L122) +[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L122) *** @@ -835,7 +835,7 @@ toFields(): Field[] #### Source -[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L85) +[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L85) *** @@ -855,7 +855,7 @@ toJSON(): any #### Source -[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L118) +[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L118) *** @@ -873,7 +873,7 @@ Turns the [UInt32](UInt32.mdx) into a string. #### Source -[lib/provable/int.ts:550](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L550) +[lib/provable/int.ts:550](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L550) *** @@ -891,7 +891,7 @@ Turns the [UInt32](UInt32.mdx) into a [UInt64](UInt64.mdx). #### Source -[lib/provable/int.ts:562](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L562) +[lib/provable/int.ts:562](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L562) *** @@ -930,7 +930,7 @@ c.assertEquals(0b0110); #### Source -[lib/provable/int.ts:724](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L724) +[lib/provable/int.ts:724](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L724) *** @@ -948,7 +948,7 @@ Creates a [UInt32](UInt32.mdx) with a value of 4,294,967,295. #### Source -[lib/provable/int.ts:610](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L610) +[lib/provable/int.ts:610](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L610) *** @@ -972,7 +972,7 @@ static check(x: UInt32): void #### Source -[lib/provable/int.ts:567](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L567) +[lib/provable/int.ts:567](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L567) *** @@ -996,7 +996,7 @@ static empty(): InstanceType #### Source -[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L218) +[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L218) *** @@ -1018,7 +1018,7 @@ Creates a new [UInt32](UInt32.mdx). #### Source -[lib/provable/int.ts:602](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L602) +[lib/provable/int.ts:602](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L602) *** @@ -1048,7 +1048,7 @@ static fromFields(this: T, xs: Field[]): InstanceType #### Source -[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L138) +[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L138) *** @@ -1078,7 +1078,7 @@ Decodes a JSON-like object into this structure. #### Source -[lib/provable/int.ts:583](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L583) +[lib/provable/int.ts:583](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L583) *** @@ -1108,7 +1108,7 @@ static fromObject(this: T, value: NonMethods>): InstanceType< #### Source -[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L30) +[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L30) *** @@ -1136,7 +1136,7 @@ static fromValue(x: bigint | UInt32): InstanceType #### Source -[lib/provable/int.ts:954](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L954) +[lib/provable/int.ts:954](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L954) *** @@ -1156,7 +1156,7 @@ static sizeInFields(): number #### Source -[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L37) +[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L37) *** @@ -1176,7 +1176,7 @@ static toAuxiliary(): [] #### Source -[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L59) +[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L59) *** @@ -1206,7 +1206,7 @@ static toConstant(this: T, t: InstanceType): InstanceType #### Source -[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L177) +[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L177) *** @@ -1236,7 +1236,7 @@ static toFields(this: T, v: InstanceType): Field[] #### Source -[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L42) +[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L42) *** @@ -1260,7 +1260,7 @@ static toInput(x: UInt32): HashInput #### Source -[lib/provable/int.ts:570](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L570) +[lib/provable/int.ts:570](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L570) *** @@ -1286,7 +1286,7 @@ Encodes this structure into a JSON-like object. #### Source -[lib/provable/int.ts:576](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L576) +[lib/provable/int.ts:576](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L576) *** @@ -1310,4 +1310,4 @@ static toValue(x: UInt32): bigint #### Source -[lib/provable/int.ts:950](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L950) +[lib/provable/int.ts:950](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L950) diff --git a/docs/zkapps/o1js-reference/classes/UInt64.mdx b/docs/zkapps/o1js-reference/classes/UInt64.mdx index 145efac4c..f0dee5ff8 100644 --- a/docs/zkapps/o1js-reference/classes/UInt64.mdx +++ b/docs/zkapps/o1js-reference/classes/UInt64.mdx @@ -43,7 +43,7 @@ The max value of a [UInt64](UInt64.mdx) is `2^64 - 1 = UInt64.MAXINT()`. #### Source -[lib/provable/int.ts:38](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L38) +[lib/provable/int.ts:38](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L38) ## Properties @@ -55,7 +55,7 @@ value: Field; #### Source -[lib/provable/int.ts:29](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L29) +[lib/provable/int.ts:29](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L29) *** @@ -67,7 +67,7 @@ static NUM_BITS: number = 64; #### Source -[lib/provable/int.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L30) +[lib/provable/int.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L30) *** @@ -96,7 +96,7 @@ Only use this if you know what you are doing, otherwise use the safe [UInt64.fro #### Source -[lib/provable/int.ts:46](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L46) +[lib/provable/int.ts:46](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L46) ## Accessors @@ -114,7 +114,7 @@ Static method to create a [UInt64](UInt64.mdx) with value `1`. #### Source -[lib/provable/int.ts:67](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L67) +[lib/provable/int.ts:67](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L67) *** @@ -132,7 +132,7 @@ Static method to create a [UInt64](UInt64.mdx) with value `0`. #### Source -[lib/provable/int.ts:61](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L61) +[lib/provable/int.ts:61](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L61) ## Methods @@ -154,7 +154,7 @@ Addition with overflow checking. #### Source -[lib/provable/int.ts:232](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L232) +[lib/provable/int.ts:232](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L232) *** @@ -198,7 +198,7 @@ c.assertEquals(1); #### Source -[lib/provable/int.ts:402](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L402) +[lib/provable/int.ts:402](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L402) *** @@ -222,7 +222,7 @@ assertEquals(x: this): void #### Source -[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L130) +[lib/provable/types/circuit-value.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L130) *** @@ -246,7 +246,7 @@ Asserts that a [UInt64](UInt64.mdx) is greater than another one. #### Source -[lib/provable/int.ts:473](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L473) +[lib/provable/int.ts:473](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L473) *** @@ -270,7 +270,7 @@ Asserts that a [UInt64](UInt64.mdx) is greater than or equal to another one. #### Source -[lib/provable/int.ts:487](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L487) +[lib/provable/int.ts:487](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L487) *** @@ -294,7 +294,7 @@ Asserts that a [UInt64](UInt64.mdx) is less than another one. #### Source -[lib/provable/int.ts:450](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L450) +[lib/provable/int.ts:450](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L450) *** @@ -318,7 +318,7 @@ Asserts that a [UInt64](UInt64.mdx) is less than or equal to another one. #### Source -[lib/provable/int.ts:421](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L421) +[lib/provable/int.ts:421](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L421) *** @@ -343,7 +343,7 @@ Integer division. #### Source -[lib/provable/int.ts:206](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L206) +[lib/provable/int.ts:206](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L206) *** @@ -387,7 +387,7 @@ rest: UInt64; #### Source -[lib/provable/int.ts:163](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L163) +[lib/provable/int.ts:163](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L163) *** @@ -411,7 +411,7 @@ equals(x: this): Bool #### Source -[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L126) +[lib/provable/types/circuit-value.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L126) *** @@ -433,7 +433,7 @@ Checks if a [UInt64](UInt64.mdx) is greater than another one. #### Source -[lib/provable/int.ts:466](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L466) +[lib/provable/int.ts:466](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L466) *** @@ -455,7 +455,7 @@ Checks if a [UInt64](UInt64.mdx) is greater than or equal to another one. #### Source -[lib/provable/int.ts:480](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L480) +[lib/provable/int.ts:480](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L480) *** @@ -475,7 +475,7 @@ isConstant(): boolean #### Source -[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L134) +[lib/provable/types/circuit-value.ts:134](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L134) *** @@ -512,7 +512,7 @@ y.assertEquals(0b110000); // 48 in binary #### Source -[lib/provable/int.ts:352](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L352) +[lib/provable/int.ts:352](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L352) *** @@ -534,7 +534,7 @@ Checks if a [UInt64](UInt64.mdx) is less than another one. #### Source -[lib/provable/int.ts:438](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L438) +[lib/provable/int.ts:438](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L438) *** @@ -556,7 +556,7 @@ Checks if a [UInt64](UInt64.mdx) is less than or equal to another one. #### Source -[lib/provable/int.ts:409](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L409) +[lib/provable/int.ts:409](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L409) *** @@ -581,7 +581,7 @@ Integer remainder. #### Source -[lib/provable/int.ts:216](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L216) +[lib/provable/int.ts:216](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L216) *** @@ -603,7 +603,7 @@ Multiplication with overflow checking. #### Source -[lib/provable/int.ts:223](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L223) +[lib/provable/int.ts:223](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L223) *** @@ -645,7 +645,7 @@ console.log(b.toBigInt().toString(2)); #### Source -[lib/provable/int.ts:299](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L299) +[lib/provable/int.ts:299](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L299) *** @@ -682,7 +682,7 @@ y.assertEquals(0b000011); // 3 in binary #### Source -[lib/provable/int.ts:373](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L373) +[lib/provable/int.ts:373](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L373) *** @@ -732,7 +732,7 @@ z.assertEquals(0b000011); #### Source -[lib/provable/int.ts:331](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L331) +[lib/provable/int.ts:331](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L331) *** @@ -754,7 +754,7 @@ Subtraction with underflow checking. #### Source -[lib/provable/int.ts:241](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L241) +[lib/provable/int.ts:241](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L241) *** @@ -772,7 +772,7 @@ Turns the [UInt64](UInt64.mdx) into a BigInt. #### Source -[lib/provable/int.ts:81](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L81) +[lib/provable/int.ts:81](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L81) *** @@ -792,7 +792,7 @@ toConstant(): this #### Source -[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L122) +[lib/provable/types/circuit-value.ts:122](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L122) *** @@ -812,7 +812,7 @@ toFields(): Field[] #### Source -[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L85) +[lib/provable/types/circuit-value.ts:85](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L85) *** @@ -832,7 +832,7 @@ toJSON(): any #### Source -[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L118) +[lib/provable/types/circuit-value.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L118) *** @@ -850,7 +850,7 @@ Turns the [UInt64](UInt64.mdx) into a string. #### Source -[lib/provable/int.ts:74](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L74) +[lib/provable/int.ts:74](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L74) *** @@ -868,7 +868,7 @@ Turns the [UInt64](UInt64.mdx) into a [UInt32](UInt32.mdx), asserting that it fi #### Source -[lib/provable/int.ts:88](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L88) +[lib/provable/int.ts:88](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L88) *** @@ -889,7 +889,7 @@ UInt64.from(4294967296).toUInt32Clamped().toString(); // "4294967295" #### Source -[lib/provable/int.ts:100](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L100) +[lib/provable/int.ts:100](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L100) *** @@ -928,7 +928,7 @@ c.assertEquals(0b0110); #### Source -[lib/provable/int.ts:266](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L266) +[lib/provable/int.ts:266](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L266) *** @@ -946,7 +946,7 @@ Creates a [UInt64](UInt64.mdx) with a value of 18,446,744,073,709,551,615. #### Source -[lib/provable/int.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L154) +[lib/provable/int.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L154) *** @@ -970,7 +970,7 @@ static check(x: UInt64): void #### Source -[lib/provable/int.ts:110](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L110) +[lib/provable/int.ts:110](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L110) *** @@ -994,7 +994,7 @@ static empty(): InstanceType #### Source -[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L218) +[lib/provable/types/circuit-value.ts:218](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L218) *** @@ -1026,7 +1026,7 @@ Creates a new [UInt64](UInt64.mdx). #### Source -[lib/provable/int.ts:146](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L146) +[lib/provable/int.ts:146](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L146) *** @@ -1056,7 +1056,7 @@ static fromFields(this: T, xs: Field[]): InstanceType #### Source -[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L138) +[lib/provable/types/circuit-value.ts:138](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L138) *** @@ -1086,7 +1086,7 @@ Decodes a JSON-like object into this structure. #### Source -[lib/provable/int.ts:128](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L128) +[lib/provable/int.ts:128](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L128) *** @@ -1116,7 +1116,7 @@ static fromObject(this: T, value: NonMethods>): InstanceType< #### Source -[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L30) +[lib/provable/types/circuit-value.ts:30](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L30) *** @@ -1144,7 +1144,7 @@ static fromValue(x: bigint | UInt64): InstanceType #### Source -[lib/provable/int.ts:495](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L495) +[lib/provable/int.ts:495](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L495) *** @@ -1164,7 +1164,7 @@ static sizeInFields(): number #### Source -[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L37) +[lib/provable/types/circuit-value.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L37) *** @@ -1184,7 +1184,7 @@ static toAuxiliary(): [] #### Source -[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L59) +[lib/provable/types/circuit-value.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L59) *** @@ -1214,7 +1214,7 @@ static toConstant(this: T, t: InstanceType): InstanceType #### Source -[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L177) +[lib/provable/types/circuit-value.ts:177](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L177) *** @@ -1244,7 +1244,7 @@ static toFields(this: T, v: InstanceType): Field[] #### Source -[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/circuit-value.ts#L42) +[lib/provable/types/circuit-value.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/circuit-value.ts#L42) *** @@ -1268,7 +1268,7 @@ static toInput(x: UInt64): HashInput #### Source -[lib/provable/int.ts:114](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L114) +[lib/provable/int.ts:114](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L114) *** @@ -1294,7 +1294,7 @@ Encodes this structure into a JSON-like object. #### Source -[lib/provable/int.ts:121](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L121) +[lib/provable/int.ts:121](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L121) *** @@ -1318,4 +1318,4 @@ static toValue(x: UInt64): bigint #### Source -[lib/provable/int.ts:491](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L491) +[lib/provable/int.ts:491](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L491) diff --git a/docs/zkapps/o1js-reference/classes/UInt8.mdx b/docs/zkapps/o1js-reference/classes/UInt8.mdx index d50935666..187fdd590 100644 --- a/docs/zkapps/o1js-reference/classes/UInt8.mdx +++ b/docs/zkapps/o1js-reference/classes/UInt8.mdx @@ -35,7 +35,7 @@ The max value of a [UInt8](UInt8.mdx) is `2^8 - 1 = 255`. #### Source -[lib/provable/int.ts:1239](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1239) +[lib/provable/int.ts:1312](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1312) ## Properties @@ -53,7 +53,7 @@ value: Field = Field; #### Source -[lib/provable/int.ts:1229](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1229) +[lib/provable/int.ts:1302](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1302) *** @@ -65,7 +65,7 @@ static NUM_BITS: number = 8; #### Source -[lib/provable/int.ts:1231](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1231) +[lib/provable/int.ts:1304](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1304) *** @@ -94,7 +94,7 @@ Only use this if you know what you are doing, otherwise use the safe [UInt8.from #### Source -[lib/provable/int.ts:1245](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1245) +[lib/provable/int.ts:1318](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1318) *** @@ -112,7 +112,7 @@ static _isStruct: true; #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) *** @@ -146,7 +146,7 @@ value: Field = Field; #### Source -[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L154) +[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L154) *** @@ -184,7 +184,7 @@ value: Field = Field; #### Source -[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L87) +[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L87) *** @@ -226,7 +226,7 @@ value: Field = Field; #### Source -[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L153) +[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L153) *** @@ -256,7 +256,7 @@ Convert provable type from a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L76) +[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L76) *** @@ -292,7 +292,7 @@ If not provided, a default value for auxiliary data is returned. #### Source -[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L37) +[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L37) *** @@ -327,7 +327,7 @@ the element of type `T` to generate the [Field](Field.mdx) array from. #### Source -[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L26) +[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L26) *** @@ -369,7 +369,7 @@ value: string = Field; #### Source -[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L152) +[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L152) *** @@ -413,7 +413,7 @@ value: bigint = Field; #### Source -[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L71) +[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L71) ## Methods @@ -447,7 +447,7 @@ if the result is greater than 255. #### Source -[lib/provable/int.ts:1269](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1269) +[lib/provable/int.ts:1342](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1342) *** @@ -475,7 +475,7 @@ the [UInt8](UInt8.mdx) value to compare & assert with this [UInt8](UInt8.mdx). #### Source -[lib/provable/int.ts:1535](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1535) +[lib/provable/int.ts:1608](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1608) *** @@ -503,7 +503,7 @@ the [UInt8](UInt8.mdx) value to compare & assert with this [UInt8](UInt8.mdx). #### Source -[lib/provable/int.ts:1511](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1511) +[lib/provable/int.ts:1584](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1584) *** @@ -531,7 +531,7 @@ the [UInt8](UInt8.mdx) value to compare & assert with this [UInt8](UInt8.mdx). #### Source -[lib/provable/int.ts:1523](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1523) +[lib/provable/int.ts:1596](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1596) *** @@ -559,7 +559,7 @@ the [UInt8](UInt8.mdx) value to compare & assert with this [UInt8](UInt8.mdx). #### Source -[lib/provable/int.ts:1429](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1429) +[lib/provable/int.ts:1502](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1502) *** @@ -587,7 +587,7 @@ the [UInt8](UInt8.mdx) value to compare & assert with this [UInt8](UInt8.mdx). #### Source -[lib/provable/int.ts:1454](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1454) +[lib/provable/int.ts:1527](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1527) *** @@ -618,7 +618,7 @@ quotient.assertEquals(3); #### Source -[lib/provable/int.ts:1322](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1322) +[lib/provable/int.ts:1395](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1395) *** @@ -666,7 +666,7 @@ remainder: UInt8; #### Source -[lib/provable/int.ts:1349](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1349) +[lib/provable/int.ts:1422](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1422) *** @@ -696,7 +696,7 @@ UInt8.from(5).greaterThan(3); #### Source -[lib/provable/int.ts:1485](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1485) +[lib/provable/int.ts:1558](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1558) *** @@ -726,7 +726,7 @@ UInt8.from(3).greaterThanOrEqual(3); #### Source -[lib/provable/int.ts:1499](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1499) +[lib/provable/int.ts:1572](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1572) *** @@ -755,7 +755,7 @@ UInt8.from(2).lessThan(UInt8.from(3)); #### Source -[lib/provable/int.ts:1408](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1408) +[lib/provable/int.ts:1481](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1481) *** @@ -784,7 +784,7 @@ UInt8.from(3).lessThanOrEqual(UInt8.from(5)); #### Source -[lib/provable/int.ts:1386](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1386) +[lib/provable/int.ts:1459](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1459) *** @@ -814,7 +814,7 @@ mod.assertEquals(20); #### Source -[lib/provable/int.ts:1336](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1336) +[lib/provable/int.ts:1409](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1409) *** @@ -848,7 +848,7 @@ if the result is greater than 255. #### Source -[lib/provable/int.ts:1305](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1305) +[lib/provable/int.ts:1378](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1378) *** @@ -882,7 +882,7 @@ if the result is less than 0. #### Source -[lib/provable/int.ts:1287](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1287) +[lib/provable/int.ts:1360](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1360) *** @@ -902,7 +902,7 @@ Serialize the [UInt8](UInt8.mdx) to a bigint. #### Source -[lib/provable/int.ts:1563](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1563) +[lib/provable/int.ts:1636](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1636) *** @@ -922,7 +922,7 @@ Serialize the [UInt8](UInt8.mdx) to a number. #### Source -[lib/provable/int.ts:1554](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1554) +[lib/provable/int.ts:1627](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1627) *** @@ -942,7 +942,7 @@ Serialize the [UInt8](UInt8.mdx) to a string, e.g. for printing. #### Source -[lib/provable/int.ts:1545](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1545) +[lib/provable/int.ts:1618](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1618) *** @@ -960,7 +960,7 @@ Turns a [UInt8](UInt8.mdx) into a [UInt32](UInt32.mdx). #### Source -[lib/provable/int.ts:1583](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1583) +[lib/provable/int.ts:1656](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1656) *** @@ -978,7 +978,7 @@ Turns a [UInt8](UInt8.mdx) into a [UInt64](UInt64.mdx). #### Source -[lib/provable/int.ts:1590](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1590) +[lib/provable/int.ts:1663](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1663) *** @@ -996,7 +996,7 @@ Creates a [UInt8](UInt8.mdx) with a value of 255. #### Source -[lib/provable/int.ts:1597](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1597) +[lib/provable/int.ts:1670](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1670) *** @@ -1029,7 +1029,7 @@ Proves that the input is in the [0, 255] range. #### Source -[lib/provable/int.ts:1571](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1571) +[lib/provable/int.ts:1644](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1644) *** @@ -1063,7 +1063,7 @@ Creates a new [UInt8](UInt8.mdx). #### Source -[lib/provable/int.ts:1604](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1604) +[lib/provable/int.ts:1677](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1677) *** @@ -1089,7 +1089,7 @@ A `number` representing the size of the `T` type in terms of [Field](Field.mdx) #### Source -[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L56) +[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L56) *** @@ -1119,4 +1119,4 @@ static toInput(x: { #### Source -[lib/provable/int.ts:1576](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/int.ts#L1576) +[lib/provable/int.ts:1649](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/int.ts#L1649) diff --git a/docs/zkapps/o1js-reference/classes/Unconstrained.mdx b/docs/zkapps/o1js-reference/classes/Unconstrained.mdx index e657e98ec..93e0130a0 100644 --- a/docs/zkapps/o1js-reference/classes/Unconstrained.mdx +++ b/docs/zkapps/o1js-reference/classes/Unconstrained.mdx @@ -93,7 +93,7 @@ optional packed: [Field, number][]; #### Source -[lib/provable/types/unconstrained.ts:113](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/unconstrained.ts#L113) +[lib/provable/types/unconstrained.ts:114](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/unconstrained.ts#L114) ## Methods @@ -113,7 +113,7 @@ Note: Can only be called outside provable code. #### Source -[lib/provable/types/unconstrained.ts:53](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/unconstrained.ts#L53) +[lib/provable/types/unconstrained.ts:53](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/unconstrained.ts#L53) *** @@ -135,7 +135,7 @@ Modify the unconstrained value. #### Source -[lib/provable/types/unconstrained.ts:67](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/unconstrained.ts#L67) +[lib/provable/types/unconstrained.ts:67](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/unconstrained.ts#L67) *** @@ -157,7 +157,7 @@ Set the unconstrained value to the same as another `Unconstrained`. #### Source -[lib/provable/types/unconstrained.ts:74](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/unconstrained.ts#L74) +[lib/provable/types/unconstrained.ts:74](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/unconstrained.ts#L74) *** @@ -179,14 +179,14 @@ Update an `Unconstrained` by a witness computation. #### Source -[lib/provable/types/unconstrained.ts:106](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/unconstrained.ts#L106) +[lib/provable/types/unconstrained.ts:107](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/unconstrained.ts#L107) *** ### from() ```ts -static from(value: T): Unconstrained +static from(value: T | Unconstrained): Unconstrained ``` Create an `Unconstrained` with the given `value`. @@ -205,7 +205,7 @@ let xWrapped = Unconstrained.witness(() => Provable.toConstant(type, x)); #### Parameters -• **value**: `T` +• **value**: `T` \| [`Unconstrained`](Unconstrained.mdx)\<`T`\> #### Returns @@ -213,7 +213,7 @@ let xWrapped = Unconstrained.witness(() => Provable.toConstant(type, x)); #### Source -[lib/provable/types/unconstrained.ts:89](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/unconstrained.ts#L89) +[lib/provable/types/unconstrained.ts:89](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/unconstrained.ts#L89) *** @@ -221,8 +221,8 @@ let xWrapped = Unconstrained.witness(() => Provable.toConstant(type, x)); ```ts static provableWithEmpty(empty: T): Provable, Unconstrained> & { - "empty": () => Unconstrained; - "toInput": (x: Unconstrained) => { + "empty": () => Unconstrained; + "toInput": (x: Unconstrained) => { "fields": Field[]; "packed": [Field, number][]; }; @@ -240,8 +240,8 @@ static provableWithEmpty(empty: T): Provable, Unconstrained< #### Returns `Provable`\<[`Unconstrained`](Unconstrained.mdx)\<`T`\>, [`Unconstrained`](Unconstrained.mdx)\<`T`\>\> & \{ - `"empty"`: () => [`Unconstrained`](Unconstrained.mdx)\<`any`\>; - `"toInput"`: (`x`: [`Unconstrained`](Unconstrained.mdx)\<`any`\>) => \{ + `"empty"`: () => [`Unconstrained`](Unconstrained.mdx)\<`T`\>; + `"toInput"`: (`x`: [`Unconstrained`](Unconstrained.mdx)\<`T`\>) => \{ `"fields"`: [`Field`](Field.mdx)[]; `"packed"`: [[`Field`](Field.mdx), `number`][]; \}; @@ -249,7 +249,7 @@ static provableWithEmpty(empty: T): Provable, Unconstrained< #### Source -[lib/provable/types/unconstrained.ts:133](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/unconstrained.ts#L133) +[lib/provable/types/unconstrained.ts:134](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/unconstrained.ts#L134) *** @@ -275,4 +275,4 @@ Create an `Unconstrained` from a witness computation. #### Source -[lib/provable/types/unconstrained.ts:96](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/unconstrained.ts#L96) +[lib/provable/types/unconstrained.ts:97](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/unconstrained.ts#L97) diff --git a/docs/zkapps/o1js-reference/classes/VerificationKey.mdx b/docs/zkapps/o1js-reference/classes/VerificationKey.mdx index 467c70333..c3eb023c5 100644 --- a/docs/zkapps/o1js-reference/classes/VerificationKey.mdx +++ b/docs/zkapps/o1js-reference/classes/VerificationKey.mdx @@ -39,7 +39,7 @@ new VerificationKey(value: { #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) ## Properties @@ -60,7 +60,7 @@ data: string = String; #### Source -[lib/proof-system/zkprogram.ts:645](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L645) +[lib/proof-system/zkprogram.ts:783](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L783) *** @@ -81,7 +81,7 @@ hash: Field = Field; #### Source -[lib/proof-system/zkprogram.ts:645](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L645) +[lib/proof-system/zkprogram.ts:783](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L783) *** @@ -102,7 +102,7 @@ static _isStruct: true; #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) *** @@ -145,7 +145,7 @@ the element of type `T` to put assertions on. #### Source -[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L66) +[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L66) *** @@ -190,7 +190,7 @@ hash: Field = Field; #### Source -[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L154) +[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L154) *** @@ -249,7 +249,7 @@ hash: Field = Field; #### Source -[lib/provable/types/provable-intf.ts:49](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L49) +[lib/provable/types/provable-intf.ts:49](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L49) *** @@ -298,7 +298,7 @@ hash: Field = Field; #### Source -[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L153) +[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L153) *** @@ -339,7 +339,7 @@ Convert provable type from a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L76) +[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L76) *** @@ -381,7 +381,7 @@ If not provided, a default value for auxiliary data is returned. #### Source -[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L37) +[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L37) *** @@ -422,7 +422,7 @@ the element of type `T` to generate the [Field](Field.mdx) array from. #### Source -[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L26) +[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L26) *** @@ -478,7 +478,7 @@ optional packed: [Field, number][]; #### Source -[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L148) +[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L148) *** @@ -514,7 +514,7 @@ static toJSON: (x: { #### Source -[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L152) +[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L152) *** @@ -572,7 +572,7 @@ hash: bigint = Field; #### Source -[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L71) +[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L71) ## Methods @@ -601,4 +601,4 @@ A `number` representing the size of the `T` type in terms of [Field](Field.mdx) #### Source -[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L56) +[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L56) diff --git a/docs/zkapps/o1js-reference/functions/Bytes.mdx b/docs/zkapps/o1js-reference/functions/Bytes.mdx index 02decdcde..85df8eff2 100644 --- a/docs/zkapps/o1js-reference/functions/Bytes.mdx +++ b/docs/zkapps/o1js-reference/functions/Bytes.mdx @@ -20,4 +20,4 @@ let bytes = Bytes32.fromHex('deadbeef'); ## Source -[lib/provable/wrapped-classes.ts:16](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/wrapped-classes.ts#L16) +[lib/provable/wrapped-classes.ts:16](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/wrapped-classes.ts#L16) diff --git a/docs/zkapps/o1js-reference/functions/ConstantField.mdx b/docs/zkapps/o1js-reference/functions/ConstantField.mdx index 68579e73f..5471d01f3 100644 --- a/docs/zkapps/o1js-reference/functions/ConstantField.mdx +++ b/docs/zkapps/o1js-reference/functions/ConstantField.mdx @@ -12,4 +12,4 @@ function ConstantField(x: bigint | ConstantFieldVar): ConstantField ## Source -[lib/provable/field.ts:1246](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1246) +[lib/provable/field.ts:1246](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1246) diff --git a/docs/zkapps/o1js-reference/functions/MerkleListBase.mdx b/docs/zkapps/o1js-reference/functions/MerkleListBase.mdx index f12cdf860..37f30072b 100644 --- a/docs/zkapps/o1js-reference/functions/MerkleListBase.mdx +++ b/docs/zkapps/o1js-reference/functions/MerkleListBase.mdx @@ -12,4 +12,4 @@ function MerkleListBase(): ProvableHashable> ## Source -[lib/provable/merkle-list.ts:45](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L45) +[lib/provable/merkle-list.ts:45](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L45) diff --git a/docs/zkapps/o1js-reference/functions/MerkleWitness.mdx b/docs/zkapps/o1js-reference/functions/MerkleWitness.mdx index 2cf8134e7..bea9ab1c5 100644 --- a/docs/zkapps/o1js-reference/functions/MerkleWitness.mdx +++ b/docs/zkapps/o1js-reference/functions/MerkleWitness.mdx @@ -18,4 +18,4 @@ A circuit-compatible Merkle Witness. ## Source -[lib/provable/merkle-tree.ts:240](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L240) +[lib/provable/merkle-tree.ts:240](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L240) diff --git a/docs/zkapps/o1js-reference/functions/Option.mdx b/docs/zkapps/o1js-reference/functions/Option.mdx index 36a30847b..e88a24f2f 100644 --- a/docs/zkapps/o1js-reference/functions/Option.mdx +++ b/docs/zkapps/o1js-reference/functions/Option.mdx @@ -1,5 +1,8 @@ ```ts -function Option(type: A): Provable, InferValue>, InferValue | undefined> & { +function Option(type: A): Provable, InferValue>, InferValue | undefined> & (option: { + "isSome": Bool; + "value": InferProvable; + }) => Option, InferValue> & { "from": Option, InferValue>; "fromValue": Option, InferValue>; "none": Option, InferValue>; @@ -18,7 +21,10 @@ Define an optional version of a provable type. ## Returns -`Provable`\<[`Option`](../type-aliases/Option.mdx)\<[`InferProvable`](../type-aliases/InferProvable.mdx)\<`A`\>, `InferValue`\<`A`\>\>, `InferValue`\<`A`\> \| `undefined`\> & \{ +`Provable`\<[`Option`](../type-aliases/Option.mdx)\<[`InferProvable`](../type-aliases/InferProvable.mdx)\<`A`\>, `InferValue`\<`A`\>\>, `InferValue`\<`A`\> \| `undefined`\> & (`option`: \{ + `"isSome"`: [`Bool`](../type-aliases/Bool.mdx); + `"value"`: [`InferProvable`](../type-aliases/InferProvable.mdx)\<`A`\>; + \}) => [`Option`](../type-aliases/Option.mdx)\<[`InferProvable`](../type-aliases/InferProvable.mdx)\<`A`\>, `InferValue`\<`A`\>\> & \{ `"from"`: [`Option`](../type-aliases/Option.mdx)\<[`InferProvable`](../type-aliases/InferProvable.mdx)\<`A`\>, `InferValue`\<`A`\>\>; `"fromValue"`: [`Option`](../type-aliases/Option.mdx)\<[`InferProvable`](../type-aliases/InferProvable.mdx)\<`A`\>, `InferValue`\<`A`\>\>; `"none"`: [`Option`](../type-aliases/Option.mdx)\<[`InferProvable`](../type-aliases/InferProvable.mdx)\<`A`\>, `InferValue`\<`A`\>\>; @@ -40,4 +46,4 @@ let zero: UInt64 = none.orElse(0n); // specify a default value ## Source -[lib/provable/option.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/option.ts#L37) +[lib/provable/option.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/option.ts#L37) diff --git a/docs/zkapps/o1js-reference/functions/Reducer.mdx b/docs/zkapps/o1js-reference/functions/Reducer.mdx index b0f890ca0..c744c3844 100644 --- a/docs/zkapps/o1js-reference/functions/Reducer.mdx +++ b/docs/zkapps/o1js-reference/functions/Reducer.mdx @@ -22,4 +22,4 @@ function Reducer(reducer: { ## Source -[lib/mina/actions/reducer.ts:17](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/actions/reducer.ts#L17) +[lib/mina/actions/reducer.ts:17](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/actions/reducer.ts#L17) diff --git a/docs/zkapps/o1js-reference/functions/State.mdx b/docs/zkapps/o1js-reference/functions/State.mdx index fcb37096b..4806976c4 100644 --- a/docs/zkapps/o1js-reference/functions/State.mdx +++ b/docs/zkapps/o1js-reference/functions/State.mdx @@ -16,4 +16,4 @@ function State(defaultValue?: A): State ## Source -[lib/mina/state.ts:78](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/state.ts#L78) +[lib/mina/state.ts:78](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/state.ts#L78) diff --git a/docs/zkapps/o1js-reference/functions/Struct.mdx b/docs/zkapps/o1js-reference/functions/Struct.mdx index 380d34f47..4a3f6bde2 100644 --- a/docs/zkapps/o1js-reference/functions/Struct.mdx +++ b/docs/zkapps/o1js-reference/functions/Struct.mdx @@ -115,4 +115,4 @@ Class which you can extend ## Source -[lib/provable/types/struct.ts:136](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L136) +[lib/provable/types/struct.ts:136](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L136) diff --git a/docs/zkapps/o1js-reference/functions/VarField.mdx b/docs/zkapps/o1js-reference/functions/VarField.mdx index 1ba833120..6a409acde 100644 --- a/docs/zkapps/o1js-reference/functions/VarField.mdx +++ b/docs/zkapps/o1js-reference/functions/VarField.mdx @@ -12,4 +12,4 @@ function VarField(x: VarFieldVar): VarField ## Source -[lib/provable/field.ts:1242](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1242) +[lib/provable/field.ts:1242](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1242) diff --git a/docs/zkapps/o1js-reference/functions/WithHash.mdx b/docs/zkapps/o1js-reference/functions/WithHash.mdx index 4d6b3f9d0..9c18fd70f 100644 --- a/docs/zkapps/o1js-reference/functions/WithHash.mdx +++ b/docs/zkapps/o1js-reference/functions/WithHash.mdx @@ -16,4 +16,4 @@ function WithHash(type: ProvableHashable): ProvableHashable> ## Source -[lib/provable/merkle-list.ts:27](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L27) +[lib/provable/merkle-list.ts:27](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L27) diff --git a/docs/zkapps/o1js-reference/functions/ZkProgram.mdx b/docs/zkapps/o1js-reference/functions/ZkProgram.mdx index 41d918199..e831a0748 100644 --- a/docs/zkapps/o1js-reference/functions/ZkProgram.mdx +++ b/docs/zkapps/o1js-reference/functions/ZkProgram.mdx @@ -65,4 +65,4 @@ function ZkProgram(config: StatementType & { ## Source -[lib/proof-system/zkprogram.ts:393](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L393) +[lib/proof-system/zkprogram.ts:531](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L531) diff --git a/docs/zkapps/o1js-reference/functions/addCachedAccount.mdx b/docs/zkapps/o1js-reference/functions/addCachedAccount.mdx index 948f92c1c..464a9ee3a 100644 --- a/docs/zkapps/o1js-reference/functions/addCachedAccount.mdx +++ b/docs/zkapps/o1js-reference/functions/addCachedAccount.mdx @@ -16,4 +16,4 @@ Adds an account to the local cache, indexed by a GraphQL endpoint. ## Source -[lib/mina/fetch.ts:407](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L407) +[lib/mina/fetch.ts:410](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L410) diff --git a/docs/zkapps/o1js-reference/functions/assert.mdx b/docs/zkapps/o1js-reference/functions/assert.mdx index f07af403a..ca148746c 100644 --- a/docs/zkapps/o1js-reference/functions/assert.mdx +++ b/docs/zkapps/o1js-reference/functions/assert.mdx @@ -17,4 +17,4 @@ Can be used in provable code. ## Source -[lib/provable/gadgets/common.ts:57](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/gadgets/common.ts#L57) +[lib/provable/gadgets/common.ts:57](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/gadgets/common.ts#L57) diff --git a/docs/zkapps/o1js-reference/functions/checkBitLength.mdx b/docs/zkapps/o1js-reference/functions/checkBitLength.mdx index 110b05221..95c46d6ae 100644 --- a/docs/zkapps/o1js-reference/functions/checkBitLength.mdx +++ b/docs/zkapps/o1js-reference/functions/checkBitLength.mdx @@ -19,4 +19,4 @@ function checkBitLength( ## Source -[lib/provable/field.ts:1180](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1180) +[lib/provable/field.ts:1180](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1180) diff --git a/docs/zkapps/o1js-reference/functions/checkZkappTransaction.mdx b/docs/zkapps/o1js-reference/functions/checkZkappTransaction.mdx index ece3b21ea..f68b3479c 100644 --- a/docs/zkapps/o1js-reference/functions/checkZkappTransaction.mdx +++ b/docs/zkapps/o1js-reference/functions/checkZkappTransaction.mdx @@ -26,4 +26,4 @@ function checkZkappTransaction(transactionHash: string, blockLength: number): Pr ## Source -[lib/mina/fetch.ts:506](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L506) +[lib/mina/fetch.ts:509](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L509) diff --git a/docs/zkapps/o1js-reference/functions/circuitMain.mdx b/docs/zkapps/o1js-reference/functions/circuitMain.mdx index 1b00e18ee..b9da5abcb 100644 --- a/docs/zkapps/o1js-reference/functions/circuitMain.mdx +++ b/docs/zkapps/o1js-reference/functions/circuitMain.mdx @@ -19,4 +19,4 @@ function circuitMain( ## Source -[lib/proof-system/circuit.ts:192](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L192) +[lib/proof-system/circuit.ts:192](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L192) diff --git a/docs/zkapps/o1js-reference/functions/maybeSwap.mdx b/docs/zkapps/o1js-reference/functions/conditionalSwap.mdx similarity index 64% rename from docs/zkapps/o1js-reference/functions/maybeSwap.mdx rename to docs/zkapps/o1js-reference/functions/conditionalSwap.mdx index 692733222..3ff053b95 100644 --- a/docs/zkapps/o1js-reference/functions/maybeSwap.mdx +++ b/docs/zkapps/o1js-reference/functions/conditionalSwap.mdx @@ -1,5 +1,5 @@ ```ts -function maybeSwap( +function conditionalSwap( b: Bool, x: Field, y: Field): [Field, Field] @@ -19,4 +19,4 @@ function maybeSwap( ## Source -[lib/provable/merkle-tree.ts:250](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L250) +[lib/provable/merkle-tree.ts:251](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L251) diff --git a/docs/zkapps/o1js-reference/functions/createEcdsa.mdx b/docs/zkapps/o1js-reference/functions/createEcdsa.mdx index 56912cda1..46b849c8d 100644 --- a/docs/zkapps/o1js-reference/functions/createEcdsa.mdx +++ b/docs/zkapps/o1js-reference/functions/createEcdsa.mdx @@ -2,8 +2,6 @@ function createEcdsa(curve: CurveParams | typeof ForeignCurve): typeof EcdsaSignature ``` -Create a class [EcdsaSignature](../classes/EcdsaSignature.mdx) for verifying ECDSA signatures on the given curve. - ## Parameters • **curve**: `CurveParams` \| *typeof* [`ForeignCurve`](../classes/ForeignCurve.mdx) @@ -12,6 +10,10 @@ Create a class [EcdsaSignature](../classes/EcdsaSignature.mdx) for verifying ECD *typeof* [`EcdsaSignature`](../classes/EcdsaSignature.mdx) +## Deprecated + +`EcdsaSignature` is now deprecated and will be removed in a future release. Please use [EcdsaSignatureV2](../classes/EcdsaSignatureV2.mdx) instead. + ## Source -[lib/provable/crypto/foreign-ecdsa.ts:189](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-ecdsa.ts#L189) +[lib/provable/crypto/foreign-ecdsa.ts:238](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L238) diff --git a/docs/zkapps/o1js-reference/functions/createEcdsaV2.mdx b/docs/zkapps/o1js-reference/functions/createEcdsaV2.mdx new file mode 100644 index 000000000..49ebea192 --- /dev/null +++ b/docs/zkapps/o1js-reference/functions/createEcdsaV2.mdx @@ -0,0 +1,17 @@ +```ts +function createEcdsaV2(curve: CurveParams | typeof ForeignCurveV2): typeof EcdsaSignatureV2 +``` + +Create a class [EcdsaSignatureV2](../classes/EcdsaSignatureV2.mdx) for verifying ECDSA signatures on the given curve. + +## Parameters + +• **curve**: `CurveParams` \| *typeof* [`ForeignCurveV2`](../classes/ForeignCurveV2.mdx) + +## Returns + +*typeof* [`EcdsaSignatureV2`](../classes/EcdsaSignatureV2.mdx) + +## Source + +[lib/provable/crypto/foreign-ecdsa.ts:259](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-ecdsa.ts#L259) diff --git a/docs/zkapps/o1js-reference/functions/createForeignCurve.mdx b/docs/zkapps/o1js-reference/functions/createForeignCurve.mdx index 0e51f0f35..d67f7d88b 100644 --- a/docs/zkapps/o1js-reference/functions/createForeignCurve.mdx +++ b/docs/zkapps/o1js-reference/functions/createForeignCurve.mdx @@ -2,20 +2,6 @@ function createForeignCurve(params: CurveParams): typeof ForeignCurve ``` -Create a class representing an elliptic curve group, which is different from the native [Group](../classes/Group.mdx). - -```ts -const Curve = createForeignCurve(Crypto.CurveParams.Secp256k1); -``` - -`createForeignCurve(params)` takes curve parameters CurveParams as input. -We support `modulus` and `order` to be prime numbers up to 259 bits. - -The returned [ForeignCurve](../classes/ForeignCurve.mdx) class represents a _non-zero curve point_ and supports standard -elliptic curve operations like point addition and scalar multiplication. - -[ForeignCurve](../classes/ForeignCurve.mdx) also includes to associated foreign fields: `ForeignCurve.Field` and `ForeignCurve.Scalar`, see [createForeignField](createForeignField.mdx). - ## Parameters • **params**: `CurveParams` @@ -24,6 +10,10 @@ elliptic curve operations like point addition and scalar multiplication. *typeof* [`ForeignCurve`](../classes/ForeignCurve.mdx) +## Deprecated + +`createForeignCurve` is now deprecated and will be removed in a future release. Please use [createForeignCurveV2](createForeignCurveV2.mdx) instead. + ## Source -[lib/provable/crypto/foreign-curve.ts:293](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/foreign-curve.ts#L293) +[lib/provable/crypto/foreign-curve.ts:309](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L309) diff --git a/docs/zkapps/o1js-reference/functions/createForeignCurveV2.mdx b/docs/zkapps/o1js-reference/functions/createForeignCurveV2.mdx new file mode 100644 index 000000000..1fbd368b6 --- /dev/null +++ b/docs/zkapps/o1js-reference/functions/createForeignCurveV2.mdx @@ -0,0 +1,29 @@ +```ts +function createForeignCurveV2(params: CurveParams): typeof ForeignCurveV2 +``` + +Create a class representing an elliptic curve group, which is different from the native [Group](../classes/Group.mdx). + +```ts +const Curve = createForeignCurve(Crypto.CurveParams.Secp256k1); +``` + +`createForeignCurve(params)` takes curve parameters CurveParams as input. +We support `modulus` and `order` to be prime numbers up to 259 bits. + +The returned [ForeignCurveV2](../classes/ForeignCurveV2.mdx) class represents a _non-zero curve point_ and supports standard +elliptic curve operations like point addition and scalar multiplication. + +[ForeignCurveV2](../classes/ForeignCurveV2.mdx) also includes to associated foreign fields: `ForeignCurve.Field` and `ForeignCurve.Scalar`, see createForeignFieldV2. + +## Parameters + +• **params**: `CurveParams` + +## Returns + +*typeof* [`ForeignCurveV2`](../classes/ForeignCurveV2.mdx) + +## Source + +[lib/provable/crypto/foreign-curve.ts:345](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/foreign-curve.ts#L345) diff --git a/docs/zkapps/o1js-reference/functions/createForeignField.mdx b/docs/zkapps/o1js-reference/functions/createForeignField.mdx index 0beaaaf83..53db3065c 100644 --- a/docs/zkapps/o1js-reference/functions/createForeignField.mdx +++ b/docs/zkapps/o1js-reference/functions/createForeignField.mdx @@ -60,4 +60,4 @@ the modulus of the finite field you are instantiating ## Source -[lib/provable/foreign-field.ts:636](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/foreign-field.ts#L636) +[lib/provable/foreign-field.ts:636](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/foreign-field.ts#L636) diff --git a/docs/zkapps/o1js-reference/functions/declareMethods.mdx b/docs/zkapps/o1js-reference/functions/declareMethods.mdx index 1257e3b27..45316d3e1 100644 --- a/docs/zkapps/o1js-reference/functions/declareMethods.mdx +++ b/docs/zkapps/o1js-reference/functions/declareMethods.mdx @@ -33,4 +33,4 @@ Note that a method of the same name must still be defined on the class, just wit ## Source -[lib/mina/zkapp.ts:1230](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L1230) +[lib/mina/zkapp.ts:1230](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L1230) diff --git a/docs/zkapps/o1js-reference/functions/declareState.mdx b/docs/zkapps/o1js-reference/functions/declareState.mdx index f18c80b38..3b21f80af 100644 --- a/docs/zkapps/o1js-reference/functions/declareState.mdx +++ b/docs/zkapps/o1js-reference/functions/declareState.mdx @@ -51,4 +51,4 @@ declareState(MyContract, { x: Field }); ## Source -[lib/mina/state.ts:168](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/state.ts#L168) +[lib/mina/state.ts:168](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/state.ts#L168) diff --git a/docs/zkapps/o1js-reference/functions/fetchAccount.mdx b/docs/zkapps/o1js-reference/functions/fetchAccount.mdx index 1f8489f51..808ff5b38 100644 --- a/docs/zkapps/o1js-reference/functions/fetchAccount.mdx +++ b/docs/zkapps/o1js-reference/functions/fetchAccount.mdx @@ -53,4 +53,4 @@ zkapp information on the specified account or an error is thrown ## Source -[lib/mina/fetch.ts:171](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L171) +[lib/mina/fetch.ts:171](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L171) diff --git a/docs/zkapps/o1js-reference/functions/fetchEvents.mdx b/docs/zkapps/o1js-reference/functions/fetchEvents.mdx index 28dc36562..c76c3cf56 100644 --- a/docs/zkapps/o1js-reference/functions/fetchEvents.mdx +++ b/docs/zkapps/o1js-reference/functions/fetchEvents.mdx @@ -82,4 +82,4 @@ console.log(events); ## Source -[lib/mina/fetch.ts:637](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L637) +[lib/mina/fetch.ts:640](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L640) diff --git a/docs/zkapps/o1js-reference/functions/fetchLastBlock.mdx b/docs/zkapps/o1js-reference/functions/fetchLastBlock.mdx index 272d03103..7c99e037d 100644 --- a/docs/zkapps/o1js-reference/functions/fetchLastBlock.mdx +++ b/docs/zkapps/o1js-reference/functions/fetchLastBlock.mdx @@ -14,4 +14,4 @@ Fetches the last block on the Mina network. ## Source -[lib/mina/fetch.ts:450](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L450) +[lib/mina/fetch.ts:453](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L453) diff --git a/docs/zkapps/o1js-reference/functions/fetchTransactionStatus.mdx b/docs/zkapps/o1js-reference/functions/fetchTransactionStatus.mdx index dd33aa43f..d2c219344 100644 --- a/docs/zkapps/o1js-reference/functions/fetchTransactionStatus.mdx +++ b/docs/zkapps/o1js-reference/functions/fetchTransactionStatus.mdx @@ -16,4 +16,4 @@ Fetches the status of a transaction. ## Source -[lib/mina/fetch.ts:587](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L587) +[lib/mina/fetch.ts:590](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L590) diff --git a/docs/zkapps/o1js-reference/functions/genericHash.mdx b/docs/zkapps/o1js-reference/functions/genericHash.mdx index 6066b8b2a..3c8fc0b3a 100644 --- a/docs/zkapps/o1js-reference/functions/genericHash.mdx +++ b/docs/zkapps/o1js-reference/functions/genericHash.mdx @@ -23,4 +23,4 @@ function genericHash( ## Source -[lib/provable/merkle-list.ts:699](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L699) +[lib/provable/merkle-list.ts:699](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L699) diff --git a/docs/zkapps/o1js-reference/functions/initializeBindings.mdx b/docs/zkapps/o1js-reference/functions/initializeBindings.mdx index 86e817c51..5afcf9ce8 100644 --- a/docs/zkapps/o1js-reference/functions/initializeBindings.mdx +++ b/docs/zkapps/o1js-reference/functions/initializeBindings.mdx @@ -10,4 +10,4 @@ A function that has to finish before any bindings exports can be used. ## Source -[snarky.d.ts:773](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/snarky.d.ts#L773) +[snarky.d.ts:763](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/snarky.d.ts#L763) diff --git a/docs/zkapps/o1js-reference/functions/merkleListHash.mdx b/docs/zkapps/o1js-reference/functions/merkleListHash.mdx index 074eb0973..5ee31b3c1 100644 --- a/docs/zkapps/o1js-reference/functions/merkleListHash.mdx +++ b/docs/zkapps/o1js-reference/functions/merkleListHash.mdx @@ -29,4 +29,4 @@ function merkleListHash(provable: ProvableHashable, prefix: string): (hash ## Source -[lib/provable/merkle-list.ts:709](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L709) +[lib/provable/merkle-list.ts:709](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L709) diff --git a/docs/zkapps/o1js-reference/functions/method.mdx b/docs/zkapps/o1js-reference/functions/method.mdx index a77ba0ade..e3fb161a1 100644 --- a/docs/zkapps/o1js-reference/functions/method.mdx +++ b/docs/zkapps/o1js-reference/functions/method.mdx @@ -45,4 +45,4 @@ async myMethod(someArg: Field): Promise { ## Source -[lib/mina/zkapp.ts:105](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L105) +[lib/mina/zkapp.ts:105](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L105) diff --git a/docs/zkapps/o1js-reference/functions/provable.mdx b/docs/zkapps/o1js-reference/functions/provable.mdx index f147ecfbc..1e83b0b00 100644 --- a/docs/zkapps/o1js-reference/functions/provable.mdx +++ b/docs/zkapps/o1js-reference/functions/provable.mdx @@ -18,4 +18,4 @@ function provable(typeObj: A, options?: {}): InferredProvable ## Source -[lib/provable/types/provable-derivers.ts:57](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-derivers.ts#L57) +[lib/provable/types/provable-derivers.ts:57](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-derivers.ts#L57) diff --git a/docs/zkapps/o1js-reference/functions/provablePure.mdx b/docs/zkapps/o1js-reference/functions/provablePure.mdx index f0ed77ff6..32db1c3e6 100644 --- a/docs/zkapps/o1js-reference/functions/provablePure.mdx +++ b/docs/zkapps/o1js-reference/functions/provablePure.mdx @@ -1,5 +1,5 @@ ```ts -function provablePure(typeObj: A): ProvablePureExtended, InferJson> +function provablePure(typeObj: A): ProvablePureExtended, InferValue, InferJson> ``` ## Type parameters @@ -12,8 +12,8 @@ function provablePure(typeObj: A): ProvablePureExtended, Inf ## Returns -`ProvablePureExtended`\<[`InferProvable`](../type-aliases/InferProvable.mdx)\<`A`\>, `InferJson`\<`A`\>\> +`ProvablePureExtended`\<[`InferProvable`](../type-aliases/InferProvable.mdx)\<`A`\>, `InferValue`\<`A`\>, `InferJson`\<`A`\>\> ## Source -[lib/provable/types/provable-derivers.ts:59](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-derivers.ts#L59) +[lib/provable/types/provable-derivers.ts:59](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-derivers.ts#L59) diff --git a/docs/zkapps/o1js-reference/functions/public.mdx b/docs/zkapps/o1js-reference/functions/public.mdx index ad5454113..ef3a4b9f9 100644 --- a/docs/zkapps/o1js-reference/functions/public.mdx +++ b/docs/zkapps/o1js-reference/functions/public.mdx @@ -19,4 +19,4 @@ function public_( ## Source -[lib/proof-system/circuit.ts:156](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/circuit.ts#L156) +[lib/proof-system/circuit.ts:156](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/circuit.ts#L156) diff --git a/docs/zkapps/o1js-reference/functions/readVarMessage.mdx b/docs/zkapps/o1js-reference/functions/readVarMessage.mdx index 5bd8d7f9b..071506a42 100644 --- a/docs/zkapps/o1js-reference/functions/readVarMessage.mdx +++ b/docs/zkapps/o1js-reference/functions/readVarMessage.mdx @@ -19,4 +19,4 @@ function readVarMessage( ## Source -[lib/provable/field.ts:1222](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1222) +[lib/provable/field.ts:1222](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1222) diff --git a/docs/zkapps/o1js-reference/functions/sendZkapp.mdx b/docs/zkapps/o1js-reference/functions/sendZkapp.mdx index ca22cb025..6f5c226d2 100644 --- a/docs/zkapps/o1js-reference/functions/sendZkapp.mdx +++ b/docs/zkapps/o1js-reference/functions/sendZkapp.mdx @@ -25,4 +25,4 @@ Sends a zkApp command (transaction) to the specified GraphQL endpoint. ## Source -[lib/mina/fetch.ts:607](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L607) +[lib/mina/fetch.ts:610](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L610) diff --git a/docs/zkapps/o1js-reference/functions/setArchiveGraphqlEndpoint.mdx b/docs/zkapps/o1js-reference/functions/setArchiveGraphqlEndpoint.mdx index 7c313ba2d..67676874d 100644 --- a/docs/zkapps/o1js-reference/functions/setArchiveGraphqlEndpoint.mdx +++ b/docs/zkapps/o1js-reference/functions/setArchiveGraphqlEndpoint.mdx @@ -14,4 +14,4 @@ Sets up a GraphQL endpoint to be used for fetching information from an Archive N ## Source -[lib/mina/fetch.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L126) +[lib/mina/fetch.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L126) diff --git a/docs/zkapps/o1js-reference/functions/setGraphqlEndpoint.mdx b/docs/zkapps/o1js-reference/functions/setGraphqlEndpoint.mdx index a57aff94b..ee83c99db 100644 --- a/docs/zkapps/o1js-reference/functions/setGraphqlEndpoint.mdx +++ b/docs/zkapps/o1js-reference/functions/setGraphqlEndpoint.mdx @@ -12,4 +12,4 @@ function setGraphqlEndpoint(graphqlEndpoint: string): void ## Source -[lib/mina/fetch.ts:104](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L104) +[lib/mina/fetch.ts:104](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L104) diff --git a/docs/zkapps/o1js-reference/functions/setGraphqlEndpoints.mdx b/docs/zkapps/o1js-reference/functions/setGraphqlEndpoints.mdx index fd36b00f1..a55568c17 100644 --- a/docs/zkapps/o1js-reference/functions/setGraphqlEndpoints.mdx +++ b/docs/zkapps/o1js-reference/functions/setGraphqlEndpoints.mdx @@ -12,4 +12,4 @@ function setGraphqlEndpoints(__namedParameters: string[]): void ## Source -[lib/mina/fetch.ts:97](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L97) +[lib/mina/fetch.ts:97](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L97) diff --git a/docs/zkapps/o1js-reference/functions/setNumberOfWorkers.mdx b/docs/zkapps/o1js-reference/functions/setNumberOfWorkers.mdx index 301c13c8c..a8770da32 100644 --- a/docs/zkapps/o1js-reference/functions/setNumberOfWorkers.mdx +++ b/docs/zkapps/o1js-reference/functions/setNumberOfWorkers.mdx @@ -20,4 +20,4 @@ setNumberOfWorkers(2); // set the number of workers to 2 ## Source -[lib/proof-system/workers.ts:15](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/workers.ts#L15) +[lib/proof-system/workers.ts:15](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/workers.ts#L15) diff --git a/docs/zkapps/o1js-reference/functions/state-1.mdx b/docs/zkapps/o1js-reference/functions/state-1.mdx index f977e9455..cfd85d94b 100644 --- a/docs/zkapps/o1js-reference/functions/state-1.mdx +++ b/docs/zkapps/o1js-reference/functions/state-1.mdx @@ -41,4 +41,4 @@ you can use the following in the declaration of your zkapp: ## Source -[lib/mina/state.ts:92](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/state.ts#L92) +[lib/mina/state.ts:92](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/state.ts#L92) diff --git a/docs/zkapps/o1js-reference/functions/toConstantField.mdx b/docs/zkapps/o1js-reference/functions/toConstantField.mdx index 94f305e6c..1e7eae749 100644 --- a/docs/zkapps/o1js-reference/functions/toConstantField.mdx +++ b/docs/zkapps/o1js-reference/functions/toConstantField.mdx @@ -22,4 +22,4 @@ function toConstantField( ## Source -[lib/provable/field.ts:1197](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1197) +[lib/provable/field.ts:1197](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1197) diff --git a/docs/zkapps/o1js-reference/functions/toFp.mdx b/docs/zkapps/o1js-reference/functions/toFp.mdx index 28722a8dc..a6210af0e 100644 --- a/docs/zkapps/o1js-reference/functions/toFp.mdx +++ b/docs/zkapps/o1js-reference/functions/toFp.mdx @@ -12,4 +12,4 @@ function toFp(x: string | number | bigint | Field): bigint ## Source -[lib/provable/field.ts:1156](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1156) +[lib/provable/field.ts:1156](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1156) diff --git a/docs/zkapps/o1js-reference/functions/verify.mdx b/docs/zkapps/o1js-reference/functions/verify.mdx index fbd225d26..6306995bd 100644 --- a/docs/zkapps/o1js-reference/functions/verify.mdx +++ b/docs/zkapps/o1js-reference/functions/verify.mdx @@ -1,10 +1,10 @@ ```ts -function verify(proof: JsonProof | ProofBase, verificationKey: string | VerificationKey): Promise +function verify(proof: ProofBase | JsonProof, verificationKey: string | VerificationKey): Promise ``` ## Parameters -• **proof**: [`JsonProof`](../type-aliases/JsonProof.mdx) \| [`ProofBase`](../classes/ProofBase.mdx)\<`any`, `any`\> +• **proof**: [`ProofBase`](../classes/ProofBase.mdx)\<`any`, `any`\> \| [`JsonProof`](../type-aliases/JsonProof.mdx) • **verificationKey**: `string` \| [`VerificationKey`](../classes/VerificationKey.mdx) @@ -14,4 +14,4 @@ function verify(proof: JsonProof | ProofBase, verificationKey: string ## Source -[lib/proof-system/zkprogram.ts:328](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L328) +[lib/proof-system/zkprogram.ts:466](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L466) diff --git a/docs/zkapps/o1js-reference/functions/withHashes.mdx b/docs/zkapps/o1js-reference/functions/withHashes.mdx index f0b3f511a..66a00674c 100644 --- a/docs/zkapps/o1js-reference/functions/withHashes.mdx +++ b/docs/zkapps/o1js-reference/functions/withHashes.mdx @@ -43,4 +43,4 @@ hash: Field; ## Source -[lib/provable/merkle-list.ts:717](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L717) +[lib/provable/merkle-list.ts:717](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L717) diff --git a/docs/zkapps/o1js-reference/functions/withMessage.mdx b/docs/zkapps/o1js-reference/functions/withMessage.mdx index 2a378ef23..d90c5ca86 100644 --- a/docs/zkapps/o1js-reference/functions/withMessage.mdx +++ b/docs/zkapps/o1js-reference/functions/withMessage.mdx @@ -14,4 +14,4 @@ function withMessage(error: unknown, message?: string): unknown ## Source -[lib/provable/field.ts:1174](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1174) +[lib/provable/field.ts:1174](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1174) diff --git a/docs/zkapps/o1js-reference/interfaces/Permissions.mdx b/docs/zkapps/o1js-reference/interfaces/Permissions.mdx index 53959d824..393653ac7 100644 --- a/docs/zkapps/o1js-reference/interfaces/Permissions.mdx +++ b/docs/zkapps/o1js-reference/interfaces/Permissions.mdx @@ -26,7 +26,7 @@ unauthorized token interactions -- for example, it could be #### Source -[lib/mina/account-update.ts:348](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L348) +[lib/mina/account-update.ts:373](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L373) *** @@ -44,7 +44,7 @@ The Permission corresponding to the ability to emit actions to the account. #### Source -[lib/mina/account-update.ts:327](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L327) +[lib/mina/account-update.ts:352](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L352) *** @@ -63,7 +63,7 @@ an account. #### Source -[lib/mina/account-update.ts:283](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L283) +[lib/mina/account-update.ts:308](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L308) *** @@ -79,7 +79,7 @@ incrementNonce: AuthRequired; #### Source -[lib/mina/account-update.ts:336](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L336) +[lib/mina/account-update.ts:361](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L361) *** @@ -98,7 +98,7 @@ to this account. #### Source -[lib/mina/account-update.ts:295](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L295) +[lib/mina/account-update.ts:320](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L320) *** @@ -117,7 +117,7 @@ from this account. #### Source -[lib/mina/account-update.ts:289](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L289) +[lib/mina/account-update.ts:314](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L314) *** @@ -136,7 +136,7 @@ field of the account. #### Source -[lib/mina/account-update.ts:301](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L301) +[lib/mina/account-update.ts:326](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L326) *** @@ -155,7 +155,7 @@ field of the account. #### Source -[lib/mina/account-update.ts:307](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L307) +[lib/mina/account-update.ts:332](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L332) *** @@ -171,7 +171,7 @@ setTiming: AuthRequired; #### Source -[lib/mina/account-update.ts:338](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L338) +[lib/mina/account-update.ts:363](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L363) *** @@ -190,7 +190,7 @@ for this account. #### Source -[lib/mina/account-update.ts:333](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L333) +[lib/mina/account-update.ts:358](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L358) *** @@ -210,7 +210,7 @@ key associated with the circuit tied to this account. Effectively #### Source -[lib/mina/account-update.ts:314](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L314) +[lib/mina/account-update.ts:339](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L339) *** @@ -226,7 +226,7 @@ setVotingFor: AuthRequired; #### Source -[lib/mina/account-update.ts:337](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L337) +[lib/mina/account-update.ts:362](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L362) *** @@ -247,4 +247,4 @@ changed. Effectively "upgradeability" of the smart contract. #### Source -[lib/mina/account-update.ts:322](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L322) +[lib/mina/account-update.ts:347](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L347) diff --git a/docs/zkapps/o1js-reference/namespaces/Crypto/type-aliases/Curve.mdx b/docs/zkapps/o1js-reference/namespaces/Crypto/type-aliases/Curve.mdx index db11d8431..94f858b92 100644 --- a/docs/zkapps/o1js-reference/namespaces/Crypto/type-aliases/Curve.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Crypto/type-aliases/Curve.mdx @@ -4,4 +4,4 @@ type Curve: CurveAffine; ## Source -[lib/provable/crypto/crypto.ts:29](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/crypto.ts#L29) +[lib/provable/crypto/crypto.ts:29](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/crypto.ts#L29) diff --git a/docs/zkapps/o1js-reference/namespaces/Crypto/type-aliases/CurveParams.mdx b/docs/zkapps/o1js-reference/namespaces/Crypto/type-aliases/CurveParams.mdx index 7bcc42ed9..7111ce7f1 100644 --- a/docs/zkapps/o1js-reference/namespaces/Crypto/type-aliases/CurveParams.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Crypto/type-aliases/CurveParams.mdx @@ -7,4 +7,4 @@ y^2 = x^3 + ax + b ## Source -[lib/provable/crypto/crypto.ts:27](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/crypto.ts#L27) +[lib/provable/crypto/crypto.ts:27](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/crypto.ts#L27) diff --git a/docs/zkapps/o1js-reference/namespaces/Encryption/functions/decrypt.mdx b/docs/zkapps/o1js-reference/namespaces/Encryption/functions/decrypt.mdx index 292b2bd45..e6efe1c60 100644 --- a/docs/zkapps/o1js-reference/namespaces/Encryption/functions/decrypt.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Encryption/functions/decrypt.mdx @@ -16,4 +16,4 @@ Decrypts a CipherText using a [PrivateKey](../../../classes/PrivateKey.mdx).^ ## Source -[lib/provable/crypto/encryption.ts:45](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/encryption.ts#L45) +[lib/provable/crypto/encryption.ts:45](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/encryption.ts#L45) diff --git a/docs/zkapps/o1js-reference/namespaces/Encryption/functions/encrypt.mdx b/docs/zkapps/o1js-reference/namespaces/Encryption/functions/encrypt.mdx index 246842dd9..98445b283 100644 --- a/docs/zkapps/o1js-reference/namespaces/Encryption/functions/encrypt.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Encryption/functions/encrypt.mdx @@ -36,4 +36,4 @@ publicKey: Group; ## Source -[lib/provable/crypto/encryption.ts:16](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/encryption.ts#L16) +[lib/provable/crypto/encryption.ts:16](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/encryption.ts#L16) diff --git a/docs/zkapps/o1js-reference/namespaces/Experimental/README.mdx b/docs/zkapps/o1js-reference/namespaces/Experimental/README.mdx index b1d2c1419..51534da04 100644 --- a/docs/zkapps/o1js-reference/namespaces/Experimental/README.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Experimental/README.mdx @@ -6,5 +6,7 @@ This module exposes APIs that are unstable, in the sense that the API surface is | Member | Description | | :------ | :------ | | [OffchainStateCommitments](classes/OffchainStateCommitments.mdx) | Commitments that keep track of the current state of an offchain Merkle tree constructed from actions. | +| [IndexedMerkleMap](type-aliases/IndexedMerkleMap.mdx) | - | +| [IndexedMerkleMap](functions/IndexedMerkleMap.mdx) | Class factory for an Indexed Merkle Map with a given height. | | [OffchainState](functions/OffchainState.mdx) | Offchain state for a `SmartContract`. | | [memoizeWitness](functions/memoizeWitness.mdx) | Like Provable.witness, but memoizes the witness during transaction construction | diff --git a/docs/zkapps/o1js-reference/namespaces/Experimental/classes/OffchainStateCommitments.mdx b/docs/zkapps/o1js-reference/namespaces/Experimental/classes/OffchainStateCommitments.mdx index 0efa99e99..a0f90d4a5 100644 --- a/docs/zkapps/o1js-reference/namespaces/Experimental/classes/OffchainStateCommitments.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Experimental/classes/OffchainStateCommitments.mdx @@ -38,7 +38,7 @@ new OffchainStateCommitments(value: { #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) ## Properties @@ -54,7 +54,7 @@ actionState: Field = Field; #### Source -[lib/mina/actions/offchain-state-rollup.ts:44](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/actions/offchain-state-rollup.ts#L44) +[lib/mina/actions/offchain-state-rollup.ts:45](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/actions/offchain-state-rollup.ts#L45) *** @@ -70,7 +70,7 @@ root: Field = Field; #### Source -[lib/mina/actions/offchain-state-rollup.ts:41](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/actions/offchain-state-rollup.ts#L41) +[lib/mina/actions/offchain-state-rollup.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/actions/offchain-state-rollup.ts#L42) *** @@ -86,7 +86,7 @@ static _isStruct: true; #### Source -[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L144) +[lib/provable/types/struct.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L144) *** @@ -124,7 +124,47 @@ the element of type `T` to put assertions on. #### Source -[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L66) +[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L66) + +*** + +### empty() + +```ts +static empty: () => { + "actionState": Field; + "root": Field; +}; +``` + +#### Returns + +```ts +{ + "actionState": Field; + "root": Field; +} +``` + +##### actionState + +```ts +actionState: Field = Field; +``` + +##### root + +```ts +root: Field = Field; +``` + +#### Inherited from + +`OffchainState_.OffchainStateCommitments.empty` + +#### Source + +[lib/provable/types/struct.ts:154](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L154) *** @@ -168,7 +208,7 @@ root: Field = Field; #### Source -[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L87) +[lib/provable/types/provable-intf.ts:87](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L87) *** @@ -219,7 +259,7 @@ root: Field = Field; #### Source -[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L153) +[lib/provable/types/struct.ts:153](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L153) *** @@ -252,7 +292,7 @@ Convert provable type from a normal JS type. #### Source -[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L76) +[lib/provable/types/provable-intf.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L76) *** @@ -289,7 +329,7 @@ If not provided, a default value for auxiliary data is returned. #### Source -[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L37) +[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L37) *** @@ -325,7 +365,7 @@ the element of type `T` to generate the [Field](../../../classes/Field.mdx) arra #### Source -[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L26) +[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L26) *** @@ -376,7 +416,7 @@ optional packed: [Field, number][]; #### Source -[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L148) +[lib/provable/types/struct.ts:148](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L148) *** @@ -427,7 +467,7 @@ root: string = Field; #### Source -[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L152) +[lib/provable/types/struct.ts:152](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L152) *** @@ -480,27 +520,31 @@ root: bigint = Field; #### Source -[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L71) +[lib/provable/types/provable-intf.ts:71](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L71) ## Methods -### empty() +### emptyFromHeight() ```ts -static empty(): OffchainStateCommitments +static emptyFromHeight(height: number): OffchainStateCommitments ``` +#### Parameters + +• **height**: `number` + #### Returns `OffchainStateCommitments` #### Inherited from -`OffchainState_.OffchainStateCommitments.empty` +`OffchainState_.OffchainStateCommitments.emptyFromHeight` #### Source -[lib/mina/actions/offchain-state-rollup.ts:46](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/actions/offchain-state-rollup.ts#L46) +[lib/mina/actions/offchain-state-rollup.ts:47](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/actions/offchain-state-rollup.ts#L47) *** @@ -524,4 +568,4 @@ A `number` representing the size of the `T` type in terms of [Field](../../../cl #### Source -[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L56) +[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L56) diff --git a/docs/zkapps/o1js-reference/namespaces/Experimental/functions/IndexedMerkleMap.mdx b/docs/zkapps/o1js-reference/namespaces/Experimental/functions/IndexedMerkleMap.mdx new file mode 100644 index 000000000..9826416a0 --- /dev/null +++ b/docs/zkapps/o1js-reference/namespaces/Experimental/functions/IndexedMerkleMap.mdx @@ -0,0 +1,52 @@ +```ts +function IndexedMerkleMap(height: number): typeof IndexedMerkleMapBase +``` + +Class factory for an Indexed Merkle Map with a given height. + +```ts +class MerkleMap extends IndexedMerkleMap(33) {} + +let map = new MerkleMap(); + +map.insert(2n, 14n); +map.insert(1n, 13n); + +let x = map.get(2n); // 14 +``` + +Indexed Merkle maps can be used directly in provable code: + +```ts +ZkProgram({ + methods: { + test: { + privateInputs: [MerkleMap.provable, Field], + + method(map: MerkleMap, key: Field) { + // get the value associated with `key` + let value = map.getOption(key).orElse(0n); + + // increment the value by 1 + map.set(key, value.add(1)); + } + } + } +}) +``` + +Initially, every `IndexedMerkleMap` is populated by a single key-value pair: `(0, 0)`. The value for key `0` can be updated like any other. +When keys and values are hash outputs, `(0, 0)` can serve as a convenient way to represent a dummy update to the tree, since 0 is not +effciently computable as a hash image, and this update doesn't affect the Merkle root. + +## Parameters + +• **height**: `number` + +## Returns + +*typeof* `IndexedMerkleMapBase` + +## Source + +[index.ts:156](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/index.ts#L156) diff --git a/docs/zkapps/o1js-reference/namespaces/Experimental/functions/OffchainState.mdx b/docs/zkapps/o1js-reference/namespaces/Experimental/functions/OffchainState.mdx index 9777645e8..9056c4e72 100644 --- a/docs/zkapps/o1js-reference/namespaces/Experimental/functions/OffchainState.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Experimental/functions/OffchainState.mdx @@ -1,5 +1,9 @@ ```ts -function OffchainState(config: Config): OffchainState +function OffchainState(config: Config, options?: { + "logTotalCapacity": number; + "maxActionsPerProof": number; + "maxActionsPerUpdate": number; +}): OffchainState ``` Offchain state for a `SmartContract`. @@ -38,10 +42,38 @@ See the individual methods on `offchainState` for more information on usage. • **config**: `Config` +• **options?** + +• **options.logTotalCapacity?**: `number` + +The base-2 logarithm of the total capacity of the offchain state. + +Example: if you want to have 1 million individual state fields and map entries available, +set this to 20, because 2^20 ~= 1M. + +The default is 30, which allows for ~1 billion entries. + +Passing in lower numbers will reduce the number of constraints required to prove offchain state updates, +which we will make proof creation slightly faster. +Instead, you could also use a smaller total capacity to increase the `maxActionsPerProof`, so that fewer proofs are required, +which will reduce the proof time even more, but only in the case of many actions. + +• **options.maxActionsPerProof?**: `number` + +• **options.maxActionsPerUpdate?**: `number` + +The maximum number of offchain state actions that can be included in a single account update. + +In other words, you must not call `.update()` or `.overwrite()` more than this number of times in any of your smart contract methods. + +The default is 4. + +Note: When increasing this, consider decreasing `maxActionsPerProof` or `logTotalCapacity` in order to not exceed the circuit size limit. + ## Returns `OffchainState`\<`Config`\> ## Source -[index.ts:146](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/index.ts#L146) +[index.ts:160](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/index.ts#L160) diff --git a/docs/zkapps/o1js-reference/namespaces/Experimental/functions/memoizeWitness.mdx b/docs/zkapps/o1js-reference/namespaces/Experimental/functions/memoizeWitness.mdx index 3246cf955..612e67b07 100644 --- a/docs/zkapps/o1js-reference/namespaces/Experimental/functions/memoizeWitness.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Experimental/functions/memoizeWitness.mdx @@ -21,4 +21,4 @@ for reuse by the prover. This is needed to witness non-deterministic values. ## Source -[index.ts:143](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/index.ts#L143) +[index.ts:153](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/index.ts#L153) diff --git a/docs/zkapps/o1js-reference/namespaces/Experimental/type-aliases/IndexedMerkleMap.mdx b/docs/zkapps/o1js-reference/namespaces/Experimental/type-aliases/IndexedMerkleMap.mdx new file mode 100644 index 000000000..e12fe086d --- /dev/null +++ b/docs/zkapps/o1js-reference/namespaces/Experimental/type-aliases/IndexedMerkleMap.mdx @@ -0,0 +1,7 @@ +```ts +type IndexedMerkleMap: IndexedMerkleMapBase; +``` + +## Source + +[index.ts:156](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/index.ts#L156) diff --git a/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/acquireKeyPair.mdx b/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/acquireKeyPair.mdx index 675e9baa3..519367aa9 100644 --- a/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/acquireKeyPair.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/acquireKeyPair.mdx @@ -50,4 +50,4 @@ Key pair ## Source -[lib/mina/fetch.ts:816](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L816) +[lib/mina/fetch.ts:819](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L819) diff --git a/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/listAcquiredKeyPairs.mdx b/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/listAcquiredKeyPairs.mdx index 440671bab..0ab2d2f32 100644 --- a/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/listAcquiredKeyPairs.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/listAcquiredKeyPairs.mdx @@ -28,4 +28,4 @@ Key pairs list or null if the request failed ## Source -[lib/mina/fetch.ts:896](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L896) +[lib/mina/fetch.ts:899](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L899) diff --git a/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/releaseKeyPair.mdx b/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/releaseKeyPair.mdx index e50a76b66..fbd0d15ef 100644 --- a/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/releaseKeyPair.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Lightnet/functions/releaseKeyPair.mdx @@ -27,4 +27,4 @@ Response message from the account manager as string or null if the request faile ## Source -[lib/mina/fetch.ts:859](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/fetch.ts#L859) +[lib/mina/fetch.ts:862](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/fetch.ts#L862) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/LocalBlockchain.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/LocalBlockchain.mdx index cbef01a03..5ae92e192 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/LocalBlockchain.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/LocalBlockchain.mdx @@ -318,4 +318,4 @@ A mock Mina blockchain running locally and useful for testing. ## Source -[lib/mina/local-blockchain.ts:68](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/local-blockchain.ts#L68) +[lib/mina/local-blockchain.ts:68](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/local-blockchain.ts#L68) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/Network.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/Network.mdx index 52bad273d..02bcc3f22 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/Network.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/Network.mdx @@ -16,7 +16,7 @@ Represents the Mina blockchain running on a real network ### Source -[lib/mina/mina.ts:101](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina.ts#L101) +[lib/mina/mina.ts:101](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina.ts#L101) ## Network(options) @@ -47,4 +47,4 @@ function Network(options: { ### Source -[lib/mina/mina.ts:102](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina.ts#L102) +[lib/mina/mina.ts:102](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina.ts#L102) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/TestPublicKey.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/TestPublicKey.mdx index 6a7b9b48d..94aee2098 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/TestPublicKey.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/TestPublicKey.mdx @@ -12,4 +12,4 @@ function TestPublicKey(key: PrivateKey): TestPublicKey ## Source -[lib/mina/local-blockchain.ts:51](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/local-blockchain.ts#L51) +[lib/mina/local-blockchain.ts:51](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/local-blockchain.ts#L51) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/currentSlot.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/currentSlot.mdx index 5af3d406b..fc8b141d2 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/currentSlot.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/currentSlot.mdx @@ -10,4 +10,4 @@ The current slot number, according to the active Mina instance. ## Source -[lib/mina/mina-instance.ts:137](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L137) +[lib/mina/mina-instance.ts:137](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L137) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/currentTransaction.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/currentTransaction.mdx index 9a6d868a0..b106c2641 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/currentTransaction.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/currentTransaction.mdx @@ -8,4 +8,4 @@ function currentTransaction(): undefined | CurrentTransaction ## Source -[lib/mina/transaction-context.ts:16](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction-context.ts#L16) +[lib/mina/transaction-context.ts:16](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction-context.ts#L16) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/faucet.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/faucet.mdx index b987b54e1..b4dc03904 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/faucet.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/faucet.mdx @@ -16,4 +16,4 @@ Requests the [testnet faucet](https://faucet.minaprotocol.com/api/v1/faucet) to ## Source -[lib/mina/mina.ts:513](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina.ts#L513) +[lib/mina/mina.ts:513](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina.ts#L513) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/fetchActions.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/fetchActions.mdx index c5635b7a1..0c5d8a58a 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/fetchActions.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/fetchActions.mdx @@ -37,4 +37,4 @@ A list of emitted sequencing actions associated to the given public key. ## Source -[lib/mina/mina-instance.ts:197](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L197) +[lib/mina/mina-instance.ts:197](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L197) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/fetchEvents.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/fetchEvents.mdx index 4f30b438c..a9511b967 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/fetchEvents.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/fetchEvents.mdx @@ -49,4 +49,4 @@ A list of emitted events associated to the given public key. ## Source -[lib/mina/mina-instance.ts:186](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L186) +[lib/mina/mina-instance.ts:186](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L186) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/filterGroups.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/filterGroups.mdx index 4fe0854b3..6cc34a4a8 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/filterGroups.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/filterGroups.mdx @@ -40,4 +40,4 @@ signedSingle: number = singleCount; ## Source -[lib/mina/transaction-validation.ts:130](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction-validation.ts#L130) +[lib/mina/transaction-validation.ts:130](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction-validation.ts#L130) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getAccount.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getAccount.mdx index 4a1a312e5..d9e0802d1 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getAccount.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getAccount.mdx @@ -16,4 +16,4 @@ The account data associated to the given public key. ## Source -[lib/mina/mina-instance.ts:144](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L144) +[lib/mina/mina-instance.ts:144](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L144) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getActions.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getActions.mdx index 3bec48358..bed16b170 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getActions.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getActions.mdx @@ -27,4 +27,4 @@ A list of emitted sequencing actions associated to the given public key. ## Source -[lib/mina/mina-instance.ts:208](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L208) +[lib/mina/mina-instance.ts:208](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L208) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getBalance.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getBalance.mdx index c0f959d9e..d40ae5ed6 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getBalance.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getBalance.mdx @@ -16,4 +16,4 @@ The balance associated to the given public key. ## Source -[lib/mina/mina-instance.ts:179](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L179) +[lib/mina/mina-instance.ts:179](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L179) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkConstants.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkConstants.mdx index edf6624c2..8ead664e2 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkConstants.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkConstants.mdx @@ -10,4 +10,4 @@ Data associated with the current Mina network constants. ## Source -[lib/mina/mina-instance.ts:165](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L165) +[lib/mina/mina-instance.ts:165](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L165) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkId.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkId.mdx index e94010460..5bbea8a3f 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkId.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkId.mdx @@ -10,4 +10,4 @@ The current Mina network ID. ## Source -[lib/mina/mina-instance.ts:158](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L158) +[lib/mina/mina-instance.ts:158](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L158) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkState.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkState.mdx index 1a1ff8c9b..98bedc731 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkState.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getNetworkState.mdx @@ -10,4 +10,4 @@ Data associated with the current state of the Mina network. ## Source -[lib/mina/mina-instance.ts:172](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L172) +[lib/mina/mina-instance.ts:172](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L172) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getProofsEnabled.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getProofsEnabled.mdx index 2e2919768..1be9c41bc 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/getProofsEnabled.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/getProofsEnabled.mdx @@ -8,4 +8,4 @@ function getProofsEnabled(): boolean ## Source -[lib/mina/mina-instance.ts:216](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L216) +[lib/mina/mina-instance.ts:216](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L216) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/hasAccount.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/hasAccount.mdx index 3a585f447..844f50b92 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/hasAccount.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/hasAccount.mdx @@ -16,4 +16,4 @@ Checks if an account exists within the ledger. ## Source -[lib/mina/mina-instance.ts:151](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L151) +[lib/mina/mina-instance.ts:151](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L151) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/sender.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/sender.mdx index 066afb2b6..be40f9dfd 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/sender.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/sender.mdx @@ -12,4 +12,4 @@ Throws an error if not inside a transaction, or the sender wasn't passed in. ## Source -[lib/mina/mina.ts:462](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina.ts#L462) +[lib/mina/mina.ts:462](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina.ts#L462) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/setActiveInstance.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/setActiveInstance.mdx index 383ea7ea7..5624efd3d 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/setActiveInstance.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/setActiveInstance.mdx @@ -14,4 +14,4 @@ Set the currently used Mina instance. ## Source -[lib/mina/mina-instance.ts:126](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L126) +[lib/mina/mina-instance.ts:126](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L126) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/transaction.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/transaction.mdx index 0f84df5c8..e4d325cc7 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/transaction.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/transaction.mdx @@ -28,7 +28,7 @@ A transaction that can subsequently be submitted to the chain. ### Source -[lib/mina/transaction.ts:563](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L563) +[lib/mina/transaction.ts:563](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L563) ## transaction(f) @@ -46,4 +46,4 @@ function transaction(f: () => Promise): TransactionPromise ### Source -[lib/mina/transaction.ts:567](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L567) +[lib/mina/transaction.ts:567](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L567) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/functions/waitForFunding.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/functions/waitForFunding.mdx index 471ed1e1a..e2d03a1bf 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/functions/waitForFunding.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/functions/waitForFunding.mdx @@ -12,4 +12,4 @@ function waitForFunding(address: string): Promise ## Source -[lib/mina/mina.ts:489](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina.ts#L489) +[lib/mina/mina.ts:489](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina.ts#L489) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/namespaces/TestPublicKey/functions/random.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/namespaces/TestPublicKey/functions/random.mdx index dddbd0aaa..c9e583e89 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/namespaces/TestPublicKey/functions/random.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/namespaces/TestPublicKey/functions/random.mdx @@ -16,4 +16,4 @@ function random(count: N): N extends 1 ? TestPublicKey : TupleN ## Source -[lib/mina/transaction.ts:84](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L84) +[lib/mina/transaction.ts:84](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L84) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/ActionStates.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/ActionStates.mdx index 1f9c232f2..836ba8113 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/ActionStates.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/ActionStates.mdx @@ -21,4 +21,4 @@ optional fromActionState: Field; ## Source -[lib/mina/mina-instance.ts:62](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L62) +[lib/mina/mina-instance.ts:62](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L62) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/FeePayerSpec.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/FeePayerSpec.mdx index c678e437e..ac52a8fcb 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/FeePayerSpec.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/FeePayerSpec.mdx @@ -11,4 +11,4 @@ Allows you to specify information about the fee payer account and the transactio ## Source -[lib/mina/mina-instance.ts:52](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L52) +[lib/mina/mina-instance.ts:52](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L52) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/IncludedTransaction.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/IncludedTransaction.mdx index f65ca8415..629af1110 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/IncludedTransaction.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/IncludedTransaction.mdx @@ -34,4 +34,4 @@ try { ## Source -[lib/mina/transaction.ts:257](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L257) +[lib/mina/transaction.ts:257](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L257) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/NetworkConstants.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/NetworkConstants.mdx index e2be46475..0960abd43 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/NetworkConstants.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/NetworkConstants.mdx @@ -30,4 +30,4 @@ Duration of 1 slot in millisecondw ## Source -[lib/mina/mina-instance.ts:67](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L67) +[lib/mina/mina-instance.ts:67](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L67) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransaction.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransaction.mdx index 9a1dded9a..0f64b04ce 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransaction.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransaction.mdx @@ -148,4 +148,4 @@ try { ## Source -[lib/mina/transaction.ts:156](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L156) +[lib/mina/transaction.ts:156](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L156) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransactionPromise.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransactionPromise.mdx index abb6603a8..70166e876 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransactionPromise.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransactionPromise.mdx @@ -19,4 +19,4 @@ Equivalent to calling the resolved `PendingTransaction`'s `wait` method. ## Source -[lib/mina/transaction.ts:375](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L375) +[lib/mina/transaction.ts:375](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L375) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransactionStatus.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransactionStatus.mdx index 57bf9c820..f0a2e1b87 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransactionStatus.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/PendingTransactionStatus.mdx @@ -4,4 +4,4 @@ type PendingTransactionStatus: "pending" | "rejected"; ## Source -[lib/mina/transaction.ts:150](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L150) +[lib/mina/transaction.ts:150](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L150) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/RejectedTransaction.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/RejectedTransaction.mdx index ddef00b44..38d196c2c 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/RejectedTransaction.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/RejectedTransaction.mdx @@ -43,4 +43,4 @@ try { ## Source -[lib/mina/transaction.ts:281](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L281) +[lib/mina/transaction.ts:281](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L281) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/TestPublicKey.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/TestPublicKey.mdx index 06008f3c9..1ad5d917a 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/TestPublicKey.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/TestPublicKey.mdx @@ -14,4 +14,4 @@ key: PrivateKey; ## Source -[lib/mina/local-blockchain.ts:51](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/local-blockchain.ts#L51) +[lib/mina/local-blockchain.ts:51](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/local-blockchain.ts#L51) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/Transaction.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/Transaction.mdx index f1895ff67..5a28298c9 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/Transaction.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/type-aliases/Transaction.mdx @@ -52,4 +52,4 @@ if (result.status === 'pending') { ## Source -[lib/mina/transaction.ts:83](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L83) +[lib/mina/transaction.ts:83](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L83) diff --git a/docs/zkapps/o1js-reference/namespaces/Mina/variables/activeInstance.mdx b/docs/zkapps/o1js-reference/namespaces/Mina/variables/activeInstance.mdx index 9761e24d5..ab147dada 100644 --- a/docs/zkapps/o1js-reference/namespaces/Mina/variables/activeInstance.mdx +++ b/docs/zkapps/o1js-reference/namespaces/Mina/variables/activeInstance.mdx @@ -4,4 +4,4 @@ activeInstance: Mina; ## Source -[lib/mina/mina-instance.ts:108](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/mina-instance.ts#L108) +[lib/mina/mina-instance.ts:108](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/mina-instance.ts#L108) diff --git a/docs/zkapps/o1js-reference/type-aliases/Account.mdx b/docs/zkapps/o1js-reference/type-aliases/Account.mdx index 6e35dd40e..6b9fbcd05 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Account.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Account.mdx @@ -4,4 +4,4 @@ type Account: Types.Account; ## Source -[lib/mina/account.ts:19](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account.ts#L19) +[lib/mina/account.ts:19](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account.ts#L19) diff --git a/docs/zkapps/o1js-reference/type-aliases/Bool.mdx b/docs/zkapps/o1js-reference/type-aliases/Bool.mdx index 86ac175e6..3f78ee3fa 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Bool.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Bool.mdx @@ -4,4 +4,4 @@ type Bool: Bool; ## Source -[lib/provable/wrapped.ts:70](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/wrapped.ts#L70) +[lib/provable/wrapped.ts:70](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/wrapped.ts#L70) diff --git a/docs/zkapps/o1js-reference/type-aliases/BoolVar.mdx b/docs/zkapps/o1js-reference/type-aliases/BoolVar.mdx index 901a92dfb..db64429b7 100644 --- a/docs/zkapps/o1js-reference/type-aliases/BoolVar.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/BoolVar.mdx @@ -4,4 +4,4 @@ type BoolVar: FieldVar; ## Source -[lib/provable/bool.ts:14](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/bool.ts#L14) +[lib/provable/bool.ts:14](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/bool.ts#L14) diff --git a/docs/zkapps/o1js-reference/type-aliases/Bytes.mdx b/docs/zkapps/o1js-reference/type-aliases/Bytes.mdx index c718e41e6..ee83b2a7c 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Bytes.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Bytes.mdx @@ -4,4 +4,4 @@ type Bytes: InternalBytes; ## Source -[lib/provable/wrapped-classes.ts:16](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/wrapped-classes.ts#L16) +[lib/provable/wrapped-classes.ts:16](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/wrapped-classes.ts#L16) diff --git a/docs/zkapps/o1js-reference/type-aliases/Cache.mdx b/docs/zkapps/o1js-reference/type-aliases/Cache.mdx index 2f8ef0d1f..da3df09fe 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Cache.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Cache.mdx @@ -76,4 +76,4 @@ The value to write to the cache, as a byte array. ## Source -[lib/proof-system/cache.ts:31](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/cache.ts#L31) +[lib/proof-system/cache.ts:31](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/cache.ts#L31) diff --git a/docs/zkapps/o1js-reference/type-aliases/CacheHeader.mdx b/docs/zkapps/o1js-reference/type-aliases/CacheHeader.mdx index 4fd12d242..b8a1f8170 100644 --- a/docs/zkapps/o1js-reference/type-aliases/CacheHeader.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/CacheHeader.mdx @@ -14,4 +14,4 @@ Both `uniqueId` and `programId` can safely be used as a file path. ## Source -[lib/proof-system/cache.ts:98](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/cache.ts#L98) +[lib/proof-system/cache.ts:98](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/cache.ts#L98) diff --git a/docs/zkapps/o1js-reference/type-aliases/ConstantField.mdx b/docs/zkapps/o1js-reference/type-aliases/ConstantField.mdx index e160a90d8..d75d44f2a 100644 --- a/docs/zkapps/o1js-reference/type-aliases/ConstantField.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/ConstantField.mdx @@ -14,4 +14,4 @@ value: ConstantFieldVar; ## Source -[lib/provable/field.ts:1246](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1246) +[lib/provable/field.ts:1246](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1246) diff --git a/docs/zkapps/o1js-reference/type-aliases/DeployArgs.mdx b/docs/zkapps/o1js-reference/type-aliases/DeployArgs.mdx index 5b1a717dd..b2d739b0e 100644 --- a/docs/zkapps/o1js-reference/type-aliases/DeployArgs.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/DeployArgs.mdx @@ -9,4 +9,4 @@ type DeployArgs: { ## Source -[lib/mina/zkapp.ts:1208](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/zkapp.ts#L1208) +[lib/mina/zkapp.ts:1208](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/zkapp.ts#L1208) diff --git a/docs/zkapps/o1js-reference/type-aliases/Empty.mdx b/docs/zkapps/o1js-reference/type-aliases/Empty.mdx index 01fd11699..4eed9d6cb 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Empty.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Empty.mdx @@ -4,4 +4,4 @@ type Empty: Undefined; ## Source -[lib/proof-system/zkprogram.ts:81](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L81) +[lib/proof-system/zkprogram.ts:79](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L79) diff --git a/docs/zkapps/o1js-reference/type-aliases/FeatureFlags.mdx b/docs/zkapps/o1js-reference/type-aliases/FeatureFlags.mdx new file mode 100644 index 000000000..6d2b82acf --- /dev/null +++ b/docs/zkapps/o1js-reference/type-aliases/FeatureFlags.mdx @@ -0,0 +1,66 @@ +```ts +type FeatureFlags: { + "foreignFieldAdd": boolean | undefined; + "foreignFieldMul": boolean | undefined; + "lookup": boolean | undefined; + "rangeCheck0": boolean | undefined; + "rangeCheck1": boolean | undefined; + "rot": boolean | undefined; + "runtimeTables": boolean | undefined; + "xor": boolean | undefined; +}; +``` + +## Type declaration + +### foreignFieldAdd + +```ts +foreignFieldAdd: boolean | undefined; +``` + +### foreignFieldMul + +```ts +foreignFieldMul: boolean | undefined; +``` + +### lookup + +```ts +lookup: boolean | undefined; +``` + +### rangeCheck0 + +```ts +rangeCheck0: boolean | undefined; +``` + +### rangeCheck1 + +```ts +rangeCheck1: boolean | undefined; +``` + +### rot + +```ts +rot: boolean | undefined; +``` + +### runtimeTables + +```ts +runtimeTables: boolean | undefined; +``` + +### xor + +```ts +xor: boolean | undefined; +``` + +## Source + +[lib/proof-system/zkprogram.ts:90](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L90) diff --git a/docs/zkapps/o1js-reference/type-aliases/Field.mdx b/docs/zkapps/o1js-reference/type-aliases/Field.mdx index ce7fd5486..053a57bff 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Field.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Field.mdx @@ -4,4 +4,4 @@ type Field: Field; ## Source -[lib/provable/wrapped.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/wrapped.ts#L42) +[lib/provable/wrapped.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/wrapped.ts#L42) diff --git a/docs/zkapps/o1js-reference/type-aliases/FlexibleProvable.mdx b/docs/zkapps/o1js-reference/type-aliases/FlexibleProvable.mdx index 8ba41d546..c7e60b4df 100644 --- a/docs/zkapps/o1js-reference/type-aliases/FlexibleProvable.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/FlexibleProvable.mdx @@ -8,4 +8,4 @@ type FlexibleProvable: Provable | Struct; ## Source -[lib/provable/types/struct.ts:60](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L60) +[lib/provable/types/struct.ts:60](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L60) diff --git a/docs/zkapps/o1js-reference/type-aliases/FlexibleProvablePure.mdx b/docs/zkapps/o1js-reference/type-aliases/FlexibleProvablePure.mdx index e3b32bb82..397456018 100644 --- a/docs/zkapps/o1js-reference/type-aliases/FlexibleProvablePure.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/FlexibleProvablePure.mdx @@ -8,4 +8,4 @@ type FlexibleProvablePure: ProvablePure | StructPure; ## Source -[lib/provable/types/struct.ts:61](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L61) +[lib/provable/types/struct.ts:61](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L61) diff --git a/docs/zkapps/o1js-reference/type-aliases/Group.mdx b/docs/zkapps/o1js-reference/type-aliases/Group.mdx index e0511ea58..2df057dec 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Group.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Group.mdx @@ -4,4 +4,4 @@ type Group: Group; ## Source -[lib/provable/wrapped.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/wrapped.ts#L76) +[lib/provable/wrapped.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/wrapped.ts#L76) diff --git a/docs/zkapps/o1js-reference/type-aliases/InferProvable.mdx b/docs/zkapps/o1js-reference/type-aliases/InferProvable.mdx index 08bc08447..199bd21ce 100644 --- a/docs/zkapps/o1js-reference/type-aliases/InferProvable.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/InferProvable.mdx @@ -8,4 +8,4 @@ type InferProvable: GenericInferProvable; ## Source -[lib/provable/types/provable-derivers.ts:50](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-derivers.ts#L50) +[lib/provable/types/provable-derivers.ts:50](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-derivers.ts#L50) diff --git a/docs/zkapps/o1js-reference/type-aliases/JsonProof.mdx b/docs/zkapps/o1js-reference/type-aliases/JsonProof.mdx index d2c615703..70cd6fa4b 100644 --- a/docs/zkapps/o1js-reference/type-aliases/JsonProof.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/JsonProof.mdx @@ -35,4 +35,4 @@ publicOutput: string[]; ## Source -[lib/proof-system/zkprogram.ts:365](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L365) +[lib/proof-system/zkprogram.ts:503](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L503) diff --git a/docs/zkapps/o1js-reference/type-aliases/MerkleListBase.mdx b/docs/zkapps/o1js-reference/type-aliases/MerkleListBase.mdx index 17b84648c..dd013a843 100644 --- a/docs/zkapps/o1js-reference/type-aliases/MerkleListBase.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/MerkleListBase.mdx @@ -27,4 +27,4 @@ hash: Field; ## Source -[lib/provable/merkle-list.ts:45](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L45) +[lib/provable/merkle-list.ts:45](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L45) diff --git a/docs/zkapps/o1js-reference/type-aliases/MerkleListIteratorBase.mdx b/docs/zkapps/o1js-reference/type-aliases/MerkleListIteratorBase.mdx index e29e2c898..8874aac3b 100644 --- a/docs/zkapps/o1js-reference/type-aliases/MerkleListIteratorBase.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/MerkleListIteratorBase.mdx @@ -47,4 +47,4 @@ readonly hash: Field; ## Source -[lib/provable/merkle-list.ts:330](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L330) +[lib/provable/merkle-list.ts:330](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L330) diff --git a/docs/zkapps/o1js-reference/type-aliases/Option.mdx b/docs/zkapps/o1js-reference/type-aliases/Option.mdx index fc8864e52..b502bac8e 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Option.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Option.mdx @@ -52,4 +52,4 @@ value: T; ## Source -[lib/provable/option.ts:37](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/option.ts#L37) +[lib/provable/option.ts:37](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/option.ts#L37) diff --git a/docs/zkapps/o1js-reference/type-aliases/Provable.mdx b/docs/zkapps/o1js-reference/type-aliases/Provable.mdx index 3367a887d..31275fbe3 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Provable.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Provable.mdx @@ -157,4 +157,4 @@ A `number` representing the size of the `T` type in terms of [Field](../classes/ ## Source -[lib/provable/types/provable-intf.ts:17](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L17) +[lib/provable/types/provable-intf.ts:17](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L17) diff --git a/docs/zkapps/o1js-reference/type-aliases/ProvableExtended.mdx b/docs/zkapps/o1js-reference/type-aliases/ProvableExtended.mdx index 3c19458ab..77bacd7a5 100644 --- a/docs/zkapps/o1js-reference/type-aliases/ProvableExtended.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/ProvableExtended.mdx @@ -12,4 +12,4 @@ type ProvableExtended: Provable & ProvableExtension ## Source -[lib/provable/types/struct.ts:48](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L48) +[lib/provable/types/struct.ts:48](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L48) diff --git a/docs/zkapps/o1js-reference/type-aliases/ProvableHashable.mdx b/docs/zkapps/o1js-reference/type-aliases/ProvableHashable.mdx index 0bd317613..4da803e03 100644 --- a/docs/zkapps/o1js-reference/type-aliases/ProvableHashable.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/ProvableHashable.mdx @@ -10,4 +10,4 @@ type ProvableHashable: Provable & Hashable; ## Source -[lib/provable/crypto/poseidon.ts:31](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/poseidon.ts#L31) +[lib/provable/crypto/poseidon.ts:31](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/poseidon.ts#L31) diff --git a/docs/zkapps/o1js-reference/type-aliases/ProvablePure.mdx b/docs/zkapps/o1js-reference/type-aliases/ProvablePure.mdx index c017b932c..35cc35245 100644 --- a/docs/zkapps/o1js-reference/type-aliases/ProvablePure.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/ProvablePure.mdx @@ -34,4 +34,4 @@ fromFields: (fields: Field[]) => T; ## Source -[lib/provable/types/provable-intf.ts:86](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/provable-intf.ts#L86) +[lib/provable/types/provable-intf.ts:86](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/provable-intf.ts#L86) diff --git a/docs/zkapps/o1js-reference/type-aliases/Reducer.mdx b/docs/zkapps/o1js-reference/type-aliases/Reducer.mdx index 6f22b664b..e90832e20 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Reducer.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Reducer.mdx @@ -18,4 +18,4 @@ actionType: FlexibleProvablePure; ## Source -[lib/mina/actions/reducer.ts:17](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/actions/reducer.ts#L17) +[lib/mina/actions/reducer.ts:17](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/actions/reducer.ts#L17) diff --git a/docs/zkapps/o1js-reference/type-aliases/ScalarConst.mdx b/docs/zkapps/o1js-reference/type-aliases/ScalarConst.mdx index 06ed4f1fe..e3861998d 100644 --- a/docs/zkapps/o1js-reference/type-aliases/ScalarConst.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/ScalarConst.mdx @@ -4,4 +4,4 @@ type ScalarConst: [0, bigint]; ## Source -[lib/provable/scalar.ts:19](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/scalar.ts#L19) +[lib/provable/scalar.ts:19](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/scalar.ts#L19) diff --git a/docs/zkapps/o1js-reference/type-aliases/State.mdx b/docs/zkapps/o1js-reference/type-aliases/State.mdx index 886299ef7..45bed8ea7 100644 --- a/docs/zkapps/o1js-reference/type-aliases/State.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/State.mdx @@ -111,4 +111,4 @@ Set the on-chain state to a new value. ## Source -[lib/mina/state.ts:78](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/state.ts#L78) +[lib/mina/state.ts:78](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/state.ts#L78) diff --git a/docs/zkapps/o1js-reference/type-aliases/Struct.mdx b/docs/zkapps/o1js-reference/type-aliases/Struct.mdx index 73dd240ac..664f46726 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Struct.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Struct.mdx @@ -18,4 +18,4 @@ _isStruct: true; ## Source -[lib/provable/types/struct.ts:136](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/types/struct.ts#L136) +[lib/provable/types/struct.ts:136](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/types/struct.ts#L136) diff --git a/docs/zkapps/o1js-reference/type-aliases/TransactionPromise.mdx b/docs/zkapps/o1js-reference/type-aliases/TransactionPromise.mdx index a06a4c2c1..0f058a81f 100644 --- a/docs/zkapps/o1js-reference/type-aliases/TransactionPromise.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/TransactionPromise.mdx @@ -31,4 +31,4 @@ Equivalent to calling the resolved `Transaction`'s `send` method. ## Source -[lib/mina/transaction.ts:313](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/transaction.ts#L313) +[lib/mina/transaction.ts:313](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/transaction.ts#L313) diff --git a/docs/zkapps/o1js-reference/type-aliases/TransactionStatus.mdx b/docs/zkapps/o1js-reference/type-aliases/TransactionStatus.mdx index 18711f8ff..169069216 100644 --- a/docs/zkapps/o1js-reference/type-aliases/TransactionStatus.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/TransactionStatus.mdx @@ -10,4 +10,4 @@ UNKNOWN: The transaction has either been snarked, reached finality through conse ## Source -[lib/mina/graphql.ts:213](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/graphql.ts#L213) +[lib/mina/graphql.ts:215](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/graphql.ts#L215) diff --git a/docs/zkapps/o1js-reference/type-aliases/Undefined.mdx b/docs/zkapps/o1js-reference/type-aliases/Undefined.mdx index e54fb9431..464f4bf7f 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Undefined.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Undefined.mdx @@ -4,4 +4,4 @@ type Undefined: undefined; ## Source -[lib/proof-system/zkprogram.ts:78](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L78) +[lib/proof-system/zkprogram.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L76) diff --git a/docs/zkapps/o1js-reference/type-aliases/VarField.mdx b/docs/zkapps/o1js-reference/type-aliases/VarField.mdx index bc3cb6dcf..25b774fa1 100644 --- a/docs/zkapps/o1js-reference/type-aliases/VarField.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/VarField.mdx @@ -14,4 +14,4 @@ value: VarFieldVar; ## Source -[lib/provable/field.ts:1242](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/field.ts#L1242) +[lib/provable/field.ts:1242](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/field.ts#L1242) diff --git a/docs/zkapps/o1js-reference/type-aliases/Void.mdx b/docs/zkapps/o1js-reference/type-aliases/Void.mdx index 3c3550730..d8db8b3d4 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Void.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Void.mdx @@ -4,4 +4,4 @@ type Void: undefined; ## Source -[lib/proof-system/zkprogram.ts:83](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L83) +[lib/proof-system/zkprogram.ts:81](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L81) diff --git a/docs/zkapps/o1js-reference/type-aliases/WithHash.mdx b/docs/zkapps/o1js-reference/type-aliases/WithHash.mdx index bcc6a9f2d..0cccc95f5 100644 --- a/docs/zkapps/o1js-reference/type-aliases/WithHash.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/WithHash.mdx @@ -25,4 +25,4 @@ previousHash: Field; ## Source -[lib/provable/merkle-list.ts:27](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L27) +[lib/provable/merkle-list.ts:27](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L27) diff --git a/docs/zkapps/o1js-reference/type-aliases/Witness.mdx b/docs/zkapps/o1js-reference/type-aliases/Witness.mdx index 261285217..092f13d2a 100644 --- a/docs/zkapps/o1js-reference/type-aliases/Witness.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/Witness.mdx @@ -7,4 +7,4 @@ type Witness: { ## Source -[lib/provable/merkle-tree.ts:16](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-tree.ts#L16) +[lib/provable/merkle-tree.ts:16](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-tree.ts#L16) diff --git a/docs/zkapps/o1js-reference/type-aliases/ZkProgram.mdx b/docs/zkapps/o1js-reference/type-aliases/ZkProgram.mdx index 69481849d..388265670 100644 --- a/docs/zkapps/o1js-reference/type-aliases/ZkProgram.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/ZkProgram.mdx @@ -13,4 +13,4 @@ type ZkProgram: ReturnType; ## Source -[lib/proof-system/zkprogram.ts:393](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L393) +[lib/proof-system/zkprogram.ts:531](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L531) diff --git a/docs/zkapps/o1js-reference/type-aliases/ZkappPublicInput.mdx b/docs/zkapps/o1js-reference/type-aliases/ZkappPublicInput.mdx index 1507d01c1..8d3acb11e 100644 --- a/docs/zkapps/o1js-reference/type-aliases/ZkappPublicInput.mdx +++ b/docs/zkapps/o1js-reference/type-aliases/ZkappPublicInput.mdx @@ -33,4 +33,4 @@ calls: Field; ## Source -[lib/mina/account-update.ts:1965](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1965) +[lib/mina/account-update.ts:1990](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1990) diff --git a/docs/zkapps/o1js-reference/variables/Account.mdx b/docs/zkapps/o1js-reference/variables/Account.mdx index 6ed62b8ca..0574432c0 100644 --- a/docs/zkapps/o1js-reference/variables/Account.mdx +++ b/docs/zkapps/o1js-reference/variables/Account.mdx @@ -4,4 +4,4 @@ Account: GenericProvableExtended; ## Source -[lib/mina/account.ts:19](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account.ts#L19) +[lib/mina/account.ts:19](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account.ts#L19) diff --git a/docs/zkapps/o1js-reference/variables/Bool.mdx b/docs/zkapps/o1js-reference/variables/Bool.mdx index 206330a18..23597ae20 100644 --- a/docs/zkapps/o1js-reference/variables/Bool.mdx +++ b/docs/zkapps/o1js-reference/variables/Bool.mdx @@ -30,4 +30,4 @@ const b: Bool = Field(5).equals(6); ## Source -[lib/provable/wrapped.ts:70](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/wrapped.ts#L70) +[lib/provable/wrapped.ts:70](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/wrapped.ts#L70) diff --git a/docs/zkapps/o1js-reference/variables/Cache.mdx b/docs/zkapps/o1js-reference/variables/Cache.mdx index 7439546ee..a96ca5647 100644 --- a/docs/zkapps/o1js-reference/variables/Cache.mdx +++ b/docs/zkapps/o1js-reference/variables/Cache.mdx @@ -38,4 +38,4 @@ None: Cache; ## Source -[lib/proof-system/cache.ts:31](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/cache.ts#L31) +[lib/proof-system/cache.ts:31](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/cache.ts#L31) diff --git a/docs/zkapps/o1js-reference/variables/Crypto.mdx b/docs/zkapps/o1js-reference/variables/Crypto.mdx index a70676404..f674c884d 100644 --- a/docs/zkapps/o1js-reference/variables/Crypto.mdx +++ b/docs/zkapps/o1js-reference/variables/Crypto.mdx @@ -32,4 +32,4 @@ Create elliptic curve arithmetic methods. ## Source -[lib/provable/crypto/crypto.ts:8](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/crypto.ts#L8) +[lib/provable/crypto/crypto.ts:8](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/crypto.ts#L8) diff --git a/docs/zkapps/o1js-reference/variables/Empty.mdx b/docs/zkapps/o1js-reference/variables/Empty.mdx index 99e427529..be0f7e0e9 100644 --- a/docs/zkapps/o1js-reference/variables/Empty.mdx +++ b/docs/zkapps/o1js-reference/variables/Empty.mdx @@ -4,4 +4,4 @@ Empty: ProvablePureExtended; ## Source -[lib/proof-system/zkprogram.ts:81](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L81) +[lib/proof-system/zkprogram.ts:79](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L79) diff --git a/docs/zkapps/o1js-reference/variables/FeatureFlags.mdx b/docs/zkapps/o1js-reference/variables/FeatureFlags.mdx new file mode 100644 index 000000000..e587a23e1 --- /dev/null +++ b/docs/zkapps/o1js-reference/variables/FeatureFlags.mdx @@ -0,0 +1,216 @@ +```ts +FeatureFlags: { + "allMaybe": { + "foreignFieldAdd": undefined; + "foreignFieldMul": undefined; + "lookup": undefined; + "rangeCheck0": undefined; + "rangeCheck1": undefined; + "rot": undefined; + "runtimeTables": undefined; + "xor": undefined; + }; + "allNone": { + "foreignFieldAdd": false; + "foreignFieldMul": false; + "lookup": false; + "rangeCheck0": false; + "rangeCheck1": false; + "rot": false; + "runtimeTables": false; + "xor": false; + }; + "fromGates": featureFlagsFromGates; + "fromZkProgram": (program: AnalysableProgram) => Promise; + "fromZkProgramList": (programs: AnalysableProgram[]) => Promise; +}; +``` + +Feature flags indicate what custom gates are used in a proof of circuit. +Side loading, for example, requires a set of feature flags in advance (at compile time) in order to verify and side load proofs. +If the side loaded proofs and verification keys do not match the specified feature flag configurations, the verification will fail. +Flags specified as `undefined` are considered as `maybe` by Pickles. This means, proofs can be sided loaded that can, but don't have to, use a specific custom gate. +_Note:_ `Maybe` feature flags incur a proving overhead. + +## Type declaration + +### allMaybe + +```ts +allMaybe: { + "foreignFieldAdd": undefined; + "foreignFieldMul": undefined; + "lookup": undefined; + "rangeCheck0": undefined; + "rangeCheck1": undefined; + "rot": undefined; + "runtimeTables": undefined; + "xor": undefined; +}; +``` + +Returns a feature flag configuration where all flags are optional. + +### allMaybe.foreignFieldAdd + +```ts +foreignFieldAdd: undefined = undefined; +``` + +### allMaybe.foreignFieldMul + +```ts +foreignFieldMul: undefined = undefined; +``` + +### allMaybe.lookup + +```ts +lookup: undefined = undefined; +``` + +### allMaybe.rangeCheck0 + +```ts +rangeCheck0: undefined = undefined; +``` + +### allMaybe.rangeCheck1 + +```ts +rangeCheck1: undefined = undefined; +``` + +### allMaybe.rot + +```ts +rot: undefined = undefined; +``` + +### allMaybe.runtimeTables + +```ts +runtimeTables: undefined = undefined; +``` + +### allMaybe.xor + +```ts +xor: undefined = undefined; +``` + +### allNone + +```ts +allNone: { + "foreignFieldAdd": false; + "foreignFieldMul": false; + "lookup": false; + "rangeCheck0": false; + "rangeCheck1": false; + "rot": false; + "runtimeTables": false; + "xor": false; +}; +``` + +Returns a feature flag configuration where all flags are set to false. + +### allNone.foreignFieldAdd + +```ts +foreignFieldAdd: boolean = false; +``` + +### allNone.foreignFieldMul + +```ts +foreignFieldMul: boolean = false; +``` + +### allNone.lookup + +```ts +lookup: boolean = false; +``` + +### allNone.rangeCheck0 + +```ts +rangeCheck0: boolean = false; +``` + +### allNone.rangeCheck1 + +```ts +rangeCheck1: boolean = false; +``` + +### allNone.rot + +```ts +rot: boolean = false; +``` + +### allNone.runtimeTables + +```ts +runtimeTables: boolean = false; +``` + +### allNone.xor + +```ts +xor: boolean = false; +``` + +### fromGates() + +```ts +fromGates: (gates: Gate[]) => FeatureFlags = featureFlagsFromGates; +``` + +Given a list of gates, returns the feature flag configuration that the gates use. + +#### Parameters + +• **gates**: `Gate`[] + +#### Returns + +[`FeatureFlags`](../type-aliases/FeatureFlags.mdx) + +### fromZkProgram() + +```ts +fromZkProgram: (program: AnalysableProgram) => Promise; +``` + +Given a ZkProgram, return the feature flag configuration that fits the given program. +This function considers all methods of the specified ZkProgram and finds a configuration that fits all. + +#### Parameters + +• **program**: `AnalysableProgram` + +#### Returns + +`Promise`\<[`FeatureFlags`](../type-aliases/FeatureFlags.mdx)\> + +### fromZkProgramList() + +```ts +fromZkProgramList: (programs: AnalysableProgram[]) => Promise; +``` + +#### Parameters + +• **programs**: `AnalysableProgram`[] + +#### Returns + +`Promise`\<[`FeatureFlags`](../type-aliases/FeatureFlags.mdx)\> + +## Source + +[lib/proof-system/zkprogram.ts:90](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L90) diff --git a/docs/zkapps/o1js-reference/variables/Field.mdx b/docs/zkapps/o1js-reference/variables/Field.mdx index 3dcd8f895..1284433c9 100644 --- a/docs/zkapps/o1js-reference/variables/Field.mdx +++ b/docs/zkapps/o1js-reference/variables/Field.mdx @@ -47,4 +47,4 @@ the value to convert to a [Field](Field.mdx) ## Source -[lib/provable/wrapped.ts:42](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/wrapped.ts#L42) +[lib/provable/wrapped.ts:42](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/wrapped.ts#L42) diff --git a/docs/zkapps/o1js-reference/variables/Gadgets.mdx b/docs/zkapps/o1js-reference/variables/Gadgets.mdx index 7860e0a54..fcc404849 100644 --- a/docs/zkapps/o1js-reference/variables/Gadgets.mdx +++ b/docs/zkapps/o1js-reference/variables/Gadgets.mdx @@ -576,6 +576,9 @@ Provable.log(sum); // ['16', '0', '0'] = limb representation of 16 = 4 + 5 - 10 ```ts SHA256: { + "compression": sha256Compression; + "createMessageSchedule": (M: UInt32[]) => UInt32[]; + get "initialState": UInt32[]; "hash": Bytes; }; ``` @@ -598,6 +601,64 @@ let preimage = Bytes.fromString("hello world"); let digest = Gadgets.SHA256.hash(preimage); ``` +### SHA256.compression() + +```ts +compression: (H: UInt32[], W: UInt32[]) => UInt32[] = sha256Compression; +``` + +Performs the SHA-256 compression function on the given hash values and message schedule. + +#### Parameters + +• **H**: [`UInt32`](../classes/UInt32.mdx)[] + +The initial or intermediate hash values (8-element array of UInt32). + +• **W**: [`UInt32`](../classes/UInt32.mdx)[] + +The message schedule (64-element array of UInt32). + +#### Returns + +[`UInt32`](../classes/UInt32.mdx)[] + +The updated intermediate hash values after compression. + +### SHA256.createMessageSchedule() + +```ts +createMessageSchedule: (M: UInt32[]) => UInt32[]; +``` + +Prepares the message schedule for the SHA-256 compression function from the given message block. + +#### Parameters + +• **M**: [`UInt32`](../classes/UInt32.mdx)[] + +The 512-bit message block (16-element array of UInt32). + +#### Returns + +[`UInt32`](../classes/UInt32.mdx)[] + +The message schedule (64-element array of UInt32). + +### SHA256.initialState + +```ts +get initialState(): UInt32[] +``` + +#### Returns + +[`UInt32`](../classes/UInt32.mdx)[] + +#### Source + +[lib/provable/gadgets/sha256.ts:105](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/gadgets/sha256.ts#L105) + ### SHA256.hash() #### Parameters @@ -1334,4 +1395,4 @@ c.assertEquals(0b0110); ## Source -[lib/provable/gadgets/gadgets.ts:36](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/gadgets/gadgets.ts#L36) +[lib/provable/gadgets/gadgets.ts:36](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/gadgets/gadgets.ts#L36) diff --git a/docs/zkapps/o1js-reference/variables/Group.mdx b/docs/zkapps/o1js-reference/variables/Group.mdx index 2cf2216ea..b15cefb85 100644 --- a/docs/zkapps/o1js-reference/variables/Group.mdx +++ b/docs/zkapps/o1js-reference/variables/Group.mdx @@ -17,4 +17,4 @@ An element of a Group. ## Source -[lib/provable/wrapped.ts:76](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/wrapped.ts#L76) +[lib/provable/wrapped.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/wrapped.ts#L76) diff --git a/docs/zkapps/o1js-reference/variables/Hash.mdx b/docs/zkapps/o1js-reference/variables/Hash.mdx index 49fdea6cb..f53dcdbf4 100644 --- a/docs/zkapps/o1js-reference/variables/Hash.mdx +++ b/docs/zkapps/o1js-reference/variables/Hash.mdx @@ -382,4 +382,4 @@ You can find the full set of Poseidon parameters [here](https://github.com/o1-la ## Source -[lib/provable/crypto/hash.ts:11](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/hash.ts#L11) +[lib/provable/crypto/hash.ts:11](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/hash.ts#L11) diff --git a/docs/zkapps/o1js-reference/variables/Keccak.mdx b/docs/zkapps/o1js-reference/variables/Keccak.mdx index 46772f0cf..a9501b021 100644 --- a/docs/zkapps/o1js-reference/variables/Keccak.mdx +++ b/docs/zkapps/o1js-reference/variables/Keccak.mdx @@ -108,4 +108,4 @@ let digest512= Keccak.preNist(512, preimage); ## Source -[lib/provable/crypto/keccak.ts:11](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/keccak.ts#L11) +[lib/provable/crypto/keccak.ts:11](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/keccak.ts#L11) diff --git a/docs/zkapps/o1js-reference/variables/Permissions.mdx b/docs/zkapps/o1js-reference/variables/Permissions.mdx index 2f3858331..ddd9511c0 100644 --- a/docs/zkapps/o1js-reference/variables/Permissions.mdx +++ b/docs/zkapps/o1js-reference/variables/Permissions.mdx @@ -269,4 +269,4 @@ Modification is permitted by signatures only, using the private key of the zkapp ## Source -[lib/mina/account-update.ts:278](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L278) +[lib/mina/account-update.ts:303](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L303) diff --git a/docs/zkapps/o1js-reference/variables/Poseidon.mdx b/docs/zkapps/o1js-reference/variables/Poseidon.mdx index cb60caced..de59cba21 100644 --- a/docs/zkapps/o1js-reference/variables/Poseidon.mdx +++ b/docs/zkapps/o1js-reference/variables/Poseidon.mdx @@ -129,4 +129,4 @@ The output point is deterministic and its discrete log is not efficiently comput ## Source -[lib/provable/crypto/poseidon.ts:55](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/crypto/poseidon.ts#L55) +[lib/provable/crypto/poseidon.ts:55](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/crypto/poseidon.ts#L55) diff --git a/docs/zkapps/o1js-reference/variables/TokenId.mdx b/docs/zkapps/o1js-reference/variables/TokenId.mdx index b554321c2..7d62dfebb 100644 --- a/docs/zkapps/o1js-reference/variables/TokenId.mdx +++ b/docs/zkapps/o1js-reference/variables/TokenId.mdx @@ -49,4 +49,4 @@ default: Field; ## Source -[lib/mina/account-update.ts:617](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L617) +[lib/mina/account-update.ts:642](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L642) diff --git a/docs/zkapps/o1js-reference/variables/TransactionVersion.mdx b/docs/zkapps/o1js-reference/variables/TransactionVersion.mdx index ec700148b..1377dfa9e 100644 --- a/docs/zkapps/o1js-reference/variables/TransactionVersion.mdx +++ b/docs/zkapps/o1js-reference/variables/TransactionVersion.mdx @@ -18,4 +18,4 @@ current: () => UInt32; ## Source -[lib/mina/account-update.ts:118](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L118) +[lib/mina/account-update.ts:118](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L118) diff --git a/docs/zkapps/o1js-reference/variables/Undefined.mdx b/docs/zkapps/o1js-reference/variables/Undefined.mdx index 6d08af7ff..91a33b93d 100644 --- a/docs/zkapps/o1js-reference/variables/Undefined.mdx +++ b/docs/zkapps/o1js-reference/variables/Undefined.mdx @@ -4,4 +4,4 @@ Undefined: ProvablePureExtended; ## Source -[lib/proof-system/zkprogram.ts:78](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L78) +[lib/proof-system/zkprogram.ts:76](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L76) diff --git a/docs/zkapps/o1js-reference/variables/Void.mdx b/docs/zkapps/o1js-reference/variables/Void.mdx index 6778bdb9a..bc46a5cb9 100644 --- a/docs/zkapps/o1js-reference/variables/Void.mdx +++ b/docs/zkapps/o1js-reference/variables/Void.mdx @@ -4,4 +4,4 @@ Void: ProvablePureExtended; ## Source -[lib/proof-system/zkprogram.ts:83](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/proof-system/zkprogram.ts#L83) +[lib/proof-system/zkprogram.ts:81](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/proof-system/zkprogram.ts#L81) diff --git a/docs/zkapps/o1js-reference/variables/ZkappPublicInput.mdx b/docs/zkapps/o1js-reference/variables/ZkappPublicInput.mdx index 87d338c76..271770ebf 100644 --- a/docs/zkapps/o1js-reference/variables/ZkappPublicInput.mdx +++ b/docs/zkapps/o1js-reference/variables/ZkappPublicInput.mdx @@ -5,7 +5,10 @@ ZkappPublicInput: ProvablePureExtended<{ }, { "accountUpdate": Field; "calls": Field; -}, any>; + }, { + "accountUpdate": Field; + "calls": Field; +}>; ``` ## Type declaration @@ -24,4 +27,4 @@ calls: Field = Field; ## Source -[lib/mina/account-update.ts:1965](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1965) +[lib/mina/account-update.ts:1990](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/mina/account-update.ts#L1990) diff --git a/docs/zkapps/o1js-reference/variables/emptyHash.mdx b/docs/zkapps/o1js-reference/variables/emptyHash.mdx index dd4134a73..a3cf00a83 100644 --- a/docs/zkapps/o1js-reference/variables/emptyHash.mdx +++ b/docs/zkapps/o1js-reference/variables/emptyHash.mdx @@ -4,4 +4,4 @@ const emptyHash: Field; ## Source -[lib/provable/merkle-list.ts:23](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L23) +[lib/provable/merkle-list.ts:23](https://github.com/o1-labs/o1js/blob/72b8e2c2b9aaba4b5c12257bdd63dfe2676a3d99/src/lib/provable/merkle-list.ts#L23) diff --git a/sidebars.js b/sidebars.js index ebeb0f8ce..ae130f51e 100644 --- a/sidebars.js +++ b/sidebars.js @@ -156,8 +156,6 @@ module.exports = { 'zkapps/tutorials/deploying-to-a-network', 'zkapps/tutorials/zkapp-ui-with-react', 'zkapps/tutorials/common-types-and-functions', - // TODO: enable when there is an updated offchain storage tutorial - // 'zkapps/tutorials/offchain-storage', 'zkapps/tutorials/oracle', 'zkapps/tutorials/recursion', 'zkapps/tutorials/account-updates', @@ -169,10 +167,6 @@ module.exports = { { type: 'category', label: 'o1js Reference', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/README', - }, items: [ { type: 'doc', @@ -182,10 +176,6 @@ module.exports = { { type: 'category', label: 'Classes', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/classes/AccountUpdate', - }, items: [ { type: 'doc', @@ -247,6 +237,11 @@ module.exports = { id: 'zkapps/o1js-reference/classes/EcdsaSignature', label: 'EcdsaSignature', }, + { + type: 'doc', + id: 'zkapps/o1js-reference/classes/EcdsaSignatureV2', + label: 'EcdsaSignatureV2', + }, { type: 'doc', id: 'zkapps/o1js-reference/classes/Field', @@ -257,6 +252,11 @@ module.exports = { id: 'zkapps/o1js-reference/classes/ForeignCurve', label: 'ForeignCurve', }, + { + type: 'doc', + id: 'zkapps/o1js-reference/classes/ForeignCurveV2', + label: 'ForeignCurveV2', + }, { type: 'doc', id: 'zkapps/o1js-reference/classes/ForeignField', @@ -412,10 +412,6 @@ module.exports = { { type: 'category', label: 'Functions', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/functions/Bytes', - }, items: [ { type: 'doc', @@ -497,16 +493,31 @@ module.exports = { id: 'zkapps/o1js-reference/functions/circuitMain', label: 'circuitMain', }, + { + type: 'doc', + id: 'zkapps/o1js-reference/functions/conditionalSwap', + label: 'conditionalSwap', + }, { type: 'doc', id: 'zkapps/o1js-reference/functions/createEcdsa', label: 'createEcdsa', }, + { + type: 'doc', + id: 'zkapps/o1js-reference/functions/createEcdsaV2', + label: 'createEcdsaV2', + }, { type: 'doc', id: 'zkapps/o1js-reference/functions/createForeignCurve', label: 'createForeignCurve', }, + { + type: 'doc', + id: 'zkapps/o1js-reference/functions/createForeignCurveV2', + label: 'createForeignCurveV2', + }, { type: 'doc', id: 'zkapps/o1js-reference/functions/createForeignField', @@ -552,11 +563,6 @@ module.exports = { id: 'zkapps/o1js-reference/functions/initializeBindings', label: 'initializeBindings', }, - { - type: 'doc', - id: 'zkapps/o1js-reference/functions/maybeSwap', - label: 'maybeSwap', - }, { type: 'doc', id: 'zkapps/o1js-reference/functions/merkleListHash', @@ -647,10 +653,6 @@ module.exports = { { type: 'category', label: 'Interfaces', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/interfaces/Permissions', - }, items: [ { type: 'doc', @@ -662,18 +664,10 @@ module.exports = { { type: 'category', label: 'Namespaces', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Crypto/README', - }, items: [ { type: 'category', label: 'Crypto', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Crypto/README', - }, items: [ { type: 'doc', @@ -683,10 +677,6 @@ module.exports = { { type: 'category', label: 'Type-Aliases', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Crypto/type-aliases/Curve', - }, items: [ { type: 'doc', @@ -705,10 +695,6 @@ module.exports = { { type: 'category', label: 'Encryption', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Encryption/README', - }, items: [ { type: 'doc', @@ -718,10 +704,6 @@ module.exports = { { type: 'category', label: 'Functions', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Encryption/functions/decrypt', - }, items: [ { type: 'doc', @@ -740,10 +722,6 @@ module.exports = { { type: 'category', label: 'Experimental', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Experimental/README', - }, items: [ { type: 'doc', @@ -753,10 +731,6 @@ module.exports = { { type: 'category', label: 'Classes', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Experimental/classes/OffchainStateCommitments', - }, items: [ { type: 'doc', @@ -768,11 +742,12 @@ module.exports = { { type: 'category', label: 'Functions', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Experimental/functions/OffchainState', - }, items: [ + { + type: 'doc', + id: 'zkapps/o1js-reference/namespaces/Experimental/functions/IndexedMerkleMap', + label: 'IndexedMerkleMap', + }, { type: 'doc', id: 'zkapps/o1js-reference/namespaces/Experimental/functions/OffchainState', @@ -785,15 +760,22 @@ module.exports = { }, ], }, + { + type: 'category', + label: 'Type-Aliases', + items: [ + { + type: 'doc', + id: 'zkapps/o1js-reference/namespaces/Experimental/type-aliases/IndexedMerkleMap', + label: 'IndexedMerkleMap', + }, + ], + }, ], }, { type: 'category', label: 'Lightnet', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Lightnet/README', - }, items: [ { type: 'doc', @@ -803,10 +785,6 @@ module.exports = { { type: 'category', label: 'Functions', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Lightnet/functions/acquireKeyPair', - }, items: [ { type: 'doc', @@ -830,10 +808,6 @@ module.exports = { { type: 'category', label: 'Mina', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Mina/README', - }, items: [ { type: 'doc', @@ -843,10 +817,6 @@ module.exports = { { type: 'category', label: 'Functions', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Mina/functions/LocalBlockchain', - }, items: [ { type: 'doc', @@ -958,18 +928,10 @@ module.exports = { { type: 'category', label: 'Namespaces', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Mina/namespaces/TestPublicKey/README', - }, items: [ { type: 'category', label: 'TestPublicKey', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Mina/namespaces/TestPublicKey/README', - }, items: [ { type: 'doc', @@ -979,10 +941,6 @@ module.exports = { { type: 'category', label: 'Functions', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Mina/namespaces/TestPublicKey/functions/random', - }, items: [ { type: 'doc', @@ -996,10 +954,6 @@ module.exports = { { type: 'category', label: 'Transaction', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Mina/namespaces/Transaction/README', - }, items: [ { type: 'doc', @@ -1009,10 +963,6 @@ module.exports = { { type: 'category', label: 'Functions', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Mina/namespaces/Transaction/functions/fromJSON', - }, items: [ { type: 'doc', @@ -1028,10 +978,6 @@ module.exports = { { type: 'category', label: 'Type-Aliases', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Mina/type-aliases/ActionStates', - }, items: [ { type: 'doc', @@ -1088,10 +1034,6 @@ module.exports = { { type: 'category', label: 'Variables', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/namespaces/Mina/variables/activeInstance', - }, items: [ { type: 'doc', @@ -1107,10 +1049,6 @@ module.exports = { { type: 'category', label: 'Type-Aliases', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/type-aliases/Account', - }, items: [ { type: 'doc', @@ -1157,6 +1095,11 @@ module.exports = { id: 'zkapps/o1js-reference/type-aliases/Empty', label: 'Empty', }, + { + type: 'doc', + id: 'zkapps/o1js-reference/type-aliases/FeatureFlags', + label: 'FeatureFlags', + }, { type: 'doc', id: 'zkapps/o1js-reference/type-aliases/Field', @@ -1292,10 +1235,6 @@ module.exports = { { type: 'category', label: 'Variables', - link: { - type: 'doc', - id: 'zkapps/o1js-reference/variables/Account', - }, items: [ { type: 'doc', @@ -1322,6 +1261,11 @@ module.exports = { id: 'zkapps/o1js-reference/variables/Empty', label: 'Empty', }, + { + type: 'doc', + id: 'zkapps/o1js-reference/variables/FeatureFlags', + label: 'FeatureFlags', + }, { type: 'doc', id: 'zkapps/o1js-reference/variables/Field', @@ -1497,7 +1441,6 @@ module.exports = { items: [ 'node-operators/delegation-program/foundation-delegation-program', 'node-operators/delegation-program/delegation-tiebreak', - // 'node-operators/delegation-program/bp-sidecar', 'node-operators/delegation-program/uptime-tracking-system', ], },