Skip to content

Commit 87dffd3

Browse files
committed
regenerated docs
1 parent b6b7398 commit 87dffd3

File tree

1 file changed

+33
-18
lines changed

1 file changed

+33
-18
lines changed

docs/api_reference/sdk-src_wasm.md

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -426,9 +426,9 @@ Parameters | Type | Description
426426
--- | --- | ---
427427
__view_key__ | `ViewKey` | *The view key of the transition signer.*
428428
__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.*
429+
__program__ | `string` | *The program ID associated with the ciphertext.*
430+
__function_name__ | `string` | *The name of the function associated with the encrypted inputs and outputs.*
431+
__index__ | `u16` | *The index of the input or output parameter that was encrypted.*
432432
__*return*__ | [Plaintext](sdk-src_wasm.md) | *The decrypted plaintext.*
433433

434434
---
@@ -442,9 +442,9 @@ Decrypt a ciphertext using the transition view key and a (program, function, ind
442442
Parameters | Type | Description
443443
--- | --- | ---
444444
__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.*
445+
__program__ | `string` | *The program ID associated with the ciphertext.*
446+
__function_name__ | `string` | *The name of the function associated with the encrypted inputs and outputs.*
447+
__index__ | `u16` | *The index of the input or output parameter that was encrypted.*
448448
__*return*__ | [Plaintext](sdk-src_wasm.md) | *The decrypted plaintext.*
449449

450450
---
@@ -1280,8 +1280,9 @@ Creates a new offline query object. The state root is required to be passed in a
12801280

12811281
Parameters | Type | Description
12821282
--- | --- | ---
1283-
__block_height__ | `number` | **
1284-
__state_root__ | `string` | **
1283+
__block_height__ | `u32` | *The block height.*
1284+
__state_root__ | `string` | *The state root of the current network.*
1285+
__*return*__ | [OfflineQuery](sdk-src_wasm.md) | *The newly created offline query object.*
12851286

12861287
---
12871288

@@ -1295,7 +1296,7 @@ Add a new block height to the offline query object.
12951296

12961297
Parameters | Type | Description
12971298
--- | --- | ---
1298-
__block_height__ | `number` | **
1299+
__block_height__ | `u32` | *The block height to add.*
12991300
__*return*__ | `void` | **
13001301

13011302
---
@@ -1308,8 +1309,8 @@ Add a new state path to the offline query object.
13081309

13091310
Parameters | Type | Description
13101311
--- | --- | ---
1311-
__commitment:__ | `string` | *The commitment corresponding to a record inpout*
1312-
__state_path:__ | `string` | *The state path corresponding to the commitment*
1312+
__commitment:__ | `string` | *The commitment corresponding to a record input.*
1313+
__state_path:__ | `string` | *The state path corresponding to the commitment.*
13131314
__*return*__ | `void` | **
13141315

13151316
---
@@ -1318,23 +1319,23 @@ __*return*__ | `void` | **
13181319

13191320
![modifier: public](images/badges/modifier-public.svg)
13201321

1321-
Get a json string representation of the offline query object
1322+
Get a json string representation of the offline query object.
13221323

13231324
Parameters | Type | Description
13241325
--- | --- | ---
1325-
__*return*__ | `string` | *JSON string representation of the offline query object*
1326+
__*return*__ | `string` | *JSON string representation of the offline query object.*
13261327

13271328
---
13281329

1329-
### `fromString(s) ► OfflineQuery`
1330+
### `fromString(JSON) ► OfflineQuery`
13301331

13311332
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
13321333

1333-
Create an offline query object from a json string representation
1334+
Create an offline query object from a json string representation.
13341335

13351336
Parameters | Type | Description
13361337
--- | --- | ---
1337-
__s__ | `string` | *JSON string representation of the offline query object*
1338+
__JSON__ | `string` | *string representation of the offline query object.*
13381339
__*return*__ | [OfflineQuery](sdk-src_wasm.md) | **
13391340

13401341
---
@@ -1401,7 +1402,8 @@ Encrypt a plaintext with a transition view key.
14011402
14021403
Parameters | Type | Description
14031404
--- | --- | ---
1404-
__transition_view_key__ | [Field](sdk-src_wasm.md) | *The transition view key to use for encryption.*
1405+
__transition_view_key__ | [Field](sdk-src_wasm.md) | *The transition view key of the transition
1406+
associated with the plaintext.*
14051407
__*return*__ | [Ciphertext](sdk-src_wasm.md) | *The encrypted ciphertext.*
14061408
14071409
---
@@ -2598,11 +2600,24 @@ Return a record plaintext from a string.
25982600
25992601
Parameters | Type | Description
26002602
--- | --- | ---
2601-
__record__ | `string` | *String representation of a plaintext representation of an Aleo record*
2603+
__record__ | `string` | *String representation of a plaintext representation of an Aleo record.*
26022604
__*return*__ | [RecordPlaintext](sdk-src_wasm.md) | *Record plaintext*
26032605
26042606
---
26052607
2608+
### `getMember(input) ► Plaintext`
2609+
2610+
![modifier: public](images/badges/modifier-public.svg)
2611+
2612+
Get the record entry matching a key.
2613+
2614+
Parameters | Type | Description
2615+
--- | --- | ---
2616+
__input__ | `string` | *The key to retrieve the value in the record data field.*
2617+
__*return*__ | [Plaintext](sdk-src_wasm.md) | *The plaintext value corresponding to the key.*
2618+
2619+
---
2620+
26062621
### `owner() ► Address`
26072622
26082623
![modifier: public](images/badges/modifier-public.svg)

0 commit comments

Comments
 (0)