Merge branch 'mainnet' into feat/network-retries

Author: christianwwwwwwww

sdk/src/browser.ts

@@ -10,6 +10,7 @@ import { ExecutionJSON, FeeExecutionJSON } from "./models/execution/executionJSO
 import { ExecutionObject, FeeExecutionObject } from "./models/execution/executionObject";
 import { FinalizeJSON } from "./models/finalizeJSON";
 import { FunctionObject } from "./models/functionObject";
+import { ImportedVerifyingKeys, ImportedPrograms } from "./models/imports";
 import { InputJSON } from "./models/input/inputJSON";
 import { InputObject } from "./models/input/inputObject";
 import { OutputJSON } from "./models/output/outputJSON";
@@ -128,6 +129,8 @@ export {
     FunctionKeyPair,
     FunctionKeyProvider,
     Header,
+    ImportedPrograms,
+    ImportedVerifyingKeys,
     InputJSON,
     InputObject,
     KeySearchParams,

sdk/src/models/imports.ts

@@ -0,0 +1,9 @@
+interface ImportedVerifyingKeys {
+    [key: string]: Array<[string, string]>;
+}
+
+interface ImportedPrograms {
+    [key: string]: string; // This allows for arbitrary keys with any type values
+}
+
+export { ImportedVerifyingKeys, ImportedPrograms }

sdk/src/network-client.ts

@@ -33,12 +33,14 @@ interface AleoNetworkClientOptions {
  * const publicNetworkClient = new AleoNetworkClient("http://api.explorer.provable.com/v1", undefined, account);
  */
 class AleoNetworkClient {
-    host: string;
-    headers: { [key: string]: string };
-    account: Account | undefined;
-
-    constructor(host: string, options?: AleoNetworkClientOptions | undefined) {
-        this.host = host + "/%%NETWORK%%";
+  host: string;
+  headers: { [key: string]: string };
+  account: Account | undefined;
+  readonly network: string;
+
+  constructor(host: string, options?: AleoNetworkClientOptions) {
+    this.host = host + "/%%NETWORK%%";
+    this.network = "%%NETWORK%%";
 
         if (options && options.headers) {
             this.headers = options.headers;

sdk/src/program-manager.ts

@@ -1,6 +1,6 @@
 import { Account } from "./account";
 import { AleoNetworkClient, AleoNetworkClientOptions, ProgramImports } from "./network-client";
-
+import { ImportedPrograms, ImportedVerifyingKeys } from "./models/imports";
 import { RecordProvider, RecordSearchParams } from "./record-provider";
 
 import {
@@ -1952,12 +1952,38 @@ class ProgramManager {
     }
 
     /**
-     * Verify a proof of execution from an offline execution
+     * Verify a proof from an offline execution. This is useful when it is desired to do offchain proving and verification.
      *
-     * @param {executionResponse} executionResponse
+     * @param {executionResponse} executionResponse The response from an offline function execution (via the `programManager.run` method)
+     * @param {ImportedPrograms} imports The imported programs used in the execution. Specified as { "programName": "programSourceCode", ... }
+     * @param {ImportedVerifyingKeys} importedVerifyingKeys The verifying keys in the execution. Specified as { "programName": [["functionName", "verifyingKey"], ...], ... }
      * @returns {boolean} True if the proof is valid, false otherwise
+     *
+     * @example
+     * /// Import the mainnet version of the sdk used to build executions.
+     * import { Account, ProgramManager } from "@provablehq/sdk/mainnet.js";
+     *
+     * /// Create the source for two programs.
+     * const program = "import add_it_up.aleo; \n\n program mul_add.aleo;\n\nfunction mul_and_add:\n    input r0 as u32.public;\n    input r1 as u32.private;\n    mul r0 r1 into r2;\n call add_it_up.aleo/add_it r1 r2 into r3;  output r3 as u32.private;\n";
+     * const program_import = "program add_it_up.aleo;\n\nfunction add_it:\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";
+     * const programManager = new ProgramManager(undefined, undefined, undefined);
+     *
+     * /// Create a temporary account for the execution of the program
+     * const account = Account.fromCipherText(process.env.ciphertext, process.env.password);
+     * programManager.setAccount(account);
+     *
+     * /// Get the response and ensure that the program executed correctly
+     * const executionResponse = await programManager.run(program, "mul_and_add", ["5u32", "5u32"], true);
+     *
+     * /// Construct the imports and verifying keys
+     * 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);
+     * assert(isValid);
      */
-    verifyExecution(executionResponse: ExecutionResponse): boolean {
+    verifyExecution(executionResponse: ExecutionResponse, imports?: ImportedPrograms, importedVerifyingKeys?: ImportedVerifyingKeys): boolean {
         try {
             const execution = <FunctionExecution>(
                 executionResponse.getExecution()
@@ -1970,6 +1996,8 @@ class ProgramManager {
                 verifyingKey,
                 program,
                 function_id,
+                imports,
+                importedVerifyingKeys,
             );
         } catch (e) {
             console.warn(

sdk/tests/data/program.ts

@@ -0,0 +1,9 @@
+// Define an execution with imports, its imported programs, and the verifying keys for the functions called from the imported programs.
+const SPIN_VERIFYING_KEY: string = "verifier1qysqqqqqqqqqqqxrjvqqqqqqqqqtaycqqqqqqqqqnpjszqqqqqqqpm9lqyqqqqqqqrddxqqqqqqqqqqvqqqqqqqqqqqt8ksvknxqn3yc8rlnf75w0d6v7h3kad4patlmn4rzq7yny8rawe4c58yq3t64v2p4ts3g506j2juq5mzxwk3z34zrjrvkhl99xju75derjkxv64ktsdzmu3mwkj486tnndw2x8cnwj9q469yf3l7304sqzyufsu8pqdcykenav93ms3uqh9sgahmxrr74f6wr8eqyxkud0xw2jlt9v674gj0ml4zrqzf3mz0pszntjt5mtw79spqcud6ekjpqc9u28snzyg8vdt78up3q6mlq7nh7ms06xyslj7s9jcna0r7s2t9pdqyvae8kcjqcl358u88qrcu83q3zta2rf58yvqrtvqmtux8d0h3sx9r44xw4a069lz989262kja6xuqzttnujfrthkj6fr0vlvz9fdzle8kupdqea0x8pe6xju962lskf7sajl3pddxx4arqd8aafuzxczypyk0cqvjt26th3hg845vrxx9vtzpgn5vpu5j49ednwvyf4yl86ujpknqcqzq2jvn5ux8sh286tkgsqv7mqz20629zxffvee9ncdl8mdw38uhqsfdam3585jdxcuu6wxds7m8mss5yxj2tmcu6cq93hh28s9ws33ey0vz9mv9xcy3pfyekzruxtznw0625ynvc4j2mtd8yl9drcftlkqqvl4em0dxz6umvxua9cqg9sesfw6gs6fwvgtadw79mkh48kwpvevypd0f6da8scpck2xnhxhe6zcxrknntkd92wcqccdfdy2qhwne53e3fhak42p0y73re7njr8xyraq7dy4ncvfcly5j2jler3ln04dgzkrdsm7vufdrarh7xy6vpw634mv2jyv088zj9upl63gntav65gskcyez0cg86wa6hzhjjjygqzh7mndqnk8yhdh9ppud0a7tqruvdqge9a9ltkk4vjua07kq2l7xqd55zjyh7jqq96tyglk55l4a25t2sqqqqqqqqqs6zqrd";
+const SPEND_VERIFYING_KEY: string = "verifier1qygqqqqqqqqqqqz33cqqqqqqqqqxrrsqqqqqqqqql5rqzqqqqqqqptslqyqqqqqqqpedvqqqqqqqqqqvqqqqqqqqqqqyudfp2mjt8zj3lskjzunts69hgx2kpwryn37p62f30mwqtca442epnw2dqstdnh88ljx44p5cmjyqnfx620nl9pwsh6qsaeughffgfrpxc5qhl5wda6ekss7pt3j72ps32wlrv7mlljjq9lq5jn8yn29gztqk8yz8ehq7smprjs3gzsllqpzaq07gk9yw50te0yarl5yd796xldapdfpc4n75ccy7z2jkmfyss8zz89gz7fw7937xjzt3k3cmhrekgjzzvxmqtzd20ffae8eym3lhq2gwejgqjmw9c8edum06s6a24q2zv9w3kcz5uavcgatlskxxy285nq5uhceusavwzu8rqu0e6lj6j5kgva00aw6x0khfyn4gg3ppeqqwmw3crvtgrdc8w45flwm4d9e8r3edct8hsgven70juqd9me3jk27cgr9fz90h57r2eqdctegc3ecqfh3kr9vx8u0tjhmfp4edpd9skke5yqw9u2ep8l5mwcuhdqcthr8u98wqsng6thy7wsfm2hut3musppwexfetnc7p46ckcjx2a3zvcxf8hht9yja03ymx5sy9wuhsmvsag676w6jg5yeqw3qzah5r38zpqxk8wzm0vk52ed4qtypnup37x2uj89lftvk4hfskd9wwumxvgawsm5xfum05p7vapjzpwu79k9hr7qf0wckhmkmmdxka8zz5qkaxrjsz3eny3x0vdsn5z9zcm8n2me44a56ej7893uduwv2l3ls7ua09dgqsvuddsgn4c9gn68hplup49rtfht0we6ruwn2sqe53z9sv4zq8924w7fku98fwpujykme2tumda4sqk54july0cd8gsvdx62t7gqjrfmrt6t7ezc8cvrxw99rq72h3qm3rr87fl47d5uw55pvdpfcj7weqqvks75erlpc73d08e2xsatay4vc2ey69wz8648wzqvagsyx4vs4lmnqqqqqqqqqqqwv0uty";
+const MINT_VERIFYING_KEY: string = "verifier1qygqqqqqqqqqqqyjvyqqqqqqqqqfvcgqqqqqqqqqar9sqqqqqqqqq282qqqqqqqqqpjexqqqqqqqqqqvqqqqqqqqqqqtj8lxtlmlrtwaffkdwfctwu2ujt795jnnwj0jsgyc57n0lcsqkjy5u04k25gf9wzt45xwaxt9vzsqwj2ad42zuukvjklg8r8t5uxw6sslpsjdetjnx0vpqdwp7rddernk8kdr6av3cpx6e5cd7tu579ucr47qrhz003d2xpwc5rejfp60acvra8edv3qmkp29ukhzv0htt8gnnkfk6afgj2vg9ys9hjl4ww3gszkd2zl2yh8ms0tfxn546w8q20dmj5fcxuyj8vevl9r0pk3fm0y27g5r25z97gjyxrgfdperxh490qxjhcffdfxdc65hvtan5q76ghfpqg3mzzs350s0jlu5pc4k3252nq93dctnjscmy3rgxypswpvucjqxreh6x5ahwfpa7yrl24s5pq2naz6fz0u3v2zhqp3fcx0ycq9ptxtqscnf3g6u8llurjer85g5zyqpwfd599vphjna37cjehn88y36u6hl0tp9r206grcdrssggawcjfcf3vuscy90sks8s0klryzmdgxszagsqqxzly4j92q7psv9a36exzuz7ckkrslcxtnv77vq9hcurdcxq98xvdz0a8pnct7lcr9x8dprsxhdsq2j4t3805e3dztss26h8p8e6q3mzhv0549fw8dktm06tjayvnu5xag8hx9k3hsgvjknyaaawqzcj0wm5nzffuq3tr0pfh0arw5qgsc326sccyn7wz3h0nu7vcz9pu4k39syt248t7hexlapdvffpzq0we245z8l70qk8c5kmqkfwmedmf0dje4kxtc0qntwc9yxl09jhcshytl73ddhuem5lyx9ns6qvcgpspr50m76j4c4aa5wrgrqvm40jl00whc5yajujcqlwmlpdsskfw3se2ghy25pg66wm7z8zxatz25sp6e63w6qr378h0ul7v5udurmc26fkkeqynypurffzz50lmcmqv67vjpqqqqqqqqqqa59tnr";
+const PROGRAM: string = "import puzzle_arcade_coin_v002.aleo;\nimport puzzle_arcade_ticket_v002.aleo;\n\nprogram puzzle_spinner_v002.aleo;\n\nstruct Result:\n    nonce as field;\n    tickets as u64;\n\nmapping used_nonces:\n    key as field.public;\n    value as boolean.public;\n\nfunction spin:\n    input r0 as puzzle_arcade_coin_v002.aleo/PuzzleArcadeCoin.record;\n    input r1 as Result.public;\n    input r2 as signature.private;\n    sign.verify r2 aleo196a39wq9q8ea779cmlmff0c9pj2gl4f5e8fhjpvmufe5utuq7y8snz4h2l r1 into r3;\n    assert.eq r3 true ;\n    is.eq r1.tickets 1000000u64 into r4;\n    is.eq r1.tickets 2000000u64 into r5;\n    or r4 r5 into r6;\n    is.eq r1.tickets 5000000u64 into r7;\n    or r6 r7 into r8;\n    is.eq r1.tickets 10000000u64 into r9;\n    or r8 r9 into r10;\n    assert.eq r10 true ;\n    call puzzle_arcade_coin_v002.aleo/spend r0 1000000u64 into r11;\n    call puzzle_arcade_ticket_v002.aleo/mint r0.owner r1.tickets into r12 r13;\n    async spin r13 r1.nonce into r14;\n    output r11 as puzzle_arcade_coin_v002.aleo/PuzzleArcadeCoin.record;\n    output r12 as puzzle_arcade_ticket_v002.aleo/PuzzleArcadeTicket.record;\n    output r14 as puzzle_spinner_v002.aleo/spin.future;\n\nfinalize spin:\n    input r0 as puzzle_arcade_ticket_v002.aleo/mint.future;\n    input r1 as field.public;\n    get.or_use used_nonces[r1] false into r2;\n    assert.eq r2 false ;\n    set true into used_nonces[r1];\n    await r0;\n";
+const IMPORT_1: string = "program puzzle_arcade_coin_v002.aleo;\n\nrecord PuzzleArcadeCoin:\n    owner as address.private;\n    amount as u64.private;\n\nfunction mint:\n    input r0 as address.public;\n    input r1 as u64.public;\n    assert.eq self.caller self.signer ;\n    assert.eq self.caller aleo196a39wq9q8ea779cmlmff0c9pj2gl4f5e8fhjpvmufe5utuq7y8snz4h2l ;\n    cast r0 r1 into r2 as PuzzleArcadeCoin.record;\n    output r2 as PuzzleArcadeCoin.record;\n\nfunction spend:\n    input r0 as PuzzleArcadeCoin.record;\n    input r1 as u64.public;\n    gte r0.amount r1 into r2;\n    assert.eq r2 true ;\n    sub r0.amount r1 into r3;\n    cast r0.owner r3 into r4 as PuzzleArcadeCoin.record;\n    output r4 as PuzzleArcadeCoin.record;\n";
+const IMPORT_2: string = "program puzzle_arcade_ticket_v002.aleo;\n\nrecord PuzzleArcadeTicket:\n    owner as address.private;\n    amount as u64.private;\n\nmapping registry:\n    key as address.public;\n    value as boolean.public;\n\nfunction add_program_to_registry:\n    input r0 as address.private;\n    assert.eq self.caller self.signer ;\n    assert.eq self.caller aleo196a39wq9q8ea779cmlmff0c9pj2gl4f5e8fhjpvmufe5utuq7y8snz4h2l ;\n    async add_program_to_registry r0 into r1;\n    output r1 as puzzle_arcade_ticket_v002.aleo/add_program_to_registry.future;\n\nfinalize add_program_to_registry:\n    input r0 as address.public;\n    set true into registry[r0];\n\nfunction mint:\n    input r0 as address.public;\n    input r1 as u64.public;\n    cast r0 r1 into r2 as PuzzleArcadeTicket.record;\n    async mint self.caller into r3;\n    output r2 as PuzzleArcadeTicket.record;\n    output r3 as puzzle_arcade_ticket_v002.aleo/mint.future;\n\nfinalize mint:\n    input r0 as address.public;\n    get.or_use registry[r0] false into r1;\n    assert.eq r1 true ;\n\nfunction spend:\n    input r0 as PuzzleArcadeTicket.record;\n    input r1 as u64.public;\n    gte r0.amount r1 into r2;\n    assert.eq r2 true ;\n    sub r0.amount r1 into r3;\n    cast r0.owner r3 into r4 as PuzzleArcadeTicket.record;\n    output r4 as PuzzleArcadeTicket.record;\n\nfunction join:\n    input r0 as PuzzleArcadeTicket.record;\n    input r1 as PuzzleArcadeTicket.record;\n    gt r0.amount 0u64 into r2;\n    assert.eq r2 true ;\n    gt r1.amount 0u64 into r3;\n    assert.eq r3 true ;\n    add r0.amount r1.amount into r4;\n    cast self.signer r4 into r5 as PuzzleArcadeTicket.record;\n    output r5 as PuzzleArcadeTicket.record;\n\nfunction join3:\n    input r0 as PuzzleArcadeTicket.record;\n    input r1 as PuzzleArcadeTicket.record;\n    input r2 as PuzzleArcadeTicket.record;\n    gt r0.amount 0u64 into r3;\n    assert.eq r3 true ;\n    gt r1.amount 0u64 into r4;\n    assert.eq r4 true ;\n    gt r2.amount 0u64 into r5;\n    assert.eq r5 true ;\n    add r0.amount r1.amount into r6;\n    add r6 r2.amount into r7;\n    cast self.signer r7 into r8 as PuzzleArcadeTicket.record;\n    output r8 as PuzzleArcadeTicket.record;\n\nfunction join4:\n    input r0 as PuzzleArcadeTicket.record;\n    input r1 as PuzzleArcadeTicket.record;\n    input r2 as PuzzleArcadeTicket.record;\n    input r3 as PuzzleArcadeTicket.record;\n    gt r0.amount 0u64 into r4;\n    assert.eq r4 true ;\n    gt r1.amount 0u64 into r5;\n    assert.eq r5 true ;\n    gt r2.amount 0u64 into r6;\n    assert.eq r6 true ;\n    gt r3.amount 0u64 into r7;\n    assert.eq r7 true ;\n    add r0.amount r1.amount into r8;\n    add r8 r2.amount into r9;\n    add r9 r3.amount into r10;\n    cast self.signer r10 into r11 as PuzzleArcadeTicket.record;\n    output r11 as PuzzleArcadeTicket.record;\n\nfunction join5:\n    input r0 as PuzzleArcadeTicket.record;\n    input r1 as PuzzleArcadeTicket.record;\n    input r2 as PuzzleArcadeTicket.record;\n    input r3 as PuzzleArcadeTicket.record;\n    input r4 as PuzzleArcadeTicket.record;\n    gt r0.amount 0u64 into r5;\n    assert.eq r5 true ;\n    gt r1.amount 0u64 into r6;\n    assert.eq r6 true ;\n    gt r2.amount 0u64 into r7;\n    assert.eq r7 true ;\n    gt r3.amount 0u64 into r8;\n    assert.eq r8 true ;\n    gt r4.amount 0u64 into r9;\n    assert.eq r9 true ;\n    add r0.amount r1.amount into r10;\n    add r10 r2.amount into r11;\n    add r11 r3.amount into r12;\n    add r12 r4.amount into r13;\n    cast self.signer r13 into r14 as PuzzleArcadeTicket.record;\n    output r14 as PuzzleArcadeTicket.record;\n";
+
+export { IMPORT_1, IMPORT_2, MINT_VERIFYING_KEY, PROGRAM, SPEND_VERIFYING_KEY, SPIN_VERIFYING_KEY };

sdk/tests/network-client.test.ts

@@ -36,21 +36,11 @@ async function expectThrows(f: () => Promise<any>): Promise<void> {
 
 describe("NodeConnection", () => {
     let connection: AleoNetworkClient;
-    let network: string;
     let windowFetchSpy: sinon.SinonSpy;
 
     beforeEach(() => {
-        connection = new AleoNetworkClient(
-            "https://api.explorer.provable.com/v1",
-        );
-        if (
-            connection.host === "https://api.explorer.provable.com/v1/testnet"
-        ) {
-            network = "testnet";
-        } else {
-            network = "mainnet";
-        }
-        windowFetchSpy = sinon.spy(globalThis, "fetch");
+        connection = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+        windowFetchSpy = sinon.spy(globalThis, 'fetch');
     });
 
     afterEach(() => {
@@ -469,9 +459,9 @@ describe("NodeConnection", () => {
         });
     });
 
-    describe("Test API methods that return wasm objects", () => {
-        it("Plaintext returned from the API should have expected properties", async () => {
-            if (network === "testnet") {
+    describe('Test API methods that return wasm objects', () => {
+        it('Plaintext returned from the API should have expected properties', async () => {
+            if (connection.network === "testnet") {
                 // Check a struct variant of a plaintext object.
                 let plaintext = await connection.getProgramMappingPlaintext(
                     "credits.aleo",
@@ -502,10 +492,8 @@ describe("NodeConnection", () => {
 
         it("should have correct data within the wasm object and summary object for an execution transaction", async () => {
             // Get the first transaction at block 24700 on testnet.
-            if (network === "testnet") {
-                const transaction = await connection.getTransactionObject(
-                    "at1fjy6s9md2v4rgcn3j3q4qndtfaa2zvg58a4uha0rujvrn4cumu9qfazxdd",
-                );
+            if (connection.network === "testnet") {
+                const transaction = await connection.getTransactionObject("at1fjy6s9md2v4rgcn3j3q4qndtfaa2zvg58a4uha0rujvrn4cumu9qfazxdd");
                 const transition = <Transition>transaction.transitions()[0];
                 const summary = <TransactionObject>transaction.summary(true);
 
@@ -615,10 +603,8 @@ describe("NodeConnection", () => {
 
         it("should have correct data within the wasm object and summary object for a deployment transaction", async () => {
             // Get the deployment transaction for token_registry.aleo
-            if (network === "mainnet") {
-                const transaction = await connection.getTransactionObject(
-                    "at15mwg0jyhvpjjrfxwrlwzn8puusnmy7r3xzvpjht4e5gzgnp68q9qd0qqec",
-                );
+            if (connection.network === "mainnet") {
+                const transaction = await connection.getTransactionObject("at15mwg0jyhvpjjrfxwrlwzn8puusnmy7r3xzvpjht4e5gzgnp68q9qd0qqec");
                 const summary = <TransactionObject>transaction.summary(true);
                 const deployment = <DeploymentObject>summary.deployment;
 
@@ -646,8 +632,8 @@ describe("NodeConnection", () => {
             }
         });
 
-        it("Should give the correct JSON response when requesting multiple transactions", async () => {
-            if (network === "testnet") {
+        it('Should give the correct JSON response when requesting multiple transactions', async () => {
+            if (connection.network === "testnet") {
                 const transactions = await connection.getTransactions(27400);
                 expect(transactions.length).equal(4);
                 expect(transactions[0].status).equal("accepted");