Skip to content

Commit abaf527

Browse files
committed
regenerated docs
1 parent 57727db commit abaf527

File tree

2 files changed

+36
-32
lines changed

2 files changed

+36
-32
lines changed

docs/api_reference/sdk-src_account.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -504,21 +504,23 @@ const viewKey = account.viewKey();
504504

505505
---
506506

507-
### `computeKey() ► Field`
507+
### `computeKey() ► ComputeKey`
508508

509509
![modifier: public](images/badges/modifier-public.svg)
510510

511-
Returns the Transition View Key associated with the transition public key.
511+
Returns the ComputeKey associated with the account.
512512

513513
Parameters | Type | Description
514514
--- | --- | ---
515-
__*return*__ | [Field](sdk-src_wasm.md) | *The transition view key*
515+
__*return*__ | `ComputeKey` | *The compute key of the account*
516516

517517
#### Examples
518518

519519
```javascript
520520
import { Account } from "@provablehq/sdk/testnet.js";
521-
const account =
521+
522+
const account = new Account();
523+
const computeKey = account.computeKey();
522524
```
523525

524526
---

docs/api_reference/sdk-src_wasm.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -424,12 +424,12 @@ Decrypt a ciphertext using the view key of the transition signer, transition pub
424424

425425
Parameters | Type | Description
426426
--- | --- | ---
427-
__view_key__ | `ViewKey` | **
428-
__transition_public_key__ | [Group](sdk-src_wasm.md) | **
429-
__program__ | `string` | **
430-
__function_name__ | `string` | **
431-
__index__ | `number` | **
432-
__*return*__ | [Plaintext](sdk-src_wasm.md) | **
427+
__view_key__ | `ViewKey` | *The view key of the transition signer.*
428+
__transition_public_key__ | [Group](sdk-src_wasm.md) | *The transition public key used to encrypt the ciphertext.*
429+
__program__ | `string` | *The program ID of the function that encrypted the ciphertext.*
430+
__function_name__ | `string` | *The function name that encrypted the ciphertext.*
431+
__index__ | `u16` | *The index of the input parameter that was encrypted.*
432+
__*return*__ | [Plaintext](sdk-src_wasm.md) | *The decrypted plaintext.*
433433

434434
---
435435

@@ -441,11 +441,11 @@ Decrypt a ciphertext using the transition view key and a (program, function, ind
441441

442442
Parameters | Type | Description
443443
--- | --- | ---
444-
__transition_view_key__ | [Field](sdk-src_wasm.md) | **
445-
__program__ | `string` | **
446-
__function_name__ | `string` | **
447-
__index__ | `number` | **
448-
__*return*__ | [Plaintext](sdk-src_wasm.md) | **
444+
__transition_view_key__ | [Field](sdk-src_wasm.md) | *The transition view key that was used to encrypt the ciphertext.*
445+
__program__ | `string` | *The program ID of the function that encrypted the ciphertext.*
446+
__function_name__ | `string` | *The function name that encrypted the ciphertext.*
447+
__index__ | `u16` | *The index of the input parameter that was encrypted.*
448+
__*return*__ | [Plaintext](sdk-src_wasm.md) | *The decrypted plaintext.*
449449

450450
---
451451

@@ -1322,7 +1322,7 @@ Get a json string representation of the offline query object
13221322

13231323
Parameters | Type | Description
13241324
--- | --- | ---
1325-
__*return*__ | `string` | **
1325+
__*return*__ | `string` | *JSON string representation of the offline query object*
13261326

13271327
---
13281328

@@ -1334,7 +1334,7 @@ Create an offline query object from a json string representation
13341334

13351335
Parameters | Type | Description
13361336
--- | --- | ---
1337-
__s__ | `string` | **
1337+
__s__ | `string` | *JSON string representation of the offline query object*
13381338
__*return*__ | [OfflineQuery](sdk-src_wasm.md) | **
13391339

13401340
---
@@ -1387,9 +1387,9 @@ Encrypt a plaintext with an address and randomizer.
13871387
13881388
Parameters | Type | Description
13891389
--- | --- | ---
1390-
__address__ | [Address](sdk-src_wasm.md) | **
1391-
__randomizer__ | [Scalar](sdk-src_wasm.md) | **
1392-
__*return*__ | [Ciphertext](sdk-src_wasm.md) | **
1390+
__address__ | [Address](sdk-src_wasm.md) | *The address to encrypt the plaintext for.*
1391+
__randomizer__ | [Scalar](sdk-src_wasm.md) | *The randomizer to use for encryption.*
1392+
__*return*__ | [Ciphertext](sdk-src_wasm.md) | *The encrypted ciphertext.*
13931393
13941394
---
13951395
@@ -1401,8 +1401,8 @@ Encrypt a plaintext with a transition view key.
14011401
14021402
Parameters | Type | Description
14031403
--- | --- | ---
1404-
__transition_view_key__ | [Field](sdk-src_wasm.md) | **
1405-
__*return*__ | [Ciphertext](sdk-src_wasm.md) | **
1404+
__transition_view_key__ | [Field](sdk-src_wasm.md) | *The transition view key to use for encryption.*
1405+
__*return*__ | [Ciphertext](sdk-src_wasm.md) | *The encrypted ciphertext.*
14061406
14071407
---
14081408
@@ -1440,7 +1440,7 @@ Get the left endian byte array representation of the plaintext.
14401440
14411441
Parameters | Type | Description
14421442
--- | --- | ---
1443-
__*return*__ | `Uint8Array` | **
1443+
__*return*__ | `Uint8Array` | *The left endian byte array representation of the plaintext.*
14441444
14451445
---
14461446
@@ -1457,15 +1457,15 @@ __*return*__ | [Plaintext](sdk-src_wasm.md) | *The plaintext object.*
14571457
14581458
---
14591459
1460-
### `toBitsLe() ► Array.<any>`
1460+
### `toBitsLe() ► Array`
14611461
14621462
![modifier: public](images/badges/modifier-public.svg)
14631463
14641464
Get the left endian boolean array representation of the bits of the plaintext.
14651465
14661466
Parameters | Type | Description
14671467
--- | --- | ---
1468-
__*return*__ | `Array.<any>` | **
1468+
__*return*__ | `Array` | *The left endian boolean array representation of the bits of the plaintext.*
14691469
14701470
---
14711471
@@ -1482,15 +1482,15 @@ __*return*__ | [Plaintext](sdk-src_wasm.md) | *The plaintext object.*
14821482
14831483
---
14841484
1485-
### `toFields() ► Array.<any>`
1485+
### `toFields() ► Array`
14861486
14871487
![modifier: public](images/badges/modifier-public.svg)
14881488
14891489
Get the field array representation of the plaintext.
14901490
14911491
Parameters | Type | Description
14921492
--- | --- | ---
1493-
__*return*__ | `Array.<any>` | **
1493+
__*return*__ | `Array` | *The field array representation of the plaintext.*
14941494
14951495
---
14961496
@@ -2529,7 +2529,7 @@ Get the left endian byte array representation of the record ciphertext.
25292529
25302530
Parameters | Type | Description
25312531
--- | --- | ---
2532-
__*return*__ | `Uint8Array` | **
2532+
__*return*__ | `Uint8Array` | *Left endian byte array representation of the record ciphertext.*
25332533
25342534
---
25352535
@@ -2539,21 +2539,23 @@ __*return*__ | `Uint8Array` | **
25392539
25402540
Get the left endian boolean array representation of the record ciphertext bits.
25412541
2542+
returns {Array} Left endian boolean array representation of the bits of the record ciphertext.
2543+
25422544
Parameters | Type | Description
25432545
--- | --- | ---
25442546
__*return*__ | `Array.<any>` | **
25452547
25462548
---
25472549
2548-
### `toFields() ► Array.<any>`
2550+
### `toFields() ► Array`
25492551
25502552
![modifier: public](images/badges/modifier-public.svg)
25512553
25522554
Get the field array representation of the record ciphertext.
25532555
25542556
Parameters | Type | Description
25552557
--- | --- | ---
2556-
__*return*__ | `Array.<any>` | **
2558+
__*return*__ | `Array` | *Field array representation of the record ciphertext.*
25572559
25582560
---
25592561
@@ -2578,7 +2580,7 @@ Get the record nonce.
25782580
25792581
Parameters | Type | Description
25802582
--- | --- | ---
2581-
__*return*__ | [Group](sdk-src_wasm.md) | **
2583+
__*return*__ | [Group](sdk-src_wasm.md) | *The record nonce.*
25822584
25832585
---
25842586
@@ -2609,7 +2611,7 @@ Get the owner of the record.
26092611
26102612
Parameters | Type | Description
26112613
--- | --- | ---
2612-
__*return*__ | [Address](sdk-src_wasm.md) | **
2614+
__*return*__ | [Address](sdk-src_wasm.md) | *Address of the owner of the record.*
26132615
26142616
---
26152617

0 commit comments

Comments
 (0)