@provablehq/sdk 0.9.6 → 0.9.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,8 +1,9 @@
1
1
  import { Account } from "./account.js";
2
2
  import { BlockJSON } from "./models/blockJSON.js";
3
3
  import { TransactionJSON } from "./models/transaction/transactionJSON.js";
4
- import { Address, Plaintext, Program, RecordPlaintext, PrivateKey, Transaction } from "./wasm.js";
4
+ import { Address, Plaintext, Program, ProvingRequest, RecordPlaintext, PrivateKey, Transaction } from "./wasm.js";
5
5
  import { ConfirmedTransactionJSON } from "./models/confirmed_transaction.js";
6
+ import { ProvingResponse } from "./models/provingResponse.js";
6
7
  type ProgramImports = {
7
8
  [key: string]: string | Program;
8
9
  };
@@ -707,6 +708,14 @@ declare class AleoNetworkClient {
707
708
  * @returns {Promise<string>} The solution id of the submitted solution or the resulting error.
708
709
  */
709
710
  submitSolution(solution: string): Promise<string>;
711
+ /**
712
+ * Submit a `ProvingRequest` to a remote proving service for delegated proving. If the broadcast flag of the `ProvingRequest` is set to `true` the remote service will attempt to broadcast the result `Transaction` on behalf of the requestor.
713
+ *
714
+ * @param {ProvingRequest | string} provingRequest - The `ProvingRequest` (generated by the ProgramManager) to submit.
715
+ * @param {string} url - (Optional) The url of the proving service.
716
+ * @returns {Promise<ProvingResponse>} The ProvingResponse containing the transaction result and the result of the broadcast if the `broadcast` flag was set to `true`.
717
+ */
718
+ submitProvingRequest(provingRequest: ProvingRequest | string, url?: string): Promise<ProvingResponse>;
710
719
  /**
711
720
  * Await a submitted transaction to be confirmed or rejected on the Aleo network.
712
721
  *
@@ -202,7 +202,7 @@ declare class ProgramManager {
202
202
  * // Create a new NetworkClient, KeyProvider, and RecordProvider
203
203
  * const keyProvider = new AleoKeyProvider();
204
204
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
205
- * keyProvider.useCache = true;
205
+ * keyProvider.useCache(true);
206
206
  *
207
207
  * // Initialize a program manager with the key provider to automatically fetch keys for deployments
208
208
  * const program = "program hello_hello.aleo;\n\nfunction hello:\n input r0 as u32.public;\n input r1 as u32.private;\n add r0 r1 into r2;\n output r2 as u32.private;\n";
@@ -241,7 +241,7 @@ declare class ProgramManager {
241
241
  * // Create a new NetworkClient, KeyProvider, and RecordProvider.
242
242
  * const keyProvider = new AleoKeyProvider();
243
243
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
244
- * keyProvider.useCache = true;
244
+ * keyProvider.useCache(true);
245
245
  *
246
246
  * // Initialize a program manager with the key provider to automatically fetch keys for deployments
247
247
  * const program = "program hello_hello.aleo;\n\nfunction hello:\n input r0 as u32.public;\n input r1 as u32.private;\n add r0 r1 into r2;\n output r2 as u32.private;\n";
@@ -273,7 +273,7 @@ declare class ProgramManager {
273
273
  * // Create a new NetworkClient, KeyProvider, and RecordProvider.
274
274
  * const keyProvider = new AleoKeyProvider();
275
275
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
276
- * keyProvider.useCache = true;
276
+ * keyProvider.useCache(true);
277
277
  *
278
278
  * // Initialize a program manager with the key provider to automatically fetch keys for executions
279
279
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -311,7 +311,7 @@ declare class ProgramManager {
311
311
  * // Create a new NetworkClient, KeyProvider, and RecordProvider.
312
312
  * const keyProvider = new AleoKeyProvider();
313
313
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
314
- * keyProvider.useCache = true;
314
+ * keyProvider.useCache(true);
315
315
  *
316
316
  * // Initialize a ProgramManager with the key and record providers.
317
317
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -340,7 +340,7 @@ declare class ProgramManager {
340
340
  * // Create a new NetworkClient, KeyProvider, and RecordProvider.
341
341
  * const keyProvider = new AleoKeyProvider();
342
342
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
343
- * keyProvider.useCache = true;
343
+ * keyProvider.useCache(true);
344
344
  *
345
345
  * // Initialize a ProgramManager with the key and record providers.
346
346
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -369,7 +369,7 @@ declare class ProgramManager {
369
369
  * // Create a new NetworkClient, KeyProvider, and RecordProvider.
370
370
  * const keyProvider = new AleoKeyProvider();
371
371
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
372
- * keyProvider.useCache = true;
372
+ * keyProvider.useCache(true);
373
373
  *
374
374
  * // Initialize a ProgramManager with the key and record providers.
375
375
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -402,7 +402,7 @@ declare class ProgramManager {
402
402
  * // Create a new NetworkClient, KeyProvider, and RecordProvider.
403
403
  * const keyProvider = new AleoKeyProvider();
404
404
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
405
- * keyProvider.useCache = true;
405
+ * keyProvider.useCache(true);
406
406
  *
407
407
  * // Initialize a ProgramManager with the key and record providers.
408
408
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -435,7 +435,7 @@ declare class ProgramManager {
435
435
  * // Create a new NetworkClient, KeyProvider, and RecordProvider using official Aleo record, key, and network providers
436
436
  * const keyProvider = new AleoKeyProvider();
437
437
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
438
- * keyProvider.useCache = true;
438
+ * keyProvider.useCache(true);
439
439
  *
440
440
  * // Initialize a program manager with the key provider to automatically fetch keys for executions
441
441
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -510,7 +510,7 @@ declare class ProgramManager {
510
510
  * // Create a new NetworkClient, KeyProvider, and RecordProvider
511
511
  * const keyProvider = new AleoKeyProvider();
512
512
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
513
- * keyProvider.useCache = true;
513
+ * keyProvider.useCache(true);
514
514
  *
515
515
  * // Initialize a program manager with the key provider to automatically fetch keys for executions
516
516
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -541,7 +541,7 @@ declare class ProgramManager {
541
541
  * // Create a new NetworkClient, KeyProvider, and RecordProvider
542
542
  * const keyProvider = new AleoKeyProvider();
543
543
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
544
- * keyProvider.useCache = true;
544
+ * keyProvider.useCache(true);
545
545
  *
546
546
  * // Initialize a program manager with the key provider to automatically fetch keys for executions
547
547
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -588,7 +588,7 @@ declare class ProgramManager {
588
588
  * // Create a new NetworkClient, KeyProvider, and RecordProvider
589
589
  * const keyProvider = new AleoKeyProvider();
590
590
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
591
- * keyProvider.useCache = true;
591
+ * keyProvider.useCache(true);
592
592
  *
593
593
  * // Initialize a program manager with the key provider to automatically fetch keys for executions
594
594
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -619,7 +619,7 @@ declare class ProgramManager {
619
619
  * // Create a new NetworkClient, KeyProvider, and RecordProvider
620
620
  * const keyProvider = new AleoKeyProvider();
621
621
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
622
- * keyProvider.useCache = true;
622
+ * keyProvider.useCache(true);
623
623
  *
624
624
  * // Initialize a program manager with the key provider to automatically fetch keys for executions
625
625
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -650,7 +650,7 @@ declare class ProgramManager {
650
650
  * // Create a new NetworkClient, KeyProvider, and RecordProvider
651
651
  * const keyProvider = new AleoKeyProvider();
652
652
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
653
- * keyProvider.useCache = true;
653
+ * keyProvider.useCache(true);
654
654
  *
655
655
  * // Initialize a program manager with the key provider to automatically fetch keys for executions
656
656
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -686,7 +686,7 @@ declare class ProgramManager {
686
686
  * // Create a new NetworkClient, KeyProvider, and RecordProvider
687
687
  * const keyProvider = new AleoKeyProvider();
688
688
  * const recordProvider = new NetworkRecordProvider(account, networkClient);
689
- * keyProvider.useCache = true;
689
+ * keyProvider.useCache(true);
690
690
  *
691
691
  * // Initialize a program manager with the key provider to automatically fetch keys for executions
692
692
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -714,7 +714,7 @@ declare class ProgramManager {
714
714
  *
715
715
  * // Create a keyProvider to handle key management
716
716
  * const keyProvider = new AleoKeyProvider();
717
- * keyProvider.useCache = true;
717
+ * keyProvider.useCache(true);
718
718
  *
719
719
  * // Create a new ProgramManager with the key that will be used to bond credits
720
720
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -748,7 +748,7 @@ declare class ProgramManager {
748
748
  *
749
749
  * // Create a keyProvider to handle key management
750
750
  * const keyProvider = new AleoKeyProvider();
751
- * keyProvider.useCache = true;
751
+ * keyProvider.useCache(true);
752
752
  *
753
753
  * // Create a new ProgramManager with the key that will be used to bond credits
754
754
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -779,7 +779,7 @@ declare class ProgramManager {
779
779
  *
780
780
  * // Create a keyProvider to handle key management
781
781
  * const keyProvider = new AleoKeyProvider();
782
- * keyProvider.useCache = true;
782
+ * keyProvider.useCache(true);
783
783
  *
784
784
  * // Create a new ProgramManager with the key that will be used to bond credits
785
785
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -814,7 +814,7 @@ declare class ProgramManager {
814
814
  *
815
815
  * // Create a keyProvider to handle key management
816
816
  * const keyProvider = new AleoKeyProvider();
817
- * keyProvider.useCache = true;
817
+ * keyProvider.useCache(true);
818
818
  *
819
819
  * // Create a new ProgramManager with the key that will be used to bond credits
820
820
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -844,7 +844,7 @@ declare class ProgramManager {
844
844
  *
845
845
  * // Create a keyProvider to handle key management.
846
846
  * const keyProvider = new AleoKeyProvider();
847
- * keyProvider.useCache = true;
847
+ * keyProvider.useCache(true);
848
848
  *
849
849
  * // Create a new ProgramManager with the key that will be used to unbond credits.
850
850
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -879,7 +879,7 @@ declare class ProgramManager {
879
879
  *
880
880
  * // Create a keyProvider to handle key management
881
881
  * const keyProvider = new AleoKeyProvider();
882
- * keyProvider.useCache = true;
882
+ * keyProvider.useCache(true);
883
883
  *
884
884
  * // Create a new ProgramManager with the key that will be used to bond credits
885
885
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -908,7 +908,7 @@ declare class ProgramManager {
908
908
  *
909
909
  * // Create a keyProvider to handle key management
910
910
  * const keyProvider = new AleoKeyProvider();
911
- * keyProvider.useCache = true;
911
+ * keyProvider.useCache(true);
912
912
  *
913
913
  * // Create a new ProgramManager with the key that will be used to claim unbonded credits.
914
914
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -940,7 +940,7 @@ declare class ProgramManager {
940
940
  *
941
941
  * // Create a keyProvider to handle key management
942
942
  * const keyProvider = new AleoKeyProvider();
943
- * keyProvider.useCache = true;
943
+ * keyProvider.useCache(true);
944
944
  *
945
945
  * // Create a new ProgramManager with the key that will be used to bond credits
946
946
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -977,7 +977,7 @@ declare class ProgramManager {
977
977
  *
978
978
  * // Create a keyProvider to handle key management
979
979
  * const keyProvider = new AleoKeyProvider();
980
- * keyProvider.useCache = true;
980
+ * keyProvider.useCache(true);
981
981
  *
982
982
  * // Create a new ProgramManager with the key that will be used to bond credits
983
983
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -1016,7 +1016,7 @@ declare class ProgramManager {
1016
1016
  *
1017
1017
  * // Create a keyProvider to handle key management
1018
1018
  * const keyProvider = new AleoKeyProvider();
1019
- * keyProvider.useCache = true;
1019
+ * keyProvider.useCache(true);
1020
1020
  *
1021
1021
  * // Create a new ProgramManager with the key that will be used to bond credits
1022
1022
  * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@provablehq/sdk",
3
- "version": "0.9.6",
3
+ "version": "0.9.7",
4
4
  "description": "A Software Development Kit (SDK) for Zero-Knowledge Transactions",
5
5
  "collaborators": [
6
6
  "The Provable Team"
@@ -47,7 +47,7 @@
47
47
  },
48
48
  "homepage": "https://github.com/ProvableHQ/sdk#readme",
49
49
  "dependencies": {
50
- "@provablehq/wasm": "^0.9.6",
50
+ "@provablehq/wasm": "^0.9.7",
51
51
  "comlink": "^4.4.2",
52
52
  "core-js": "^3.40.0",
53
53
  "mime": "^4.0.6",