@@ -424,12 +424,12 @@ Decrypt a ciphertext using the view key of the transition signer, transition pub
424
424
425
425
Parameters | Type | Description
426
426
--- | --- | ---
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. *
433
433
434
434
---
435
435
@@ -441,11 +441,11 @@ Decrypt a ciphertext using the transition view key and a (program, function, ind
441
441
442
442
Parameters | Type | Description
443
443
--- | --- | ---
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. *
449
449
450
450
---
451
451
@@ -1322,7 +1322,7 @@ Get a json string representation of the offline query object
1322
1322
1323
1323
Parameters | Type | Description
1324
1324
--- | --- | ---
1325
- __ * return* __ | ` string ` | **
1325
+ __ * return* __ | ` string ` | * JSON string representation of the offline query object *
1326
1326
1327
1327
---
1328
1328
@@ -1334,7 +1334,7 @@ Create an offline query object from a json string representation
1334
1334
1335
1335
Parameters | Type | Description
1336
1336
--- | --- | ---
1337
- __ s__ | ` string ` | **
1337
+ __ s__ | ` string ` | * JSON string representation of the offline query object *
1338
1338
__ * return* __ | [ OfflineQuery] ( sdk-src_wasm.md ) | **
1339
1339
1340
1340
---
@@ -1387,9 +1387,9 @@ Encrypt a plaintext with an address and randomizer.
1387
1387
1388
1388
Parameters | Type | Description
1389
1389
--- | --- | ---
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. *
1393
1393
1394
1394
---
1395
1395
@@ -1401,8 +1401,8 @@ Encrypt a plaintext with a transition view key.
1401
1401
1402
1402
Parameters | Type | Description
1403
1403
--- | --- | ---
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. *
1406
1406
1407
1407
---
1408
1408
@@ -1440,7 +1440,7 @@ Get the left endian byte array representation of the plaintext.
1440
1440
1441
1441
Parameters | Type | Description
1442
1442
--- | --- | ---
1443
- __*return*__ | ` Uint8Array ` | **
1443
+ __*return*__ | ` Uint8Array ` | *The left endian byte array representation of the plaintext. *
1444
1444
1445
1445
---
1446
1446
@@ -1457,15 +1457,15 @@ __*return*__ | [Plaintext](sdk-src_wasm.md) | *The plaintext object.*
1457
1457
1458
1458
---
1459
1459
1460
- ### ` toBitsLe () ► Array . < any > `
1460
+ ### ` toBitsLe () ► Array `
1461
1461
1462
1462

1463
1463
1464
1464
Get the left endian boolean array representation of the bits of the plaintext.
1465
1465
1466
1466
Parameters | Type | Description
1467
1467
--- | --- | ---
1468
- __*return*__ | ` Array . < any > ` | **
1468
+ __*return*__ | ` Array ` | *The left endian boolean array representation of the bits of the plaintext. *
1469
1469
1470
1470
---
1471
1471
@@ -1482,15 +1482,15 @@ __*return*__ | [Plaintext](sdk-src_wasm.md) | *The plaintext object.*
1482
1482
1483
1483
---
1484
1484
1485
- ### ` toFields () ► Array . < any > `
1485
+ ### ` toFields () ► Array `
1486
1486
1487
1487

1488
1488
1489
1489
Get the field array representation of the plaintext.
1490
1490
1491
1491
Parameters | Type | Description
1492
1492
--- | --- | ---
1493
- __*return*__ | ` Array . < any > ` | **
1493
+ __*return*__ | ` Array ` | *The field array representation of the plaintext. *
1494
1494
1495
1495
---
1496
1496
@@ -2529,7 +2529,7 @@ Get the left endian byte array representation of the record ciphertext.
2529
2529
2530
2530
Parameters | Type | Description
2531
2531
--- | --- | ---
2532
- __*return*__ | ` Uint8Array ` | **
2532
+ __*return*__ | ` Uint8Array ` | *Left endian byte array representation of the record ciphertext. *
2533
2533
2534
2534
---
2535
2535
@@ -2539,21 +2539,23 @@ __*return*__ | `Uint8Array` | **
2539
2539
2540
2540
Get the left endian boolean array representation of the record ciphertext bits.
2541
2541
2542
+ returns {Array} Left endian boolean array representation of the bits of the record ciphertext.
2543
+
2542
2544
Parameters | Type | Description
2543
2545
--- | --- | ---
2544
2546
__*return*__ | ` Array .< any> ` | **
2545
2547
2546
2548
---
2547
2549
2548
- ### ` toFields () ► Array . < any > `
2550
+ ### ` toFields () ► Array `
2549
2551
2550
2552

2551
2553
2552
2554
Get the field array representation of the record ciphertext.
2553
2555
2554
2556
Parameters | Type | Description
2555
2557
--- | --- | ---
2556
- __*return*__ | ` Array . < any > ` | **
2558
+ __*return*__ | ` Array ` | *Field array representation of the record ciphertext. *
2557
2559
2558
2560
---
2559
2561
@@ -2578,7 +2580,7 @@ Get the record nonce.
2578
2580
2579
2581
Parameters | Type | Description
2580
2582
--- | --- | ---
2581
- __*return*__ | [Group](sdk-src_wasm.md) | **
2583
+ __*return*__ | [Group](sdk-src_wasm.md) | *The record nonce. *
2582
2584
2583
2585
---
2584
2586
@@ -2609,7 +2611,7 @@ Get the owner of the record.
2609
2611
2610
2612
Parameters | Type | Description
2611
2613
--- | --- | ---
2612
- __*return*__ | [Address](sdk-src_wasm.md) | **
2614
+ __*return*__ | [Address](sdk-src_wasm.md) | *Address of the owner of the record. *
2613
2615
2614
2616
---
2615
2617
0 commit comments