Merge branch 'release/v1.11.0'

evannetwork · Feb 7, 2020 · 94042ca · 94042ca
2 parents 169290a + 96936be
commit 94042ca
Show file tree

Hide file tree

Showing 14 changed files with 339 additions and 184 deletions.
diff --git a/VERSIONS.md b/VERSIONS.md
@@ -8,6 +8,16 @@
 ### Deprecations
 
 
+## Version 1.11.0
+### Features
+- add `getGasPrice` to `SignerInterface`
+
+### Fixes
+- use typescript version `3.7.4`
+- update `AccountStore` to throw if private key is missing
+- check `dataSchema` for incorrect ajv schema when setting description
+
+
 ## Version 1.10.0
 ### Features
 - add `getPublicKey` to `SignerInterface`

diff --git a/docs/blockchain/signer-internal.rst b/docs/blockchain/signer-internal.rst
@@ -134,7 +134,7 @@ Example
 
 ------------------------------------------------------------------------------
 
-.. _signerInternal_getGasPricex:
+.. _signerInternal_getGasPrice:
 
 getGasPrice
 ===================

diff --git a/docs/common/validator.rst b/docs/common/validator.rst
@@ -54,10 +54,37 @@ Example
 .. code-block:: typescript
   
   const nameResolver = new Validator({
-      schema
-    });
+    schema
+  });
 
 
+--------------------------------------------------------------------------------
+
+.. _validator_isSchemaCorrect:
+
+isSchemaCorrect
+===================
+
+.. code-block:: javascript
+
+    Validator.isSchemaCorrect(schema);
+
+Checks if the given ajv schema is correct and returns an array of ajv errors, when the schema is invalid.
+
+
+
+----------
+Parameters
+----------
+
+#. ``schema`` - ``any``: schema to be validated
+
+-------
+Returns
+-------
+
+``bool`` | |source ajvError|_:  true if data is valid, array of object if validation is failed
+
 
 --------------------------------------------------------------------------------
 
@@ -84,7 +111,7 @@ Parameters
 Returns
 -------
 
-``bool | strings[]``:  true if data is valid, array of object if validation is failed
+``bool`` | |source ajvError|_:  true if data is valid, array of object if validation is failed
 
 ------------------------------------------------------------------------------
 
@@ -113,4 +140,7 @@ Returns
 .. _source logLevel: ../common/logger.html#loglevel
 
 .. |source logLogInterface| replace:: ``LogLogInterface``
-.. _source logLogInterface: ../common/logger.html#logloginterface
+.. _source logLogInterface: ../common/logger.html#logloginterface
+
+.. |source ajvError| replace:: ``AjvError``
+.. _source ajvError: https://github.com/epoberezkin/ajv/blob/master/lib/compile/error_classes.js
diff --git a/package.json b/package.json
@@ -23,15 +23,15 @@
     "@types/chai-as-promised": "^7.1.0",
     "@types/chai-spies": "^1.0.1",
     "@types/mocha": "^5.2.7",
-    "@typescript-eslint/eslint-plugin": "^2.12.0",
-    "@typescript-eslint/parser": "^2.11.0",
+    "@typescript-eslint/eslint-plugin": "^2.16.0",
+    "@typescript-eslint/parser": "^2.16.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "chai-spies": "^1.0.0",
     "common-shakeify": "^0.6.2",
     "dirty-chai": "^2.0.1",
-    "eslint": "^6.1.0",
-    "eslint-config-airbnb": "^18.0.1",
+    "eslint": "^6.8.0",
+    "eslint-config-airbnb-base": "^14.0.0",
     "eslint-config-airbnb-typescript": "^6.3.1",
     "eslint-plugin-chai-friendly": "^0.5.0",
     "eslint-plugin-import": "^2.19.1",
@@ -41,7 +41,7 @@
     "nyc": "^13.1.0",
     "request": "^2.83.0",
     "ts-node": "^8.3.0",
-    "typescript": "^3.5.3"
+    "typescript": "^3.7.4"
   },
   "homepage": "https://dbcp.online/",
   "husky": {
@@ -75,5 +75,5 @@
     "testunitcoverage": "npm run build && nyc -r lcov -e .ts -x \"**/*.spec.ts\" -x \"lib\" mocha --exit -r ts-node/register $TESTSPECS && nyc report --reporter=json > coverage/coverage.json"
   },
   "types": "./dist/index.d.ts",
-  "version": "1.10.0"
-}
+  "version": "1.11.0"
+}
diff --git a/src/account-store.ts b/src/account-store.ts
@@ -59,7 +59,11 @@ export class AccountStore extends Logger implements KeyStoreInterface {
    * @param      {string}           accountId  eth accountId
    * @return     {Promise<string>}  private key for this account
    */
-  getPrivateKey(accountId: string): Promise<string> {
-    return Promise.resolve(this.accounts[accountId]);
+  async getPrivateKey(accountId: string): Promise<string> {
+    const privateKey = this.accounts[accountId];
+    if (!privateKey) {
+      throw new Error(`missing private key for accountId "${accountId}"`);
+    }
+    return privateKey;
   }
 }
diff --git a/src/contracts/executor.spec.ts b/src/contracts/executor.spec.ts
@@ -84,6 +84,10 @@ class MockedSigner implements SignerInterface {
   public async signMessage(): Promise<string> {
     throw new Error('not implemented');
   }
+
+  public async getGasPrice(): Promise<string> {
+    throw new Error('not implemented');
+  }
 }
 
 

diff --git a/src/contracts/signer-external.ts b/src/contracts/signer-external.ts
@@ -22,6 +22,10 @@ export class SignerExternal implements SignerInterface {
     throw new Error('not implemented');
   }
 
+  public async getGasPrice(): Promise<string> {
+    throw new Error('not implemented');
+  }
+
   public async getPublicKey(): Promise<string> {
     throw new Error('not implemented');
   }

diff --git a/src/contracts/signer-interface.ts b/src/contracts/signer-interface.ts
@@ -26,6 +26,14 @@ export interface SignerInterface {
    */
   createContract(contractName: string, functionArguments: any[], options: any): Promise<string>;
 
+  /**
+   * get gas price (either from config or from api.eth.web3.eth.gasPrice (gas price median of last
+   * blocks) or api.config.eth.gasPrice; unset config value or set it to falsy for median gas price
+   *
+   * @return     {Promise<string>} hex string with gas price
+   */
+  getGasPrice(): Promise<string>;
+
   /**
    * get public key for given account
    *