Add types, documentation, and jest tests (#67)

Author: Willem Wyndham

.npmignore

@@ -7,4 +7,5 @@ bindgen/src
 bindgen/out
 bindgen/asconfig.js
 bindgen/test.js
-runtime/dist/tsconfig.tsbuildinfo
+runtime/dist/tsconfig.tsbuildinfo
+**/*/__tests__

install-near-vm.js

@@ -0,0 +1,6 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ["**/__tests__/**/*.spec.ts"],
+  testPathIgnorePatterns: ["/assembly/", "/node_modules/"],
+};

jest.config.js

@@ -33,18 +33,21 @@
     "test": "yarn test:bindgen && yarn asp:ci && yarn test:nearcore && yarn test:runtime",
     "test:nearcore": "(cd nearcore-tests; yarn test)",
     "test:bindgen": "(cd bindgen; yarn test)",
-    "test:runtime": "(cd runtime; node asconfig && ./test.ts)",
+    "test:runtime": "(cd runtime; node asconfig) && jest",
     "asp:ci": "asp",
     "asp": "yarn asp:ci --verbose",
     "doc": "rm -rf docs; typedoc assembly --tsconfig assembly/tsconfig.json && touch docs/.nojekyll"
   },
   "devDependencies": {
     "@types/bn.js": "^4.11.6",
     "@types/bs58": "^4.0.1",
+    "@types/jest": "^25.2.1",
     "@types/js-base64": "^2.3.1",
-    "@types/node": "^13.13.2",
+    "@types/node": "^13.13.4",
     "assemblyscript": "^0.9.4",
+    "jest": "^25.5.4",
     "near-hello": "nearprotocol/near-hello#d4712392ab5ec56b6b0f0aa40dd4a2c744114a10",
+    "ts-jest": "^25.4.0",
     "ts-node": "^8.6.2",
     "typedoc": "^0.17.3",
     "typescript": "^3.6.4"

package.json

@@ -0,0 +1,26 @@
+import { Runtime, Account } from "..";
+
+let runtime: Runtime;
+let sentences: Account, words: Account, alice: Account;
+describe("cross contract calls", () => {
+  beforeEach(() => {
+    runtime = new Runtime();
+    alice = runtime.newAccount("alice");
+    sentences = runtime.newAccount("sentences", __dirname + "/../out/sentences.wasm");
+    words = runtime.newAccount("words.examples", __dirname + "/../out/words.wasm");
+  });
+  
+  test("single promise", () => {
+    let res = alice.call_other("sentences", "reverseWordOne");
+    expect(res.return_data.text).toBe("elpmas")
+  });
+
+  test("promise + then with no arguments", () => {
+    let res  = alice.call_other("sentences", "reverseWordTwo");
+    expect(res.return_data).toBe(true)
+  }); 
+  test("promise + then with arguments", () => {
+    let res  = alice.call_other("sentences", "reverseWordThree");
+    expect(res.return_data).toBe(true)
+  });  
+})

runtime/__tests__/cross.spec.ts

@@ -1,7 +1,8 @@
 import { AccountContext } from "./context";
-declare type State = {
-    [key: string]: string;
-};
+import { State, StandaloneOutput, ResultsObject } from './types';
+/**
+ * Account object of client and contracts.
+ */
 export declare class Account {
     account_id: string;
     wasmFile: string | null;
@@ -10,28 +11,65 @@ export declare class Account {
     balance: number;
     lockedBalance: number;
     signerAccountPk: string;
+    /**
+     * Sholud only be constructed by a runtime instance.
+     * @param account_id
+     * @param wasmFile
+     * @param runtime
+     */
     constructor(account_id: string, wasmFile: string | null, runtime: Runtime);
-    createAccountContext(input?: any, prepaid_gas?: number): Partial<AccountContext>;
-    call_step_other(account_id: string, method_name: string, input?: any, prepaid_gas?: number): any;
-    call_step(method_name: string, input?: any, prepaid_gas?: number): any;
+    private createAccountContext;
+    /**
+     * Single execution of contract method.
+     * @param account_id contractId to call
+     * @param method_name method to call
+     * @param input object of arguments of method
+     * @param prepaid_gas How much gas to use.
+     */
+    call_step_other(account_id: string, method_name: string, input?: any, prepaid_gas?: number): StandaloneOutput;
+    /**
+     * Single execution of contract method to the same contract.
+     * @param method_name method to call
+     * @param input object of arguments of method
+     * @param prepaid_gas How much gas to use.
+     */
+    call_step(method_name: string, input?: any, prepaid_gas?: number): StandaloneOutput;
+    /**
+     * Execute contract and any promises generated until no more promises are generated or gas runs out.
+     * @param account_id Initial Contract to call.
+     * @param method_name Method to call.
+     * @param input object of input to method.
+     * @param prepaid_gas How much gas to use.
+     */
     call_other(account_id: string, method_name: string, input?: any, prepaid_gas?: number): {
         return_data: any;
         err: any;
-        result: any;
+        result: StandaloneOutput;
         calls: any;
-        results: any;
+        results: ResultsObject;
     };
+    /**
+     * Execute this contract and any promises generated until no more promises are generated or gas runs out.
+     * @param method_name Method to call.
+     * @param input object of input to method.
+     * @param prepaid_gas How much gas to use.
+     */
     call(method_name: string, input?: any, prepaid_gas?: number): {
         return_data: any;
         err: any;
-        result: any;
+        result: StandaloneOutput;
         calls: any;
-        results: any;
+        results: ResultsObject;
     };
+    /**
+     * View contract call to this contract.
+     * @param method_name view method.
+     * @param input object of input to method.
+     */
     view(method_name: string, input?: any): {
-        return_data: any;
+        return_value: string;
         err: any;
-        result: any;
+        result: StandaloneOutput;
     };
     /**
      * Current state of contract.
@@ -41,18 +79,17 @@ export declare class Account {
 export declare class Runtime {
     accounts: Map<string, Account>;
     constructor();
-    log(input: any): void;
+    private log;
     newAccount(accoundId: string, wasmFile?: string | null): Account;
     getOrCreateAccount(account_id: string): Account;
     getAccount(account_id: string): Account;
-    call_step(account_id: string, method_name: string, input?: string, accountContext?: Partial<AccountContext>): any;
+    call_step(account_id: string, method_name: string, input?: string, accountContext?: Partial<AccountContext>): StandaloneOutput;
     call(account_id: string, method_name: string, input: string | undefined, accountContext: Partial<AccountContext>): {
         return_data: any;
         err: any;
-        result: any;
+        result: StandaloneOutput;
         calls: any;
-        results: any;
+        results: ResultsObject;
     };
     private spawn;
 }
-export {};