Skip to content

Commit

Permalink
Build and publish new o1js API reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@MartinMinkov
github-actions authored and MartinMinkov committed Nov 9, 2023
1 parent b482165 commit dd020ed
Show file tree
Hide file tree
Showing 41 changed files with 903 additions and 897 deletions.
122 changes: 61 additions & 61 deletions docs/zkapps/o1js-reference/classes/AccountUpdate.md
View file

Large diffs are not rendered by default.

74 changes: 37 additions & 37 deletions docs/zkapps/o1js-reference/classes/Bool.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Use [[assertEquals]] to enforce the value of a Bool.

#### Defined in

[lib/bool.ts:36](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L36)
[lib/bool.ts:36](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L36)

## Properties

Expand All @@ -84,7 +84,7 @@ Use [[assertEquals]] to enforce the value of a Bool.

#### Defined in

[lib/bool.ts:34](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L34)
[lib/bool.ts:34](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L34)

___

Expand All @@ -100,7 +100,7 @@ ___

#### Defined in

[lib/bool.ts:325](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L325)
[lib/bool.ts:325](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L325)

## Methods

Expand All @@ -123,7 +123,7 @@ this [Bool](Bool.md) and `y` are also true.

#### Defined in

[lib/bool.ts:74](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L74)
[lib/bool.ts:74](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L74)

___

Expand All @@ -146,7 +146,7 @@ Proves that this [Bool](Bool.md) is equal to `y`.

#### Defined in

[lib/bool.ts:97](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L97)
[lib/bool.ts:97](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L97)

___

Expand All @@ -168,7 +168,7 @@ Proves that this [Bool](Bool.md) is `false`.

#### Defined in

[lib/bool.ts:128](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L128)
[lib/bool.ts:128](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L128)

___

Expand All @@ -190,7 +190,7 @@ Proves that this [Bool](Bool.md) is `true`.

#### Defined in

[lib/bool.ts:114](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L114)
[lib/bool.ts:114](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L114)

___

Expand All @@ -212,7 +212,7 @@ Returns true if this [Bool](Bool.md) is equal to `y`.

#### Defined in

[lib/bool.ts:143](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L143)
[lib/bool.ts:143](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L143)

___

Expand All @@ -226,7 +226,7 @@ this is Object

#### Defined in

[lib/bool.ts:48](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L48)
[lib/bool.ts:48](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L48)

___

Expand All @@ -242,7 +242,7 @@ a new [Bool](Bool.md) that is the negation of this [Bool](Bool.md).

#### Defined in

[lib/bool.ts:62](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L62)
[lib/bool.ts:62](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L62)

___

Expand All @@ -265,7 +265,7 @@ this [Bool](Bool.md) or `y` is true.

#### Defined in

[lib/bool.ts:86](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L86)
[lib/bool.ts:86](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L86)

___

Expand All @@ -281,7 +281,7 @@ Returns the size of this type.

#### Defined in

[lib/bool.ts:153](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L153)
[lib/bool.ts:153](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L153)

___

Expand All @@ -298,7 +298,7 @@ This can only be called on non-witness values.

#### Defined in

[lib/bool.ts:184](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L184)
[lib/bool.ts:184](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L184)

___

Expand All @@ -314,7 +314,7 @@ Converts a [Bool](Bool.md) to a [Field](Field.md). `false` becomes 0 and `true`

#### Defined in

[lib/bool.ts:55](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L55)
[lib/bool.ts:55](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L55)

___

Expand All @@ -330,7 +330,7 @@ Serializes this [Bool](Bool.md) into [Field](Field.md) elements.

#### Defined in

[lib/bool.ts:160](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L160)
[lib/bool.ts:160](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L160)

___

Expand All @@ -347,7 +347,7 @@ This operation does _not_ affect the circuit and can't be used to prove anything

#### Defined in

[lib/bool.ts:176](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L176)
[lib/bool.ts:176](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L176)

___

Expand All @@ -364,7 +364,7 @@ This operation does _not_ affect the circuit and can't be used to prove anything

#### Defined in

[lib/bool.ts:168](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L168)
[lib/bool.ts:168](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L168)

___

Expand All @@ -384,7 +384,7 @@ x is Bool

#### Defined in

[lib/bool.ts:344](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L344)
[lib/bool.ts:344](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L344)

___

Expand All @@ -404,7 +404,7 @@ ___

#### Defined in

[lib/bool.ts:348](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L348)
[lib/bool.ts:348](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L348)

___

Expand All @@ -427,7 +427,7 @@ Boolean AND operation.

#### Defined in

[lib/bool.ts:213](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L213)
[lib/bool.ts:213](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L213)

___

Expand All @@ -450,7 +450,7 @@ Asserts if both [Bool](Bool.md) are equal.

#### Defined in

[lib/bool.ts:233](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L233)
[lib/bool.ts:233](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L233)

___

Expand All @@ -470,7 +470,7 @@ ___

#### Defined in

[lib/bool.ts:321](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L321)
[lib/bool.ts:321](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L321)

___

Expand All @@ -493,7 +493,7 @@ Checks two [Bool](Bool.md) for equality.

#### Defined in

[lib/bool.ts:244](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L244)
[lib/bool.ts:244](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L244)

___

Expand All @@ -513,7 +513,7 @@ ___

#### Defined in

[lib/bool.ts:306](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L306)
[lib/bool.ts:306](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L306)

___

Expand All @@ -535,7 +535,7 @@ Creates a data structure from an array of serialized [Field](Field.md) elements.

#### Defined in

[lib/bool.ts:268](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L268)
[lib/bool.ts:268](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L268)

___

Expand All @@ -558,7 +558,7 @@ This operation does _not_ affect the circuit and can't be used to prove anything

#### Defined in

[lib/bool.ts:287](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L287)
[lib/bool.ts:287](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L287)

___

Expand All @@ -580,7 +580,7 @@ Boolean negation.

#### Defined in

[lib/bool.ts:203](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L203)
[lib/bool.ts:203](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L203)

___

Expand All @@ -603,7 +603,7 @@ Boolean OR operation.

#### Defined in

[lib/bool.ts:223](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L223)
[lib/bool.ts:223](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L223)

___

Expand All @@ -630,7 +630,7 @@ ___

#### Defined in

[lib/bool.ts:310](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L310)
[lib/bool.ts:310](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L310)

___

Expand All @@ -644,7 +644,7 @@ ___

#### Defined in

[lib/bool.ts:317](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L317)
[lib/bool.ts:317](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L317)

___

Expand All @@ -660,7 +660,7 @@ Returns the size of this type.

#### Defined in

[lib/bool.ts:294](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L294)
[lib/bool.ts:294](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L294)

___

Expand All @@ -682,7 +682,7 @@ Static method to serialize a [Bool](Bool.md) into its auxiliary data.

#### Defined in

[lib/bool.ts:261](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L261)
[lib/bool.ts:261](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L261)

___

Expand All @@ -702,7 +702,7 @@ ___

#### Defined in

[lib/bool.ts:302](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L302)
[lib/bool.ts:302](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L302)

___

Expand All @@ -722,7 +722,7 @@ ___

#### Defined in

[lib/bool.ts:196](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L196)
[lib/bool.ts:196](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L196)

___

Expand All @@ -744,7 +744,7 @@ Static method to serialize a [Bool](Bool.md) into an array of [Field](Field.md)

#### Defined in

[lib/bool.ts:254](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L254)
[lib/bool.ts:254](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L254)

___

Expand All @@ -768,7 +768,7 @@ ___

#### Defined in

[lib/bool.ts:298](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L298)
[lib/bool.ts:298](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L298)

___

Expand All @@ -791,4 +791,4 @@ This operation does _not_ affect the circuit and can't be used to prove anything

#### Defined in

[lib/bool.ts:279](https://github.com/o1-labs/o1js/blob/56975fc/src/lib/bool.ts#L279)
[lib/bool.ts:279](https://github.com/o1-labs/o1js/blob/5ca4368/src/lib/bool.ts#L279)
Loading

2 comments on commit dd020ed

@vercel
Copy link

@vercel vercel bot commented on dd020ed Nov 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs2 – ./

docs2-git-main-minadocs.vercel.app
docs.minaprotocol.com
docs2-minadocs.vercel.app

@vercel
Copy link

@vercel vercel bot commented on dd020ed Nov 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

07-oracles – ./examples/zkapps/07-oracles/oracle

07-oracles.vercel.app
07-oracles-minadocs.vercel.app
07-oracles-git-main-minadocs.vercel.app

Please sign in to comment.