Build SDK docs

Author: iamalwaysuncomfortable

docs/api_reference/sdk-src_account.md

@@ -504,21 +504,23 @@ const viewKey = account.viewKey();
 
 ---
 
-### `computeKey() ► Field`
+### `computeKey() ► ComputeKey`
 
 ![modifier: public](images/badges/modifier-public.svg)
 
-Returns the Transition View Key associated with the transition public key.
+Returns the ComputeKey associated with the account.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | [Field](sdk-src_wasm.md) | *The transition view key*
+__*return*__ | `ComputeKey` | *The compute key of the account*
 
 #### Examples
 
 ```javascript
 import { Account } from "@provablehq/sdk/testnet.js";
-const account =
+
+const account = new Account();
+const computeKey = account.computeKey();
 ```
 
 ---

docs/api_reference/sdk-src_program-manager.md

@@ -311,6 +311,44 @@ const authorization = await programManager.buildAuthorization({
 
 ---
 
+### `buildAuthorizationUnchecked(options) ► Promise.<Authorization>`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Builds a SnarkVM &#x60;Authorization&#x60; for a specific function without building a circuit first. This should be used when fast authorization generation is needed and the invoker is confident inputs are coorect.
+
+Parameters | Type | Description
+--- | --- | ---
+__options__ | `AuthorizationOptions` | *The options for building the &#x60;Authorization&#x60;*
+__*return*__ | `Promise.<Authorization>` | *- A promise that resolves to an &#x60;Authorization&#x60; or throws an Error.*
+
+#### Examples
+
+```javascript
+/// Import the mainnet version of the sdk.
+import { AleoKeyProvider, ProgramManager, NetworkRecordProvider } from "@provablehq/sdk/mainnet.js";
+
+// Create a new NetworkClient, KeyProvider, and RecordProvider.
+const keyProvider = new AleoKeyProvider();
+const recordProvider = new NetworkRecordProvider(account, networkClient);
+keyProvider.useCache = true;
+
+// Initialize a ProgramManager with the key and record providers.
+const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
+
+// Build the unchecked `Authorization`.
+const authorization = await programManager.buildAuthorizationUnchecked({
+  programName: "credits.aleo",
+  functionName: "transfer_public",
+  inputs: [
+    "aleo1vwls2ete8dk8uu2kmkmzumd7q38fvshrht8hlc0a5362uq8ftgyqnm3w08",
+    "10000000u64",
+  ],
+});
+```
+
+---
+
 ### `buildFeeAuthorization(options) ► Promise.<Authorization>`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -1129,7 +1167,7 @@ setTimeout(async () => {
 
 ---
 
-### `verifyExecution(executionResponse, imports, importedVerifyingKeys) ► boolean`
+### `verifyExecution(executionResponse, blockHeight, imports, importedVerifyingKeys) ► boolean`
 
 ![modifier: public](images/badges/modifier-public.svg)
 
@@ -1138,6 +1176,7 @@ Verify a proof from an offline execution. This is useful when it is desired to d
 Parameters | Type | Description
 --- | --- | ---
 __executionResponse__ | `executionResponse` | *The response from an offline function execution (via the &#x60;programManager.run&#x60; method)*
+__blockHeight__ | `blockHeight` | *The ledger height when the execution was generated.*
 __imports__ | `ImportedPrograms` | *The imported programs used in the execution. Specified as { &quot;programName&quot;: &quot;programSourceCode&quot;, ... }*
 __importedVerifyingKeys__ | `ImportedVerifyingKeys` | *The verifying keys in the execution. Specified as { &quot;programName&quot;: [[&quot;functionName&quot;, &quot;verifyingKey&quot;], ...], ... }*
 __*return*__ | `boolean` | *True if the proof is valid, false otherwise*
@@ -1165,7 +1204,7 @@ const imports = { "add_it_up.aleo": program_import };
 const importedVerifyingKeys = { "add_it_up.aleo": [["add_it", "verifyingKey1..."]] };
 
 /// Verify the execution.
-let blockHeight = 9_000_000;
+const blockHeight = 9000000;
 const isValid = programManager.verifyExecution(executionResponse, blockHeight, imports, importedVerifyingKeys);
 assert(isValid);
 ```
@@ -1498,6 +1537,44 @@ const authorization = await programManager.buildAuthorization({
 
 ---
 
+### `buildAuthorizationUnchecked(options) ► Promise.<Authorization>`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Builds a SnarkVM &#x60;Authorization&#x60; for a specific function without building a circuit first. This should be used when fast authorization generation is needed and the invoker is confident inputs are coorect.
+
+Parameters | Type | Description
+--- | --- | ---
+__options__ | `AuthorizationOptions` | *The options for building the &#x60;Authorization&#x60;*
+__*return*__ | `Promise.<Authorization>` | *- A promise that resolves to an &#x60;Authorization&#x60; or throws an Error.*
+
+#### Examples
+
+```javascript
+/// Import the mainnet version of the sdk.
+import { AleoKeyProvider, ProgramManager, NetworkRecordProvider } from "@provablehq/sdk/mainnet.js";
+
+// Create a new NetworkClient, KeyProvider, and RecordProvider.
+const keyProvider = new AleoKeyProvider();
+const recordProvider = new NetworkRecordProvider(account, networkClient);
+keyProvider.useCache = true;
+
+// Initialize a ProgramManager with the key and record providers.
+const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
+
+// Build the unchecked `Authorization`.
+const authorization = await programManager.buildAuthorizationUnchecked({
+  programName: "credits.aleo",
+  functionName: "transfer_public",
+  inputs: [
+    "aleo1vwls2ete8dk8uu2kmkmzumd7q38fvshrht8hlc0a5362uq8ftgyqnm3w08",
+    "10000000u64",
+  ],
+});
+```
+
+---
+
 ### `buildFeeAuthorization(options) ► Promise.<Authorization>`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -2316,7 +2393,7 @@ setTimeout(async () => {
 
 ---
 
-### `verifyExecution(executionResponse, imports, importedVerifyingKeys) ► boolean`
+### `verifyExecution(executionResponse, blockHeight, imports, importedVerifyingKeys) ► boolean`
 
 ![modifier: public](images/badges/modifier-public.svg)
 
@@ -2325,6 +2402,7 @@ Verify a proof from an offline execution. This is useful when it is desired to d
 Parameters | Type | Description
 --- | --- | ---
 __executionResponse__ | `executionResponse` | *The response from an offline function execution (via the &#x60;programManager.run&#x60; method)*
+__blockHeight__ | `blockHeight` | *The ledger height when the execution was generated.*
 __imports__ | `ImportedPrograms` | *The imported programs used in the execution. Specified as { &quot;programName&quot;: &quot;programSourceCode&quot;, ... }*
 __importedVerifyingKeys__ | `ImportedVerifyingKeys` | *The verifying keys in the execution. Specified as { &quot;programName&quot;: [[&quot;functionName&quot;, &quot;verifyingKey&quot;], ...], ... }*
 __*return*__ | `boolean` | *True if the proof is valid, false otherwise*
@@ -2352,7 +2430,8 @@ const imports = { "add_it_up.aleo": program_import };
 const importedVerifyingKeys = { "add_it_up.aleo": [["add_it", "verifyingKey1..."]] };
 
 /// Verify the execution.
-const isValid = programManager.verifyExecution(executionResponse, imports, importedVerifyingKeys);
+const blockHeight = 9000000;
+const isValid = programManager.verifyExecution(executionResponse, blockHeight, imports, importedVerifyingKeys);
 assert(isValid);
 ```
 

docs/api_reference/sdk-src_wasm.md

@@ -2759,7 +2759,7 @@ __*return*__ | `string` | *Nonce of the record*
 
 ---
 
-### `serialNumberString(private_key, program_id, record_name) ► string`
+### `serialNumberString(private_key, program_id, record_name, record_view_key) ► string`
 
 ![modifier: public](images/badges/modifier-public.svg)
 
@@ -2770,6 +2770,7 @@ Parameters | Type | Description
 __private_key__ | [PrivateKey](sdk-src_wasm.md) | *Private key of the account that owns the record*
 __program_id__ | `string` | *Program ID of the program that the record is associated with*
 __record_name__ | `string` | *Name of the record*
+__record_view_key__ | `string` | *The string representation of the record view key.*
 __*return*__ | `string` | *Serial number of the record*
 
 ---
@@ -2788,6 +2789,20 @@ __*return*__ | [Field](sdk-src_wasm.md) | **
 
 ---
 
+### `recordViewKey(view_key) ► Group`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Generate the record view key. The record view key can only decrypt record if the
+supplied view key belongs to the record owner.
+
+Parameters | Type | Description
+--- | --- | ---
+__view_key__ | `ViewKey` | *View key used to generate the record view key*
+__*return*__ | [Group](sdk-src_wasm.md) | *record view key*
+
+---
+
 # Class `Scalar`
 
 Scalar field element.