[Feature] Add Field, Group, Scalar, Plaintext, Ciphertext, Transitions, and Transactions to JS SDK.

.circleci/config.yml

@@ -99,7 +99,7 @@ jobs:
       - run:
           working_directory: create-leo-app/template-node
           command: |
-            yarn start
+            yarn dev
 
   template-node-ts:
     executor: rust-node
@@ -108,7 +108,7 @@ jobs:
       - run:
           working_directory: create-leo-app/template-node-ts
           command: |
-            yarn start
+            yarn dev
 
   template-extension:
     executor: rust-node

create-leo-app/template-node-ts/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "scripts": {
     "build": "rimraf dist/js && rollup --config",
-    "start": "npm run build && node dist/index.js"
+    "dev": "npm run build && node dist/index.js"
   },
   "dependencies": {
     "@provablehq/sdk": "^0.7.0"

create-leo-app/template-node/package.json

@@ -4,7 +4,7 @@
   "version": "0.0.0",
   "type": "module",
   "scripts": {
-    "start": "node index.js"
+    "dev": "node index.js"
   },
   "dependencies": {
     "@provablehq/sdk": "^0.7.0"

create-leo-app/template-offline-public-transaction-ts/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "scripts": {
     "build": "rimraf dist/js && rollup --config",
-    "start": "npm run build && node dist/index.js"
+    "dev": "npm run build && node dist/index.js"
   },
   "dependencies": {
     "@provablehq/sdk": "^0.7.0"

sdk/package.json

@@ -47,10 +47,11 @@
   },
   "homepage": "https://github.com/ProvableHQ/sdk#readme",
   "dependencies": {
-    "@provablehq/wasm": "^0.7.0",
+    "@provablehq/wasm": "^0.7.2",
     "comlink": "^4.4.1",
     "mime": "^3.0.0",
-    "sync-request": "^6.1.0"
+    "sync-request": "^6.1.0",
+    "core-js": "^3.38.1"
   },
   "devDependencies": {
     "@rollup/plugin-replace": "^5.0.5",
@@ -63,7 +64,6 @@
     "better-docs": "^2.7.2",
     "chai": "^5.1.1",
     "clean-jsdoc-theme": "^4.1.8",
-    "core-js": "^3.38.1",
     "cpr": "^3.0.1",
     "eslint": "^8.26.0",
     "eslint-config-prettier": "^8.5.0",

sdk/src/browser.ts

@@ -2,12 +2,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 { BlockJSON } from "./models/blockJSON";
+import { ExecutionJSON } from "./models/executionJSON";
+import { FunctionObject } from "./models/functionObject";
+import { InputJSON } from "./models/input/inputJSON";
+import { InputObject } from "./models/input/inputObject";
+import { OutputJSON } from "./models/output/outputJSON";
+import { OutputObject } from "./models/output/outputObject";
+import { PlaintextArray} from "./models/plaintext/array";
+import { PlaintextLiteral} from "./models/plaintext/literal";
+import { PlaintextStruct} from "./models/plaintext/struct";
+import { TransactionJSON } from "./models/transaction/transactionJSON";
+import { TransactionSummary } from "./models/transaction/transactionSummary";
+import { TransitionJSON } from "./models/transition/transitionJSON";
+import { TransitionObject } from "./models/transition/transitionObject";
 import {
     AleoKeyProvider,
     AleoKeyProviderParams,
@@ -41,10 +49,13 @@ export { logAndThrow } from "./utils";
 
 export {
     Address,
+    Ciphertext,
     Execution as FunctionExecution,
     ExecutionResponse,
     Field,
+    Group,
     OfflineQuery,
+    Plaintext,
     PrivateKey,
     PrivateKeyCiphertext,
     Program,
@@ -53,7 +64,9 @@ export {
     RecordCiphertext,
     RecordPlaintext,
     Signature,
+    Scalar,
     Transaction,
+    Transition,
     VerifyingKey,
     ViewKey,
     initThreadPool,
@@ -81,21 +94,27 @@ export {
     AleoKeyProviderParams,
     AleoKeyProviderInitParams,
     AleoNetworkClient,
-    Block,
+    BlockJSON,
     BlockHeightSearch,
     CachedKeyPair,
-    Execution,
+    ExecutionJSON,
+    FunctionObject,
     FunctionKeyPair,
     FunctionKeyProvider,
-    Input,
+    InputJSON,
+    InputObject,
     KeySearchParams,
     NetworkRecordProvider,
     ProgramImports,
     OfflineKeyProvider,
     OfflineSearchParams,
-    Output,
+    PlaintextArray,
+    PlaintextLiteral,
+    PlaintextStruct,
+    OutputJSON,
+    OutputObject,
     RecordProvider,
     RecordSearchParams,
-    TransactionModel,
-    Transition,
+    TransactionJSON,
+    TransactionSummary,
 };

sdk/src/models/block.ts → sdk/src/models/blockJSON.ts

@@ -1,6 +1,6 @@
 import { ConfirmedTransaction } from "./confirmed_transaction";
 
-export type Block = {
+export type BlockJSON = {
     block_hash: string;
     previous_hash: string;
     header: Header;

sdk/src/models/confirmed_transaction.ts

@@ -1,7 +1,7 @@
-import { TransactionModel } from "./transactionModel";
+import { TransactionJSON } from "./transaction/transactionJSON";
 
 export type ConfirmedTransaction = {
     type: string;
     id: string;
-    transaction: TransactionModel;
+    transaction: TransactionJSON;
 }

sdk/src/models/deploy.ts

@@ -0,0 +1,6 @@
+import { FunctionObject } from "./functionObject";
+
+export type DeploymentMetadata = {
+    "programId" : string,
+    "functions" : FunctionObject[]
+}

sdk/src/models/executionJSON.ts

@@ -0,0 +1,6 @@
+import { TransitionJSON } from "./transition/transitionJSON";
+
+export type ExecutionJSON = {
+    edition: number;
+    transitions?: (TransitionJSON)[];
+}

sdk/src/models/functionObject.ts

@@ -0,0 +1,8 @@
+import { VerifyingKey } from "@provablehq/wasm";
+
+export type FunctionObject = {
+    "name" : string,
+    "constraints" : number,
+    "variables" : number,
+    "verifyingKey" : string | VerifyingKey,
+}

sdk/src/models/input.ts → sdk/src/models/input/inputJSON.ts

@@ -1,4 +1,7 @@
-export type Input = {
+/**
+ * Object representation of an Input as raw JSON returned from a SnarkOS node.
+ */
+export type InputJSON = {
     type: string;
     id: string;
     tag?: string;

sdk/src/models/input/inputObject.ts

@@ -0,0 +1,16 @@
+/**
+ * Aleo function Input represented as a typed typescript object.
+ */
+import { Ciphertext, Field } from "@provablehq/wasm";
+import { Plaintext } from "@provablehq/wasm/mainnet.js";
+import { PlaintextObject } from "../plaintext/plaintext";
+
+/**
+ * Object representation of an Input as raw JSON returned from a SnarkOS node.
+ */
+export type InputObject = {
+    type: "string",
+    id: "string" | Field,
+    tag?: string | Field,
+    value?: Ciphertext | Plaintext | PlaintextObject,
+}

sdk/src/models/output.ts → sdk/src/models/output/outputJSON.ts

@@ -1,4 +1,4 @@
-export type Output = {
+export type OutputJSON = {
     type: string;
     id: string;
     checksum: string;

sdk/src/models/output/outputObject.ts

@@ -0,0 +1,18 @@
+/**
+ * Aleo function Input represented as a typed typescript object.
+ */
+import { Field, Ciphertext, Plaintext } from "@provablehq/wasm";
+import { PlaintextObject } from "../plaintext/plaintext";
+
+/**
+ * Object representation of an Input as raw JSON returned from a SnarkOS node.
+ */
+export type OutputObject = {
+    type: string,
+    id: string | Field,
+    value?: Ciphertext | Plaintext | PlaintextObject,
+    checksum?: string | Field,
+    programId?: string,
+    functionName?: string,
+    arguments?: Array<Plaintext> | Array<OutputObject>
+}

sdk/src/models/plaintext/array.ts

@@ -0,0 +1,4 @@
+import { PlaintextLiteral } from "./literal";
+import { PlaintextStruct } from "./struct";
+
+export type PlaintextArray = PlaintextLiteral[] | PlaintextStruct[] | PlaintextArray[];

sdk/src/models/plaintext/literal.ts

@@ -0,0 +1 @@
+export type PlaintextLiteral = boolean | bigint | number | string;

sdk/src/models/plaintext/plaintext.ts

@@ -0,0 +1,5 @@
+import { PlaintextArray } from "./array";
+import { PlaintextLiteral } from "./literal";
+import { PlaintextStruct } from "./struct";
+
+export type PlaintextObject = PlaintextArray| PlaintextLiteral | PlaintextStruct

sdk/src/models/plaintext/struct.ts

@@ -0,0 +1,6 @@
+import { PlaintextArray } from "./array";
+import { PlaintextLiteral } from "./literal";
+
+export type PlaintextStruct = {
+    [key: string]: PlaintextArray | PlaintextLiteral | PlaintextStruct;
+}

sdk/src/models/transaction/transactionJSON.ts

@@ -0,0 +1,7 @@
+import { ExecutionJSON } from "../executionJSON";
+
+export type TransactionJSON = {
+    type: string;
+    id: string;
+    execution: ExecutionJSON;
+}

sdk/src/models/transaction/transactionSummary.ts

@@ -0,0 +1,12 @@
+import { TransitionObject } from "../transition/transitionObject";
+import { DeploymentMetadata } from "../deploy";
+
+export type TransactionSummary = {
+    id : string;
+    type : string;
+    fee : bigint;
+    baseFee : bigint;
+    priorityFee : bigint;
+    transitions : TransitionObject[];
+    deployment?: DeploymentMetadata;
+}

sdk/src/models/transition/transitionJSON.ts

@@ -0,0 +1,14 @@
+import { InputJSON } from "../input/inputJSON";
+import { OutputJSON } from "../output/outputJSON";
+
+export type TransitionJSON = {
+    id: string;
+    program: string;
+    function: string;
+    inputs?: (InputJSON)[];
+    outputs?: (OutputJSON)[];
+    proof: string;
+    tpk: string;
+    tcm: string;
+    fee: bigint;
+}

sdk/src/models/transition/transitionObject.ts

@@ -0,0 +1,16 @@
+import { InputObject } from "../input/inputObject";
+import { OutputObject } from "../output/outputObject";
+import { Field, Group } from "@provablehq/wasm";
+
+export type TransitionObject = {
+    id: string;
+    program: string;
+    functionName: string;
+    inputs?: (InputObject)[];
+    outputs?: (OutputObject)[];
+    proof: string;
+    tpk: string | Group;
+    tcm: string | Field;
+    scm: string | Field;
+    fee: bigint;
+}