Skip to content

Commit 545848d

Browse files
Update auto-generated api docs
1 parent 9612427 commit 545848d

File tree

4 files changed

+1265
-1129
lines changed

4 files changed

+1265
-1129
lines changed

docs/api_reference/sdk-src_network-client.md

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ const account = networkClient.getAccount();
6060

6161
---
6262

63-
### `setHost(host, host)`
63+
### `setHost(host)`
6464

6565
![modifier: public](images/badges/modifier-public.svg)
6666

@@ -69,7 +69,6 @@ Set a new host for the networkClient
6969
Parameters | Type | Description
7070
--- | --- | ---
7171
__host__ | `string` | *The address of a node hosting the Aleo API*
72-
__host__ | `undefined` | **
7372

7473
#### Examples
7574

@@ -85,6 +84,30 @@ networkClient.setHost("http://api.explorer.provable.com/v1");
8584

8685
---
8786

87+
### `setVerboseErrors(verboseErrors)`
88+
89+
![modifier: public](images/badges/modifier-public.svg)
90+
91+
Set verbose errors to true or false for the `AleoNetworkClient`. When set to true, if `submitTransaction` fails, the failure responses will report descriptive information as to why the transaction failed.
92+
93+
Parameters | Type | Description
94+
--- | --- | ---
95+
__verboseErrors__ | `boolean` | *Set verbose error mode to true or false for the AleoNetworkClient.*
96+
97+
#### Examples
98+
99+
```javascript
100+
import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
101+
102+
// Create a networkClient
103+
const networkClient = new AleoNetworkClient();
104+
105+
// Set debug mode to true
106+
networkClient.setVerboseTransactionErrors(true);
107+
```
108+
109+
---
110+
88111
### `setHeader(headerName, value)`
89112

90113
![modifier: public](images/badges/modifier-public.svg)
@@ -1017,16 +1040,15 @@ __*return*__ | `Promise.<string>` | *The solution id of the submitted solution o
10171040
10181041
---
10191042
1020-
### `submitProvingRequest(provingRequest, url) ► Promise.<ProvingResponse>`
1043+
### `submitProvingRequest(options) ► Promise.<ProvingResponse>`
10211044
10221045
![modifier: public](images/badges/modifier-public.svg)
10231046
10241047
Submit a &#x60;ProvingRequest&#x60; to a remote proving service for delegated proving. If the broadcast flag of the &#x60;ProvingRequest&#x60; is set to &#x60;true&#x60; the remote service will attempt to broadcast the result &#x60;Transaction&#x60; on behalf of the requestor.
10251048
10261049
Parameters | Type | Description
10271050
--- | --- | ---
1028-
__provingRequest__ | [ProvingRequest](sdk-src_wasm.md) | *The &#x60;ProvingRequest&#x60; (generated by the ProgramManager) to submit.*
1029-
__url__ | `string` | *(Optional) The url of the proving service.*
1051+
__options__ | `DelegatedProvingParams` | *The optional parameters required to submit a proving request.*
10301052
__*return*__ | `Promise.<ProvingResponse>` | *The ProvingResponse containing the transaction result and the result of the broadcast if the &#x60;broadcast&#x60; flag was set to &#x60;true&#x60;.*
10311053
10321054
---
@@ -1108,7 +1130,7 @@ const account = networkClient.getAccount();
11081130
11091131
---
11101132
1111-
### `setHost(host, host)`
1133+
### `setHost(host)`
11121134
11131135
![modifier: public](images/badges/modifier-public.svg)
11141136
@@ -1117,7 +1139,6 @@ Set a new host for the networkClient
11171139
Parameters | Type | Description
11181140
--- | --- | ---
11191141
__host__ | `string` | *The address of a node hosting the Aleo API*
1120-
__host__ | `undefined` | **
11211142
11221143
#### Examples
11231144
@@ -1133,6 +1154,30 @@ networkClient.setHost("http://api.explorer.provable.com/v1");
11331154
11341155
---
11351156
1157+
### `setVerboseErrors(verboseErrors)`
1158+
1159+
![modifier: public](images/badges/modifier-public.svg)
1160+
1161+
Set verbose errors to true or false for the &#x60;AleoNetworkClient&#x60;. When set to true, if &#x60;submitTransaction&#x60; fails, the failure responses will report descriptive information as to why the transaction failed.
1162+
1163+
Parameters | Type | Description
1164+
--- | --- | ---
1165+
__verboseErrors__ | `boolean` | *Set verbose error mode to true or false for the AleoNetworkClient.*
1166+
1167+
#### Examples
1168+
1169+
```javascript
1170+
import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
1171+
1172+
// Create a networkClient
1173+
const networkClient = new AleoNetworkClient();
1174+
1175+
// Set debug mode to true
1176+
networkClient.setVerboseTransactionErrors(true);
1177+
```
1178+
1179+
---
1180+
11361181
### `setHeader(headerName, value)`
11371182
11381183
![modifier: public](images/badges/modifier-public.svg)
@@ -2067,16 +2112,15 @@ __*return*__ | `Promise.<string>` | *The solution id of the submitted solution o
20672112
20682113
---
20692114
2070-
### `submitProvingRequest(provingRequest, url) ► Promise.<ProvingResponse>`
2115+
### `submitProvingRequest(options) ► Promise.<ProvingResponse>`
20712116
20722117
![modifier: public](images/badges/modifier-public.svg)
20732118
20742119
Submit a &#x60;ProvingRequest&#x60; to a remote proving service for delegated proving. If the broadcast flag of the &#x60;ProvingRequest&#x60; is set to &#x60;true&#x60; the remote service will attempt to broadcast the result &#x60;Transaction&#x60; on behalf of the requestor.
20752120
20762121
Parameters | Type | Description
20772122
--- | --- | ---
2078-
__provingRequest__ | [ProvingRequest](sdk-src_wasm.md) | *The &#x60;ProvingRequest&#x60; (generated by the ProgramManager) to submit.*
2079-
__url__ | `string` | *(Optional) The url of the proving service.*
2123+
__options__ | `DelegatedProvingParams` | *The optional parameters required to submit a proving request.*
20802124
__*return*__ | `Promise.<ProvingResponse>` | *The ProvingResponse containing the transaction result and the result of the broadcast if the &#x60;broadcast&#x60; flag was set to &#x60;true&#x60;.*
20812125
20822126
---

0 commit comments

Comments
 (0)