@provablehq/sdk 0.6.13 → 0.7.1

package/README.md

@@ -4,7 +4,7 @@
 </p>
 
 <p align="center">
-    <a href="https://developer.aleo.org"> <img alt="Website" src="https://img.shields.io/badge/Developer_Docs-online-blue"></a>
+    <a href="https://docs.leo-lang.org"> <img alt="Website" src="https://img.shields.io/badge/Developer_Docs-online-blue"></a>
     <a href="https://circleci.com/gh/ProvableHQ/sdk"><img src="https://circleci.com/gh/ProvableHQ/sdk.svg?style=svg"></a>
     <a href="https://discord.com/invite/aleo"><img src="https://img.shields.io/discord/700454073459015690?logo=discord"/></a>
     <a href="https://github.com/ProvableHQ/sdk#%EF%B8%8F-contributors"><img src="https://img.shields.io/badge/contributors-23-ee8449"/></a>
@@ -182,7 +182,7 @@ function hello:
 The SDK provides the ability to execute Aleo programs 100% client-side within the browser.
 
 The `ProgramManager` object encapsulates the functionality for executing programs and making zero-knowledge proofs about
-them. Under the hood it uses cryptographic code compiled from [SnarkVM](https://developer.aleo.org/aleo) into WebAssembly
+them. Under the hood it uses cryptographic code compiled from [SnarkVM](https://docs.leo-lang.org/aleo) into WebAssembly
 with JavaScript bindings that allow for the execution of Aleo programs fully within the browser. Users interested in lower-level
 details on how this is achieved can visit the [aleo-wasm](https://www.npmjs.com/package/@provablehq/wasm) crate.
 
@@ -275,7 +275,7 @@ import { Account, AleoNetworkClient, NetworkRecordProvider, ProgramManager, Aleo
 const account = new Account();
 
 // Create a network client to connect to the Aleo network
-const networkClient = new AleoNetworkClient("https://api.explorer.aleo.org/v1");
+const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
 
 // Create a key provider that will be used to find public proving & verifying keys for Aleo programs
 const keyProvider = new AleoKeyProvider();
@@ -285,7 +285,7 @@ keyProvider.useCache = true;
 const recordProvider = new NetworkRecordProvider(account, networkClient);
 
 // Initialize a program manager to talk to the Aleo network with the configured key and record providers
-const programManager = new ProgramManager("https://api.explorer.aleo.org/v1", keyProvider, recordProvider);
+const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
 
 // Set the account for the program manager
 programManager.setAccount(account);
@@ -367,7 +367,7 @@ const keyProvider = new AleoKeyProvider();
 keyProvider.useCache(true);
 
 // Create a record provider that will be used to find records and transaction data for Aleo programs
-const networkClient = new AleoNetworkClient("https://api.explorer.aleo.org/v1");
+const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
 
 // Use existing account with funds
 const account = new Account({
@@ -377,7 +377,7 @@ const account = new Account({
 const recordProvider = new NetworkRecordProvider(account, networkClient);
 
 // Initialize a program manager to talk to the Aleo network with the configured key and record providers
-const programManager = new ProgramManager("https://api.explorer.aleo.org/v1", keyProvider, recordProvider);
+const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
 programManager.setAccount(account)
 
 // Define an Aleo program to deploy
@@ -395,7 +395,7 @@ const transaction = await programManager.networkClient.getTransaction(tx_id);
 
 The `NetworkRecordProvider` will attempt to scan the network for a fee record for the account provided. Doing a recent
 public transfer to the deploying account will ensure a record is found quickly, or you can provide a fee record manually
-by [scanning](https://developer.aleo.org/testnet/getting_started/deploy_execute/#scan) for a record and passing it as a
+by [scanning](https://docs.leo-lang.org/testnet/getting_started/deploy_execute/#scan) for a record and passing it as a
 string.
 
 ```typescript
@@ -429,7 +429,7 @@ A full example of this implementation can be found [here](https://github.com/Pro
 
 Aleo Credits are used to access blockspace and computational resources on the network, with users paying Credits to submit transactions and have them processed.
 
-Aleo credits are defined in the [credits.aleo](https://explorer.aleo.org/program/credits.aleo) program. This program is
+Aleo credits are defined in the [credits.aleo](https://explorer.provable.com/program/credits.aleo) program. This program is
 deployed to the Aleo network and defines data structures representing Aleo credits and the functions used to manage them.
 
 There are two ways to hold Aleo credits:
@@ -544,13 +544,13 @@ import { Account, ProgramManager, AleoKeyProvider, NetworkRecordProvider, AleoNe
 
 // Create a new NetworkClient, KeyProvider, and RecordProvider
 const account = Account.from_string({privateKey: "user1PrivateKey"});
-const networkClient = new AleoNetworkClient("https://api.explorer.aleo.org/v1");
+const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
 const keyProvider = new AleoKeyProvider();
 const recordProvider = new NetworkRecordProvider(account, networkClient);
 
 // Initialize a program manager with the key provider to automatically fetch keys for executions
 const USER_1_ADDRESS = "user1Address";
-const programManager = new ProgramManager("https://api.explorer.aleo.org/v1", keyProvider, recordProvider);
+const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
 programManager.setAccount(account);
 
 // Send a private transfer to yourself
@@ -585,7 +585,7 @@ assert(public_balance === 0);
 As shown above, a public balance of any address can be checked with `getMappingValue` function of the `NetworkClient`.
 
 ```typescript
-const networkClient = new AleoNetworkClient("https://api.explorer.aleo.org/v1");
+const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
 const USER_1_ADDRESS = "user1Address";
 const public_balance = networkClient.getMappingValue("credits.aleo", USER_1_ADDRESS);
 ```
@@ -674,13 +674,13 @@ import { Account, ProgramManager, AleoKeyProvider, NetworkRecordProvider, AleoNe
 
 // Create a new NetworkClient, KeyProvider, and RecordProvider
 const account = Account.from_string({privateKey: "user1PrivateKey"});
-const networkClient = new AleoNetworkClient("https://api.explorer.aleo.org/v1");
+const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
 const keyProvider = new AleoKeyProvider();
 const recordProvider = new NetworkRecordProvider(account, networkClient);
 
 // Initialize a program manager with the key provider to automatically fetch keys for executions
 const USER_2_ADDRESS = "user2Address";
-const programManager = new ProgramManager("https://api.explorer.aleo.org/v1", keyProvider, recordProvider);
+const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
 programManager.setAccount(account);
 
 /// Send private transfer to User 2
@@ -695,12 +695,12 @@ import { Account, ProgramManager, AleoKeyProvider, NetworkRecordProvider, AleoNe
 
 // Create a new NetworkClient, KeyProvider, and RecordProvider
 const account = Account.from_string({privateKey: "user2PrivateKey"});
-const networkClient = new AleoNetworkClient("https://api.explorer.aleo.org/v1");
+const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
 const keyProvider = new AleoKeyProvider();
 const recordProvider_User2 = new NetworkRecordProvider(account, networkClient);
 
 // Initialize a program manager with the key provider to automatically fetch keys for executions
-const programManager = new ProgramManager("https://api.explorer.aleo.org/v1", keyProvider, recordProvider);
+const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
 programManager.setAccount(account);
 
 // Fetch the transaction from the network that user 1 sent
@@ -863,7 +863,7 @@ read the value of a specific key within a mapping.
 ```typescript
 import { AleoNetworkClient } from '@provablehq/sdk';
 
-const networkClient = new AleoNetworkClient("https://api.explorer.aleo.org/v1");
+const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
 const creditsMappings = networkClient.getMappings("credits.aleo");
 assert(creditsMappings === ["account"]);
 
@@ -903,20 +903,20 @@ by the Aleo network. All that the user of the SDK must do is ensure that the inp
 If function inputs are invalid, the network will return an error, but the fee paid for the transaction will still be
 consumed. Therefore, it is important to ensure that the inputs to a function are valid before executing it.
 
-A simple example of a mapping update can be shown by simply executing 'transfer_public` as shown below.
+A simple example of a mapping update can be shown by simply executing `transfer_public` as shown below.
 
 ```typescript
 import { Account, ProgramManager, AleoKeyProvider, NetworkRecordProvider, AleoNetworkClient } from '@provablehq/sdk';
 
 // Create a new NetworkClient, KeyProvider, and RecordProvider
 const account = Account.from_string({privateKey: "user1PrivateKey"});
-const networkClient = new AleoNetworkClient("https://api.explorer.aleo.org/v1");
+const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
 const keyProvider = new AleoKeyProvider();
 const recordProvider = new NetworkRecordProvider(account, networkClient);
 
 // Initialize a program manager with the key provider to automatically fetch keys for executions
 const RECIPIENT_ADDRESS = "user1Address";
-const programManager = new ProgramManager("https://api.explorer.aleo.org/v1", keyProvider, recordProvider);
+const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
 programManager.setAccount(account);
 
 // Update or initialize a public balance
@@ -930,7 +930,7 @@ Communication with the Aleo network is done through the `AleoNetworkClient` clas
 data from Aleo network nodes and submit transactions to the Aleo network.
 
 A full list of methods provided by the `AleoNetworkClient` class and usage examples can be found in the
-[Network Client API documentation](https://developer.aleo.org/sdk/typescript/aleo_network_client).
+[Network Client API documentation](https://docs.leo-lang.org/sdk/typescript/aleo_network_client).
 
 ## Further Documentation
 

package/dist/{account.d.ts → mainnet/account.d.ts}

@@ -1,4 +1,4 @@
-import { Address, PrivateKey, Signature, ViewKey, PrivateKeyCiphertext, RecordCiphertext } from "./index";
+import { Address, PrivateKey, Signature, ViewKey, PrivateKeyCiphertext, RecordCiphertext } from "./wasm";
 interface AccountParam {
     privateKey?: string;
     seed?: Uint8Array;
@@ -41,7 +41,7 @@ export declare class Account {
      * Attempts to create an account from a private key ciphertext
      * @param {PrivateKeyCiphertext | string} ciphertext
      * @param {string} password
-     * @returns {PrivateKey | Error}
+     * @returns {PrivateKey}
      *
      * @example
      * const ciphertext = PrivateKey.newEncrypted("password");
@@ -52,7 +52,7 @@ export declare class Account {
     privateKey(): PrivateKey;
     viewKey(): ViewKey;
     address(): Address;
-    toString(): string;
+    toString(): any;
     /**
      * Encrypt the account's private key with a password
      * @param {string} ciphertext
@@ -62,7 +62,7 @@ export declare class Account {
      * const account = new Account();
      * const ciphertext = account.encryptAccount("password");
      */
-    encryptAccount(password: string): PrivateKeyCiphertext;
+    encryptAccount(password: string): any;
     /**
      * Decrypts a Record in ciphertext form into plaintext
      * @param {string} ciphertext
@@ -72,7 +72,7 @@ export declare class Account {
      * const account = new Account();
      * const record = account.decryptRecord("record1ciphertext");
      */
-    decryptRecord(ciphertext: string): string;
+    decryptRecord(ciphertext: string): any;
     /**
      * Decrypts an array of Records in ciphertext form into plaintext
      * @param {string[]} ciphertexts
@@ -82,7 +82,7 @@ export declare class Account {
      * const account = new Account();
      * const record = account.decryptRecords(["record1ciphertext", "record2ciphertext"]);
      */
-    decryptRecords(ciphertexts: string[]): string[];
+    decryptRecords(ciphertexts: string[]): any[];
     /**
      * Determines whether the account owns a ciphertext record
      * @param {RecordCipherText | string} ciphertext
@@ -90,7 +90,7 @@ export declare class Account {
      *
      * @example
      * // Create a connection to the Aleo network and an account
-     * const connection = new NodeConnection("vm.aleo.org/api");
+     * const connection = new AleoNetworkClient("https://api.explorer.provable.com/v1");
      * const account = Account.fromCiphertext("ciphertext", "password");
      *
      * // Get a record from the network
@@ -105,7 +105,7 @@ export declare class Account {
      *     // Etc.
      * }
      */
-    ownsRecordCiphertext(ciphertext: RecordCiphertext | string): boolean;
+    ownsRecordCiphertext(ciphertext: RecordCiphertext | string): any;
     /**
      * Signs a message with the account's private key.
      * Returns a Signature.
@@ -118,7 +118,7 @@ export declare class Account {
      * const message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
      * account.sign(message);
      */
-    sign(message: Uint8Array): Signature;
+    sign(message: Uint8Array): any;
     /**
      * Verifies the Signature on a message.
      *
@@ -132,6 +132,6 @@ export declare class Account {
      * const signature = account.sign(message);
      * account.verify(message, signature);
      */
-    verify(message: Uint8Array, signature: Signature): boolean;
+    verify(message: Uint8Array, signature: Signature): any;
 }
 export {};

package/dist/mainnet/browser.d.ts

@@ -0,0 +1,20 @@
+import "./polyfill/shared";
+import { Account } from "./account";
+import { AleoNetworkClient, ProgramImports } from "./network-client";
+import { Block } from "./models/block";
+import { Execution } from "./models/execution";
+import { Input } from "./models/input";
+import { Output } from "./models/output";
+import { TransactionModel } from "./models/transactionModel";
+import { Transition } from "./models/transition";
+import { AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, CachedKeyPair, FunctionKeyPair, FunctionKeyProvider, KeySearchParams } from "./function-key-provider";
+import { OfflineKeyProvider, OfflineSearchParams } from "./offline-key-provider";
+import { BlockHeightSearch, NetworkRecordProvider, RecordProvider, RecordSearchParams } from "./record-provider";
+declare function initializeWasm(): Promise<void>;
+export { createAleoWorker } from "./managed-worker";
+export { ProgramManager } from "./program-manager";
+export { logAndThrow } from "./utils";
+export { Address, Execution as FunctionExecution, ExecutionResponse, Field, OfflineQuery, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, RecordCiphertext, RecordPlaintext, Signature, Transaction, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution, } from "./wasm";
+export { initializeWasm };
+export { Key, CREDITS_PROGRAM_KEYS, KEY_STORE, PRIVATE_TRANSFER, PRIVATE_TO_PUBLIC_TRANSFER, PRIVATE_TRANSFER_TYPES, PUBLIC_TRANSFER, PUBLIC_TRANSFER_AS_SIGNER, PUBLIC_TO_PRIVATE_TRANSFER, VALID_TRANSFER_TYPES, } from "./constants";
+export { Account, AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, AleoNetworkClient, Block, BlockHeightSearch, CachedKeyPair, Execution, FunctionKeyPair, FunctionKeyProvider, Input, KeySearchParams, NetworkRecordProvider, ProgramImports, OfflineKeyProvider, OfflineSearchParams, Output, RecordProvider, RecordSearchParams, TransactionModel, Transition, };