[Feature] Add Field, Group, Scalar, Plaintext, Ciphertext, Transitions, and Transactions to JS SDK. #948
Conversation
iamalwaysuncomfortable
changed the base branch from
testnet3
to
feat/record-scanning-and-arithmetic
iamalwaysuncomfortable
requested review from
Pauan,
onetrickwolf,
jaketarnow and
d0cd
| @@ -1,7 +1,7 @@ | |||
| import { TransactionModel } from "./transactionModel"; | |||
| import { TransactionJSON } from "./transaction/transactionJSON"; | |||
|
|
|||
| export type ConfirmedTransaction = { | |||
There was a problem hiding this comment.
For objects, it's better to use an interface instead of type
| @@ -0,0 +1,6 @@ | |||
| import { FunctionObject } from "./functionObject"; | |||
|
|
|||
| export type DeploymentMetadata = { | |||
There was a problem hiding this comment.
Same as above, this should be an interface
| @@ -0,0 +1,6 @@ | |||
| import { TransitionJSON } from "./transition/transitionJSON"; | |||
|
|
|||
| export type ExecutionJSON = { | |||
There was a problem hiding this comment.
Same as above, this should be an interface
| @@ -0,0 +1,8 @@ | |||
| import { VerifyingKey } from "@provablehq/wasm"; | |||
|
|
|||
| export type FunctionObject = { | |||
There was a problem hiding this comment.
Same as above, this should be an interface
| /** | ||
| * Object representation of an Input as raw JSON returned from a SnarkOS node. | ||
| */ | ||
| export type InputJSON = { |
There was a problem hiding this comment.
Same as above, this should be an interface
| async getTransactionObjectsInMempool(): Promise<Array<Transaction>> { | ||
| try { | ||
| return (await this.fetchData<Array<string>>("/memoryPool/transactions")) | ||
| .reduce<Array<Transaction>>((acc, transaction) => { |
There was a problem hiding this comment.
Similarly, why is this using reduce?
| expect(unbondPublicProverLocal.isUnbondPublicProver()).equal(true); | ||
| expect(unbondPublicVerifierLocal.isUnbondPublicVerifier()).equal(true); | ||
| }); | ||
| // it('should not fetch invalid transfer keys', async () => { |
There was a problem hiding this comment.
I think it's cleaner to use describe.skip or it.skip to skip the tests, instead of commenting it out.
|
|
||
| import { Account, BlockJSON, AleoNetworkClient, TransactionSummary, InputObject, OutputObject } from "../src/node"; | ||
| import {beaconPrivateKeyString} from "./data/account-data"; | ||
| import { Plaintext, Transition } from "@provablehq/wasm"; |
There was a problem hiding this comment.
This should be importing from ../src/node instead of @provablehq/wasm.
| import { Account, BlockJSON, AleoNetworkClient, TransactionSummary, InputObject, OutputObject } from "../src/node"; | ||
| import {beaconPrivateKeyString} from "./data/account-data"; | ||
| import { Plaintext, Transition } from "@provablehq/wasm"; | ||
| import { TransitionObject } from "../src/models/transition/transitionObject"; |
There was a problem hiding this comment.
This should probably also be importing from ../src/node
| import {beaconPrivateKeyString} from "./data/account-data"; | ||
| import { Plaintext, Transition } from "@provablehq/wasm"; | ||
| import { TransitionObject } from "../src/models/transition/transitionObject"; | ||
| import { PlaintextObject } from "../src/models/plaintext/plaintext"; |
There was a problem hiding this comment.
This should probably also be importing from ../src/node
Motivation
Several feature requests have requested that the ability to the following be added to the SDK.
StructandArraytypesThis PR adds these types to the SDK with the ability to turn them into JavaScript/TypeScript objects for convenient extraction of data into a front or backend app as well as api methods that allow these new types to be directly instantiated when calling api endpoints.
It also provides several new typescript types that allow typescript users to work with the JS representation of these objects.
Once this PR is approved, it will constitute the release candidate for the next major version bump.
Test Plan
This PR adds the following unit tests for the new objects:
Related PRs
#944 - this PR adds the exports of SnarkVM types to
wasmand provides code that