Build and publish new o1js API reference docs

MinaFoundation · May 23, 2024 · 0313705 · 0313705
1 parent 380d799
commit 0313705
Show file tree

Hide file tree

Showing 189 changed files with 1,312 additions and 1,285 deletions.
diff --git a/docs/zkapps/o1js-reference/README.mdx b/docs/zkapps/o1js-reference/README.mdx
@@ -34,11 +34,11 @@ The easiest way to write zk programs is using o1js.
 
 o1js is a TypeScript library for [zk-SNARKs](https://minaprotocol.com/blog/what-are-zk-snarks) and zkApps. You can use o1js to write zk smart contracts based on zero-knowledge proofs for the Mina Protocol.
 
-o1js is automatically included when you create a project using the [Mina zkApp CLI](https://www.npmjs.com/package/zkapp-cli).
+o1js is automatically included when you create a project using the [zkApp CLI](https://www.npmjs.com/package/zkapp-cli).
 
 ## Learn More
 
-- To learn more about developing zkApps, see the [zkApp Developers](https://docs.minaprotocol.com/zkapps/writing-a-zkapp) docs.
+- To learn more about developing zkApps, see the [zkApp Developers](https://docs.minaprotocol.com/zkapps) docs.
 
 - For guided steps building and using zkApps, see the [zkApp Developers Tutorials](https://docs.minaprotocol.com/zkapps/tutorials/hello-world).
 

diff --git a/docs/zkapps/o1js-reference/classes/AccountUpdate.mdx b/docs/zkapps/o1js-reference/classes/AccountUpdate.mdx
diff --git 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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L83)
+[lib/provable/merkle-list.ts:83](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L83)
 
 ## Properties
 
@@ -68,7 +68,7 @@ data: Unconstrained<WithHash<{
 
 #### Source
 
-[lib/provable/merkle-list.ts:81](https://github.com/o1-labs/o1js/blob/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L81)
+[lib/provable/merkle-list.ts:81](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L81)
 
 ***
 
@@ -84,7 +84,7 @@ hash: Field;
 
 #### Source
 
-[lib/provable/merkle-list.ts:80](https://github.com/o1-labs/o1js/blob/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L80)
+[lib/provable/merkle-list.ts:80](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L80)
 
 ***
 
@@ -100,7 +100,7 @@ static _emptyHash: undefined | Field;
 
 #### Source
 
-[lib/provable/merkle-list.ts:297](https://github.com/o1-labs/o1js/blob/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L297)
+[lib/provable/merkle-list.ts:297](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L297)
 
 ***
 
@@ -116,7 +116,7 @@ static _innerProvable: undefined | ProvableHashable<any>;
 
 #### Source
 
-[lib/provable/merkle-list.ts:300](https://github.com/o1-labs/o1js/blob/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L300)
+[lib/provable/merkle-list.ts:300](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L296)
+[lib/provable/merkle-list.ts:296](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L296)
 
 ***
 
@@ -148,7 +148,7 @@ static _provable: undefined | ProvableHashable<MerkleList<any>>;
 
 #### Source
 
-[lib/provable/merkle-list.ts:299](https://github.com/o1-labs/o1js/blob/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L299)
+[lib/provable/merkle-list.ts:299](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L245)
+[lib/provable/merkle-list.ts:245](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L246)
+[lib/provable/merkle-list.ts:246](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L247)
+[lib/provable/merkle-list.ts:247](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L247)
 
 ***
 
@@ -345,7 +345,7 @@ static provable: ProvableHashable<MerkleList<{
 
 #### Source
 
-[lib/provable/merkle-list.ts:248](https://github.com/o1-labs/o1js/blob/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L248)
+[lib/provable/merkle-list.ts:248](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L248)
 
 ## Accessors
 
@@ -361,7 +361,7 @@ get Constructor(): typeof MerkleList
 
 #### Source
 
-[lib/provable/merkle-list.ts:302](https://github.com/o1-labs/o1js/blob/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L302)
+[lib/provable/merkle-list.ts:302](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/provable/merkle-list.ts#L302)
 
 ***
 
@@ -377,7 +377,7 @@ get innerProvable(): ProvableHashable<T>
 
 #### Source
 
-[lib/provable/merkle-list.ts:319](https://github.com/o1-labs/o1js/blob/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L319)
+[lib/provable/merkle-list.ts:319](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L314)
+[lib/provable/merkle-list.ts:314](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L189)
+[lib/provable/merkle-list.ts:189](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L203)
+[lib/provable/merkle-list.ts:203](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L88)
+[lib/provable/merkle-list.ts:88](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L306)
+[lib/provable/merkle-list.ts:306](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L154)
+[lib/provable/merkle-list.ts:154](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L139)
+[lib/provable/merkle-list.ts:139](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L173)
+[lib/provable/merkle-list.ts:173](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L95)
+[lib/provable/merkle-list.ts:95](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L107)
+[lib/provable/merkle-list.ts:107](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L217)
+[lib/provable/merkle-list.ts:217](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L222)
+[lib/provable/merkle-list.ts:222](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/mina/account-update.ts#L1352)
+[lib/mina/account-update.ts:1352](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1352)
 
 ***
 
@@ -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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/provable/merkle-list.ts#L239)
+[lib/provable/merkle-list.ts:239](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/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/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/mina/account-update.ts#L1321)
+[lib/mina/account-update.ts:1321](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1321)
 
 ***
 
@@ -986,4 +986,4 @@ static toFlatArray(
 
 #### Source
 
-[lib/mina/account-update.ts:1325](https://github.com/o1-labs/o1js/blob/3b1b22555bd0099419efc0703dfdb8b2eb7c3e6f/src/lib/mina/account-update.ts#L1325)
+[lib/mina/account-update.ts:1325](https://github.com/o1-labs/o1js/blob/081e48fe103a96db7083cdaea72a409cca3182c3/src/lib/mina/account-update.ts#L1325)