Merge branch 'release/v1.18.0'

Author: algojack

CHANGELOG.md

@@ -1,3 +1,10 @@
+# v1.18.0
+
+## What's Changed
+
+- Add method to abi results by @barnjamin in https://github.com/algorand/js-algorand-sdk/pull/578
+- Add getMethodByName function to Contract and Interface by @barnjamin in https://github.com/algorand/js-algorand-sdk/pull/583
+
 # v1.17.0
 
 ## What's Changed

Makefile

@@ -1,5 +1,5 @@
 unit:
-	node_modules/.bin/cucumber-js --tags "@unit.offline or @unit.algod or @unit.indexer or @unit.rekey or @unit.tealsign or @unit.dryrun or @unit.applications or @unit.responses or @unit.transactions or @unit.transactions.keyreg or @unit.transactions.payment or @unit.responses.231 or @unit.feetest or @unit.indexer.logs or @unit.abijson or @unit.atomic_transaction_composer or @unit.responses.unlimited_assets or @unit.indexer.ledger_refactoring or @unit.algod.ledger_refactoring or @unit.dryrun.trace.application" tests/cucumber/features --require-module ts-node/register --require tests/cucumber/steps/index.js
+	node_modules/.bin/cucumber-js --tags "@unit.offline or @unit.algod or @unit.indexer or @unit.rekey or @unit.tealsign or @unit.dryrun or @unit.applications or @unit.responses or @unit.transactions or @unit.transactions.keyreg or @unit.transactions.payment or @unit.responses.231 or @unit.feetest or @unit.indexer.logs or @unit.abijson or @unit.abijson.byname or @unit.atomic_transaction_composer or @unit.responses.unlimited_assets or @unit.indexer.ledger_refactoring or @unit.algod.ledger_refactoring or @unit.dryrun.trace.application" tests/cucumber/features --require-module ts-node/register --require tests/cucumber/steps/index.js
 
 integration:
 	node_modules/.bin/cucumber-js --tags "@algod or @assets or @auction or @kmd or @send or @indexer or @rekey or @send.keyregtxn or @dryrun or @compile or @applications or @indexer.applications or @applications.verified or @indexer.231 or @abi or @c2c" tests/cucumber/features --require-module ts-node/register --require tests/cucumber/steps/index.js

README.md

@@ -22,8 +22,8 @@ Include a minified browser bundle directly in your HTML like so:
 
 ```html
 <script
-  src="https://unpkg.com/algosdk@v1.17.0/dist/browser/algosdk.min.js"
-  integrity="sha384-a9B05lyY5P6hDuZRdqWCEOD7xn/qAY8gc4B5/SJwy+t8GcUlwpzJ25qHcYwxi1NX"
+  src="https://unpkg.com/algosdk@v1.18.0/dist/browser/algosdk.min.js"
+  integrity="sha384-sUsnfiP7rGkgddTfqUUdb66b2cVxVmYkCyrJBCcWWSmpccI73Vm9wkUrCLsEcG6f"
   crossorigin="anonymous"
 ></script>
 ```
@@ -32,8 +32,8 @@ or
 
 ```html
 <script
-  src="https://cdn.jsdelivr.net/npm/algosdk@v1.17.0/dist/browser/algosdk.min.js"
-  integrity="sha384-a9B05lyY5P6hDuZRdqWCEOD7xn/qAY8gc4B5/SJwy+t8GcUlwpzJ25qHcYwxi1NX"
+  src="https://cdn.jsdelivr.net/npm/algosdk@v1.18.0/dist/browser/algosdk.min.js"
+  integrity="sha384-sUsnfiP7rGkgddTfqUUdb66b2cVxVmYkCyrJBCcWWSmpccI73Vm9wkUrCLsEcG6f"
   crossorigin="anonymous"
 ></script>
 ```

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "description": "The official JavaScript SDK for Algorand",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -47,15 +47,15 @@
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-tsdoc": "^0.2.11",
     "express": "^4.17.1",
-    "geckodriver": "^2.0.0",
+    "geckodriver": "^3.0.1",
     "husky": "^4.3.8",
     "lint-staged": "^10.5.4",
     "mocha": "^9.0.0",
     "mocha-lcov-reporter": "^1.3.0",
     "mock-http-server": "^1.4.3",
     "path-browserify": "^1.0.1",
     "prettier": "2.2.1",
-    "selenium-webdriver": "^4.0.0-beta.4",
+    "selenium-webdriver": "^4.2.0",
     "source-map-loader": "^2.0.2",
     "ts-loader": "^8.3.0",
     "ts-node": "^10.0.0",

package.json

@@ -1,4 +1,4 @@
-import { ABIMethod, ABIMethodParams } from './method';
+import { ABIMethod, ABIMethodParams, getMethodByName } from './method';
 
 export interface ABIContractNetworkInfo {
   appID: number;
@@ -44,4 +44,8 @@ export class ABIContract {
       methods: this.methods.map((method) => method.toJSON()),
     };
   }
+
+  getMethodByName(name: string): ABIMethod {
+    return getMethodByName(this.methods, name);
+  }
 }

src/abi/contract.ts

@@ -1,4 +1,4 @@
-import { ABIMethod, ABIMethodParams } from './method';
+import { ABIMethod, ABIMethodParams, getMethodByName } from './method';
 
 export interface ABIInterfaceParams {
   name: string;
@@ -28,4 +28,8 @@ export class ABIInterface {
       methods: this.methods.map((method) => method.toJSON()),
     };
   }
+
+  getMethodByName(name: string): ABIMethod {
+    return getMethodByName(this.methods, name);
+  }
 }

src/abi/interface.ts

@@ -160,3 +160,27 @@ export class ABIMethod {
     });
   }
 }
+
+export function getMethodByName(methods: ABIMethod[], name: string): ABIMethod {
+  if (
+    methods === null ||
+    !Array.isArray(methods) ||
+    !methods.every((item) => item instanceof ABIMethod)
+  )
+    throw new Error('Methods list provided is null or not the correct type');
+
+  const filteredMethods = methods.filter((m: ABIMethod) => m.name === name);
+  if (filteredMethods.length > 1)
+    throw new Error(
+      `found ${
+        filteredMethods.length
+      } methods with the same name ${filteredMethods
+        .map((m: ABIMethod) => m.getSignature())
+        .join(',')}`
+    );
+
+  if (filteredMethods.length === 0)
+    throw new Error(`found 0 methods with the name ${name}`);
+
+  return filteredMethods[0];
+}

src/abi/method.ts

@@ -42,6 +42,10 @@ export interface ABIResult {
    * does not return a value (return type "void").
    */
   rawReturnValue: Uint8Array;
+  /**
+   * The method that was called for this result
+   */
+  method: ABIMethod;
   /**
    * The return value from the ABI method call. This will be undefined if the method does not return
    * a value (return type "void"), or if the SDK was unable to decode the returned value.
@@ -632,6 +636,7 @@ export class AtomicTransactionComposer {
       const methodResult: ABIResult = {
         txID,
         rawReturnValue: new Uint8Array(),
+        method,
       };
 
       try {

src/composer.ts

@@ -26,12 +26,19 @@ if (browser) {
   const chrome = require('selenium-webdriver/chrome');
   const firefox = require('selenium-webdriver/firefox');
 
-  const chromeOptions = new chrome.Options();
-  const firefoxOptions = new firefox.Options();
+  let chromeOptions = new chrome.Options();
+  let firefoxOptions = new firefox.Options();
 
   if (process.env.CI) {
-    chromeOptions.addArguments('--no-sandbox', '--headless', '--disable-gpu');
-    firefoxOptions.addArguments('-headless');
+    chromeOptions = chromeOptions.addArguments(
+      'no-sandbox',
+      'disable-gpu',
+      'headless'
+    );
+    firefoxOptions = firefoxOptions
+      .setPreference('remote.active-protocols', 1) // Sets protocol to only WebDriver BiDi
+      .setPreference('network.http.network-changed.timeout', 30) // In Docker tests this apparently matters
+      .headless();
   }
 
   driverBuilder = new webdriver.Builder()