Skip to content

Commit 86e4532

Browse files
committed
rebuilt docs
1 parent 752740b commit 86e4532

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

docs/api_reference/sdk-src_wasm.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -814,6 +814,21 @@ __*return*__ | [Field](sdk-src_wasm.md) | *The transition view key.*
814814

815815
---
816816

817+
### `decryptSender(view_key, record, sender_ciphertext) ► Address`
818+
819+
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
820+
821+
Decrypt the sender ciphertext associated with a record.
822+
823+
Parameters | Type | Description
824+
--- | --- | ---
825+
__view_key__ | `ViewKey` | *View key associated with the record.*
826+
__record__ | [RecordPlaintext](sdk-src_wasm.md) | *Record plaintext associated with a sender.*
827+
__sender_ciphertext__ | [Field](sdk-src_wasm.md) | *Sender ciphertext associated with the record.*
828+
__*return*__ | [Address](sdk-src_wasm.md) | *address of the sender.*
829+
830+
---
831+
817832
### `checkOwnedRecords(view_key, records) ► Vec.<RecordCiphertext>`
818833

819834
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
@@ -842,6 +857,20 @@ __*return*__ | `vec.<RecordPlaintext>` | *The decrypted record plaintexts.*
842857

843858
---
844859

860+
### `decryptSenderWithRvk(record_view_key, sender_ciphertext) ► Address`
861+
862+
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
863+
864+
Decrypt the sender ciphertext associated with the record with the record view key.
865+
866+
Parameters | Type | Description
867+
--- | --- | ---
868+
__record_view_key__ | [Field](sdk-src_wasm.md) | *Record view key associated with the record.*
869+
__sender_ciphertext__ | [Field](sdk-src_wasm.md) | *Sender ciphertext associated with the record.*
870+
__*return*__ | [Address](sdk-src_wasm.md) | *the address of the sender.*
871+
872+
---
873+
845874
### `generateRecordViewKey(view_key, record_ciphertext) ► Field`
846875

847876
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
@@ -1863,6 +1892,19 @@ __*return*__ | [PrivateKey](sdk-src_wasm.md) | **
18631892
18641893
## Methods
18651894
1895+
### `sign_value(message) ► Signature`
1896+
1897+
![modifier: public](images/badges/modifier-public.svg)
1898+
1899+
Sign an instance of a valid Aleo data type or record.
1900+
1901+
Parameters | Type | Description
1902+
--- | --- | ---
1903+
__message__ | `String` | *The string representation of the Aleo datatype or record to sign.*
1904+
__*return*__ | [Signature](sdk-src_wasm.md) | *Signature of the message.*
1905+
1906+
---
1907+
18661908
### `to_address() ► Address`
18671909
18681910
![modifier: public](images/badges/modifier-public.svg)
@@ -3172,6 +3214,20 @@ __*return*__ | [RecordPlaintext](sdk-src_wasm.md) | *The record plaintext.*
31723214
31733215
---
31743216
3217+
### `decryptSender(view_key, sender_ciphertext) ► Address`
3218+
3219+
![modifier: public](images/badges/modifier-public.svg)
3220+
3221+
Decrypt the sender ciphertext associated with the record.
3222+
3223+
Parameters | Type | Description
3224+
--- | --- | ---
3225+
__view_key__ | `ViewKey` | *View key associated with the record.*
3226+
__sender_ciphertext__ | [Field](sdk-src_wasm.md) | *Sender ciphertext associated with the record.*
3227+
__*return*__ | [Address](sdk-src_wasm.md) | *address of the sender.*
3228+
3229+
---
3230+
31753231
### `recordViewKey(view_key) ► Group`
31763232
31773233
![modifier: public](images/badges/modifier-public.svg)
@@ -3537,6 +3593,20 @@ Cryptographic signature of a message signed by an Aleo account
35373593
35383594
## Methods
35393595
3596+
### `sign_value(private_key, message) ► Signature`
3597+
3598+
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
3599+
3600+
Sign an instance of a valid Aleo data type or record.
3601+
3602+
Parameters | Type | Description
3603+
--- | --- | ---
3604+
__private_key__ | [PrivateKey](sdk-src_wasm.md) | *The private key used to sign the message.*
3605+
__message__ | `String` | *The string representation of the Aleo datatype or record to sign.*
3606+
__*return*__ | [Signature](sdk-src_wasm.md) | *Signature of the message.*
3607+
3608+
---
3609+
35403610
### `to_address() ► Address`
35413611
35423612
![modifier: public](images/badges/modifier-public.svg)
@@ -3611,6 +3681,20 @@ __*return*__ | [Plaintext](sdk-src_wasm.md) | **
36113681
36123682
---
36133683
3684+
### `verify_value(address, message) ► boolean`
3685+
3686+
![modifier: public](images/badges/modifier-public.svg)
3687+
3688+
Verify a signature over an Aleo datatype or record by an address.
3689+
3690+
Parameters | Type | Description
3691+
--- | --- | ---
3692+
__address__ | [Address](sdk-src_wasm.md) | *The address used to verify the signature.*
3693+
__message__ | `String` | *The message to verify, which must be the string representation of a valid Aleo datatype or record.*
3694+
__*return*__ | `boolean` | *True if the signature is valid, false otherwise.*
3695+
3696+
---
3697+
36143698
### `fromBytesLe(bytes) ► Signature`
36153699
36163700
![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)

0 commit comments

Comments
 (0)