Skip to content

Commit a7a0ef9

Browse files
Merge pull request #1009 from ProvableHQ/fix/update-docs-and-snarkvm-v1.4.0
[Update + Fix] Update SnarkVM to v1.4.0 and correct `ProgramManager` doc comments
2 parents 512b11e + 946639c commit a7a0ef9

File tree

15 files changed

+1132
-808
lines changed

15 files changed

+1132
-808
lines changed

docs/api_reference/sdk-src_program-manager.md

Lines changed: 606 additions & 497 deletions
Large diffs are not rendered by default.

sdk/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@
7070
"eslint-plugin-import": "^2.31.0",
7171
"glob": "^11.0.1",
7272
"jsdoc": "^4.0.4",
73+
"kis-jsdoc-plugin": "^2.2.1",
7374
"mocha": "^11.1.0",
7475
"prettier": "3.4.2",
7576
"rimraf": "^6.0.1",

sdk/src/account.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export class Account {
6868
*
6969
* @example
7070
* const ciphertext = PrivateKey.newEncrypted("password");
71-
* const account = Account.fromCiphertext(ciphertext, "password");
71+
* const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
7272
*/
7373
public static fromCiphertext(ciphertext: PrivateKeyCiphertext | string, password: string) {
7474
try {
@@ -161,7 +161,7 @@ export class Account {
161161
* @example
162162
* // Create a connection to the Aleo network and an account
163163
* const connection = new AleoNetworkClient("https://api.explorer.provable.com/v1");
164-
* const account = Account.fromCiphertext("ciphertext", "password");
164+
* const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
165165
*
166166
* // Get a record from the network
167167
* const record = connection.getBlock(1234);

sdk/src/network-client.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ interface AleoNetworkClientOptions {
2626
* @param {string} host
2727
* @example
2828
* // Connection to a local node
29-
* const localNetworkClient = new AleoNetworkClient("http://localhost:3030");
29+
* const localNetworkClient = new AleoNetworkClient("http://api.explorer.provable.com/v1", undefined, account);
3030
*
3131
* // Connection to a public beacon node
3232
* const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);

sdk/src/program-manager.ts

Lines changed: 305 additions & 135 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)