Merge branch 'development' into e2e-tests-added

Author: cgcardona

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14, 16]
+        node-version: [16]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2

.github/workflows/e2e.yml

@@ -25,7 +25,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           cache: yarn
-          node-version: '14'
+          node-version: '16'
       - name: Install NodeJS dependencies
         run: yarn install --frozen-lockfile
       - name: Setup Golang Version

documentation/README.md

@@ -0,0 +1,5 @@
+# Documentation
+
+
+* [ESLint](./eslint.md)
+* [E2E Tests](./e2e_tests.md)

documentation/e2e_tests.md

@@ -8,6 +8,28 @@ For example,
 
 `./avash_avalanchejs_e2e.sh "/path/to/avash/" "/path/to/avalanchejs/"`
 
+This script runs the five node script by default.
 
 - New E2E tests go in the /e2e_tests/ directory.
 
+Follow the steps below if you do not wish to use the five node script, but instead test against one of the nodes. You provide the PORT of the specified node.
+
+## Avash
+
+This option does not require executing a docker container, but it may not lead to the same results of CI, depending on the branch, version, and configuration options of the nodes executed by avash.
+
+* Launch `avash`
+* Set env vars `AVALANCHEGO_IP`, `AVALANCHEGO_PORT` to point to one of the nodes of avash
+* From avalanchejs dir execute: `yarn test -i --roots e2e_tests`
+
+Example workflow
+
+```zsh
+cd /path/to/avash
+ ./avash
+avash> runscript scripts/five_node_staking.lua
+
+# Open another terminal tab/window
+cd /path/to/avalanchejs
+AVALANCHEGO_IP=localhost AVALANCHEGO_PORT=9650 yarn test -i --roots e2e_tests
+```

e2e_tests/avash_avalanchejs_e2e.sh

@@ -68,4 +68,3 @@ echo killall avalanchego
 
 # cleanup
 rm -f $fifo_fname
-

e2e_tests/e2e_local.md

@@ -162,30 +162,10 @@ describe("XChain", (): void => {
       Matcher.toThrow,
       () => "couldn't unmarshal an argument"
     ],
-    [
-      "exportAVAX",
-      () =>
-        xchain.exportAVAX(
-          user,
-          passwd,
-          "C" + addrB.value.substring(1),
-          new BN(10)
-        ),
-      (x) => x,
-      Matcher.toThrow,
-      () => "couldn't unmarshal an argument"
-    ],
     [
       "import",
       () => xchain.import(user, passwd, addrB.value, "C"),
       (x) => x,
-      Matcher.toMatch,
-      () => /\w+/
-    ],
-    [
-      "importAVAX",
-      () => xchain.importAVAX(user, passwd, addrB.value, "P"),
-      (x) => x,
       Matcher.toThrow,
       () => "problem issuing transaction: no import inputs"
     ],

e2e_tests/e2e_local.sh

@@ -1,6 +1,6 @@
 {
   "name": "avalanche",
-  "version": "3.9.1",
+  "version": "3.9.3",
   "description": "Avalanche Platform JS Library",
   "main": "dist/index.js",
   "scripts": {
@@ -49,7 +49,7 @@
     "@types/create-hash": "1.2.2",
     "@types/hdkey": "2.0.0",
     "@types/jest": "27.0.2",
-    "@types/node": "16.10.2",
+    "@types/node": "16.11.6",
     "@typescript-eslint/eslint-plugin": "4.33.0",
     "@typescript-eslint/parser": "4.33.0",
     "clean-webpack-plugin": "4.0.0",
@@ -58,41 +58,41 @@
     "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-security": "1.4.0",
     "git-revision-webpack-plugin": "5.0.0",
-    "html-webpack-plugin": "5.3.2",
-    "husky": "7.0.2",
-    "isomorphic-dompurify": "^0.15.0",
+    "html-webpack-plugin": "5.5.0",
+    "husky": "7.0.4",
     "jest": "26.6.3",
     "jest-mock-axios": "4.4.1",
     "prettier": "2.4.1",
-    "terser-webpack-plugin": "5.1.4",
+    "terser-webpack-plugin": "5.2.4",
     "ts-jest": "26.5.6",
     "ts-loader": "9.2.6",
     "typedoc": "0.22.4",
     "typedoc-plugin-external-module-name": "4.0.6",
-    "typedoc-plugin-markdown": "3.11.2",
-    "typescript": "4.4.3",
-    "webpack": "5.51.1",
-    "webpack-cli": "4.8.0"
+    "typedoc-plugin-markdown": "3.11.3",
+    "typescript": "4.4.4",
+    "webpack": "5.58.2",
+    "webpack-cli": "4.9.1"
   },
   "engines": {
-    "node": ">=14.17.0"
+    "node": ">=16.13.0"
   },
   "dependencies": {
     "assert": "2.0.0",
-    "axios": "0.21.4",
+    "axios": "0.24.0",
     "bech32": "2.0.0",
     "bip39": "3.0.4",
     "bn.js": "5.2.0",
     "buffer": "6.0.3",
     "create-hash": "1.2.0",
     "crypto-browserify": "3.12.0",
     "elliptic": "6.5.4",
-    "ethers": "5.4.7",
+    "ethers": "5.5.1",
     "hdkey": "2.0.1",
+    "isomorphic-dompurify": "^0.15.0",
     "isomorphic-ws": "4.0.1",
     "store2": "2.12.0",
     "stream-browserify": "3.0.0",
-    "ws": "8.2.2"
+    "ws": "8.2.3"
   },
   "prettier": {
     "tabWidth": 2,

e2e_tests/xchain_nomock.test.ts

@@ -36,7 +36,6 @@ import {
   CreateAddressParams,
   CreateFixedCapAssetParams,
   CreateVariableCapAssetParams,
-  ExportAVAXParams,
   ExportParams,
   ExportKeyParams,
   GetAllBalancesParams,
@@ -46,7 +45,6 @@ import {
   GetTxParams,
   GetTxStatusParams,
   GetUTXOsParams,
-  ImportAVAXParams,
   ImportParams,
   ImportKeyParams,
   ListAddressesParams,
@@ -579,7 +577,7 @@ export class AVMAPI extends JRPCAPI {
   /**
    * Send ANT (Avalanche Native Token) assets including AVAX from the X-Chain to an account on the P-Chain or C-Chain.
    *
-   * After calling this method, you must call the P-Chain's `importAVAX` or the C-Chain’s `import` method to complete the transfer.
+   * After calling this method, you must call the P-Chain's `import` or the C-Chain’s `import` method to complete the transfer.
    *
    * @param username The Keystore user that controls the P-Chain or C-Chain account specified in `to`
    * @param password The password of the Keystore user
@@ -610,37 +608,6 @@ export class AVMAPI extends JRPCAPI {
     return response.data.result.txID
   }
 
-  /**
-   * Send AVAX from the X-Chain to an account on the P-Chain or C-Chain.
-   *
-   * After calling this method, you must call the P-Chain’s or C-Chain's importAVAX method to complete the transfer.
-   *
-   * @param username The Keystore user that controls the P-Chain account specified in `to`
-   * @param password The password of the Keystore user
-   * @param to The account on the P-Chain or C-Chain to send the AVAX to.
-   * @param amount Amount of AVAX to export as a {@link https://github.com/indutny/bn.js/|BN}
-   *
-   * @returns String representing the transaction id
-   */
-  exportAVAX = async (
-    username: string,
-    password: string,
-    to: string,
-    amount: BN
-  ): Promise<string> => {
-    const params: ExportAVAXParams = {
-      to,
-      amount: amount,
-      username,
-      password
-    }
-    const response: RequestResponseData = await this.callMethod(
-      "avm.exportAVAX",
-      params
-    )
-    return response.data.result.txID
-  }
-
   /**
    * Send ANT (Avalanche Native Token) assets including AVAX from an account on the P-Chain or C-Chain to an address on the X-Chain. This transaction
    * must be signed with the key of the account that the asset is sent from and which pays
@@ -673,36 +640,6 @@ export class AVMAPI extends JRPCAPI {
     return response.data.result.txID
   }
 
-  /**
-   * Finalize a transfer of AVAX from the P-Chain to the X-Chain.
-   *
-   * Before this method is called, you must call the P-Chain’s `exportAVAX` method to initiate the transfer.
-   * @param username The Keystore user that controls the address specified in `to`
-   * @param password The password of the Keystore user
-   * @param to The address the AVAX is sent to. This must be the same as the to argument in the corresponding call to the P-Chain’s exportAVAX, except that the prepended X- should be included in this argument
-   * @param sourceChain Chain the funds are coming from.
-   *
-   * @returns String representing the transaction id
-   */
-  importAVAX = async (
-    username: string,
-    password: string,
-    to: string,
-    sourceChain: string
-  ): Promise<string> => {
-    const params: ImportAVAXParams = {
-      to,
-      sourceChain,
-      username,
-      password
-    }
-    const response: RequestResponseData = await this.callMethod(
-      "avm.importAVAX",
-      params
-    )
-    return response.data.result.txID
-  }
-
   /**
    * Lists all the addresses under a user.
    *

package.json

@@ -57,21 +57,11 @@ export interface ExportParams extends CredsInterface {
   assetID: string
 }
 
-export interface ExportAVAXParams extends CredsInterface {
-  to: string
-  amount: BN
-}
-
 export interface ImportParams extends CredsInterface {
   to: string
   sourceChain: string
 }
 
-export interface ImportAVAXParams extends CredsInterface {
-  to: string
-  sourceChain: string
-}
-
 export interface ListAddressesParams extends CredsInterface {}
 
 export interface GetAllBalancesParams {