Skip to content

Commit 25afb40

Browse files
committed
feat(api-docs): update sidebars and api docs with new format
1 parent 6015684 commit 25afb40

File tree

162 files changed

+1028
-1028
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+1028
-1028
lines changed

docs/zkapps/o1js-reference/classes/AccountUpdate.mdx

Lines changed: 52 additions & 52 deletions
Large diffs are not rendered by default.

docs/zkapps/o1js-reference/classes/AccountUpdateForest.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ new AccountUpdateForest(__namedParameters): AccountUpdateForest
3636

3737
#### Source
3838

39-
[lib/provable/merkle-list.ts:83](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L83)
39+
[lib/provable/merkle-list.ts:83](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L83)
4040

4141
## Properties
4242

@@ -52,7 +52,7 @@ data: Unconstrained<WithHash<object>[]>;
5252

5353
#### Source
5454

55-
[lib/provable/merkle-list.ts:81](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L81)
55+
[lib/provable/merkle-list.ts:81](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L81)
5656

5757
***
5858

@@ -68,7 +68,7 @@ hash: Field;
6868

6969
#### Source
7070

71-
[lib/provable/merkle-list.ts:80](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L80)
71+
[lib/provable/merkle-list.ts:80](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L80)
7272

7373
***
7474

@@ -84,7 +84,7 @@ static _emptyHash: undefined | Field;
8484

8585
#### Source
8686

87-
[lib/provable/merkle-list.ts:258](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L258)
87+
[lib/provable/merkle-list.ts:258](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L258)
8888

8989
***
9090

@@ -100,7 +100,7 @@ static _innerProvable: undefined | ProvableHashable<any>;
100100

101101
#### Source
102102

103-
[lib/provable/merkle-list.ts:261](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L261)
103+
[lib/provable/merkle-list.ts:261](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L261)
104104

105105
***
106106

@@ -116,7 +116,7 @@ static _nextHash: undefined | (hash, t) => Field;
116116

117117
#### Source
118118

119-
[lib/provable/merkle-list.ts:257](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L257)
119+
[lib/provable/merkle-list.ts:257](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L257)
120120

121121
***
122122

@@ -132,7 +132,7 @@ static _provable: undefined | ProvableHashable<MerkleList<any>>;
132132

133133
#### Source
134134

135-
[lib/provable/merkle-list.ts:260](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L260)
135+
[lib/provable/merkle-list.ts:260](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L260)
136136

137137
***
138138

@@ -174,7 +174,7 @@ static empty: () => MerkleList<object>;
174174
175175
#### Source
176176
177-
[lib/provable/merkle-list.ts:216](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L216)
177+
[lib/provable/merkle-list.ts:216](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L216)
178178
179179
***
180180
@@ -220,7 +220,7 @@ static from: (array) => MerkleList<object>;
220220
221221
#### Source
222222
223-
[lib/provable/merkle-list.ts:217](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L217)
223+
[lib/provable/merkle-list.ts:217](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L217)
224224
225225
***
226226
@@ -239,7 +239,7 @@ static provable: ProvableHashable<MerkleList<object>>;
239239

240240
#### Source
241241

242-
[lib/provable/merkle-list.ts:218](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L218)
242+
[lib/provable/merkle-list.ts:218](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L218)
243243

244244
## Accessors
245245

@@ -255,7 +255,7 @@ get Constructor(): typeof MerkleList
255255

256256
#### Source
257257

258-
[lib/provable/merkle-list.ts:263](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L263)
258+
[lib/provable/merkle-list.ts:263](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L263)
259259

260260
***
261261

@@ -271,7 +271,7 @@ get innerProvable(): ProvableHashable<T>
271271

272272
#### Source
273273

274-
[lib/provable/merkle-list.ts:280](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L280)
274+
[lib/provable/merkle-list.ts:280](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L280)
275275

276276
***
277277

@@ -287,7 +287,7 @@ get static emptyHash(): Field
287287

288288
#### Source
289289

290-
[lib/provable/merkle-list.ts:275](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L275)
290+
[lib/provable/merkle-list.ts:275](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L275)
291291

292292
## Methods
293293

@@ -326,7 +326,7 @@ clone(): MerkleList<object>
326326
327327
#### Source
328328
329-
[lib/provable/merkle-list.ts:188](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L188)
329+
[lib/provable/merkle-list.ts:188](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L188)
330330
331331
***
332332
@@ -346,7 +346,7 @@ isEmpty(): Bool
346346

347347
#### Source
348348

349-
[lib/provable/merkle-list.ts:88](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L88)
349+
[lib/provable/merkle-list.ts:88](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L88)
350350

351351
***
352352

@@ -378,7 +378,7 @@ nextHash(hash, value): Field
378378

379379
#### Source
380380

381-
[lib/provable/merkle-list.ts:267](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L267)
381+
[lib/provable/merkle-list.ts:267](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L267)
382382

383383
***
384384

@@ -420,7 +420,7 @@ id: number = RandomId;
420420

421421
#### Source
422422

423-
[lib/provable/merkle-list.ts:153](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L153)
423+
[lib/provable/merkle-list.ts:153](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L153)
424424

425425
***
426426

@@ -462,7 +462,7 @@ id: number = RandomId;
462462

463463
#### Source
464464

465-
[lib/provable/merkle-list.ts:138](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L138)
465+
[lib/provable/merkle-list.ts:138](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L138)
466466

467467
***
468468

@@ -508,7 +508,7 @@ id: number = RandomId;
508508

509509
#### Source
510510

511-
[lib/provable/merkle-list.ts:172](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L172)
511+
[lib/provable/merkle-list.ts:172](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L172)
512512

513513
***
514514

@@ -540,7 +540,7 @@ Push a new element to the list.
540540

541541
#### Source
542542

543-
[lib/provable/merkle-list.ts:95](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L95)
543+
[lib/provable/merkle-list.ts:95](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L95)
544544

545545
***
546546

@@ -574,7 +574,7 @@ Push a new element to the list, if the `condition` is true.
574574

575575
#### Source
576576

577-
[lib/provable/merkle-list.ts:107](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L107)
577+
[lib/provable/merkle-list.ts:107](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L107)
578578

579579
***
580580

@@ -613,7 +613,7 @@ startIterating(): MerkleListIterator<object>
613613
614614
#### Source
615615
616-
[lib/provable/merkle-list.ts:193](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L193)
616+
[lib/provable/merkle-list.ts:193](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L193)
617617
618618
***
619619
@@ -633,7 +633,7 @@ static assertConstant(forest): void
633633

634634
#### Source
635635

636-
[lib/mina/account-update.ts:1306](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1306)
636+
[lib/mina/account-update.ts:1306](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1306)
637637

638638
***
639639

@@ -680,7 +680,7 @@ class MyList extends MerkleList.create(Field, (hash, x) =>
680680

681681
#### Source
682682

683-
[lib/provable/merkle-list.ts:210](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/merkle-list.ts#L210)
683+
[lib/provable/merkle-list.ts:210](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/merkle-list.ts#L210)
684684

685685
***
686686

@@ -700,7 +700,7 @@ static fromFlatArray(updates): AccountUpdateForest
700700

701701
#### Source
702702

703-
[lib/mina/account-update.ts:1275](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1275)
703+
[lib/mina/account-update.ts:1275](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1275)
704704

705705
***
706706

@@ -727,4 +727,4 @@ static toFlatArray(
727727

728728
#### Source
729729

730-
[lib/mina/account-update.ts:1279](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1279)
730+
[lib/mina/account-update.ts:1279](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1279)

docs/zkapps/o1js-reference/classes/AccountUpdateTree.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ new AccountUpdateTree(value): AccountUpdateTree
4646

4747
#### Source
4848

49-
[lib/provable/types/struct.ts:248](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/types/struct.ts#L248)
49+
[lib/provable/types/struct.ts:248](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/types/struct.ts#L248)
5050

5151
## Properties
5252

@@ -66,7 +66,7 @@ accountUpdate: Hashed<AccountUpdate> = HashedAccountUpdate.provable;
6666

6767
#### Source
6868

69-
[lib/mina/account-update.ts:1334](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1334)
69+
[lib/mina/account-update.ts:1334](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1334)
7070

7171
***
7272

@@ -106,7 +106,7 @@ id: number = RandomId;
106106

107107
#### Source
108108

109-
[lib/mina/account-update.ts:1335](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1335)
109+
[lib/mina/account-update.ts:1335](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1335)
110110

111111
***
112112

@@ -126,7 +126,7 @@ id: number = RandomId;
126126

127127
#### Source
128128

129-
[lib/mina/account-update.ts:1333](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1333)
129+
[lib/mina/account-update.ts:1333](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1333)
130130

131131
***
132132

@@ -146,7 +146,7 @@ static _isStruct: true;
146146

147147
#### Source
148148

149-
[lib/provable/types/struct.ts:248](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/types/struct.ts#L248)
149+
[lib/provable/types/struct.ts:248](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/types/struct.ts#L248)
150150

151151
***
152152

@@ -187,7 +187,7 @@ the element of type `T` to put assertions on.
187187

188188
#### Source
189189

190-
[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/types/provable-intf.ts#L66)
190+
[lib/provable/types/provable-intf.ts:66](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/types/provable-intf.ts#L66)
191191

192192
***
193193

@@ -227,7 +227,7 @@ If not provided, a default value for auxiliary data is returned.
227227

228228
#### Source
229229

230-
[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/types/provable-intf.ts#L37)
230+
[lib/provable/types/provable-intf.ts:37](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/types/provable-intf.ts#L37)
231231

232232
***
233233

@@ -266,7 +266,7 @@ the element of type `T` to generate the [Field](../type-aliases/Field.mdx) array
266266

267267
#### Source
268268

269-
[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/types/provable-intf.ts#L26)
269+
[lib/provable/types/provable-intf.ts:26](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/types/provable-intf.ts#L26)
270270

271271
***
272272

@@ -312,7 +312,7 @@ optional packed: [Field, number][];
312312

313313
#### Source
314314

315-
[lib/provable/types/struct.ts:251](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/types/struct.ts#L251)
315+
[lib/provable/types/struct.ts:251](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/types/struct.ts#L251)
316316

317317
## Methods
318318

@@ -338,7 +338,7 @@ See [AccountUpdate.approve](AccountUpdate.mdx#approve).
338338
339339
#### Source
340340
341-
[lib/mina/account-update.ts:1354](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1354)
341+
[lib/mina/account-update.ts:1354](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1354)
342342
343343
***
344344
@@ -362,7 +362,7 @@ static empty(): AccountUpdateTree
362362
363363
#### Source
364364
365-
[lib/mina/account-update.ts:1370](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1370)
365+
[lib/mina/account-update.ts:1370](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1370)
366366
367367
***
368368
@@ -386,7 +386,7 @@ Create a tree of account updates which only consists of a root.
386386
387387
#### Source
388388
389-
[lib/mina/account-update.ts:1340](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1340)
389+
[lib/mina/account-update.ts:1340](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1340)
390390
391391
***
392392
@@ -416,7 +416,7 @@ static fromFields(fields, aux): AccountUpdateTree
416416
417417
#### Source
418418
419-
[lib/mina/account-update.ts:1367](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/mina/account-update.ts#L1367)
419+
[lib/mina/account-update.ts:1367](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/mina/account-update.ts#L1367)
420420
421421
***
422422
@@ -444,4 +444,4 @@ A `number` representing the size of the `T` type in terms of [Field](../type-ali
444444
445445
#### Source
446446
447-
[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/ccbd5fd4525adaf6c1f07bef7847d7bac67c71b5/src/lib/provable/types/provable-intf.ts#L56)
447+
[lib/provable/types/provable-intf.ts:56](https://github.com/o1-labs/o1js/blob/000b9835d52eede806be269b958c57000ff32f72/src/lib/provable/types/provable-intf.ts#L56)

0 commit comments

Comments
 (0)