Merge pull request #335 from GridPlus/dev

v1.1.4

README.md

@@ -240,7 +240,7 @@ General signing allows you to request a signature on any message from a private
 ```
 const msg = "I am the message to sign"
 const req = {
-  startPath: [
+  signerPath: [
     0x80000000 + 44,
     0x80000000 + 60,
     0x80000000,
@@ -274,7 +274,7 @@ If you do not wish to specify a decoder, you can leave this field empty and the
 ```
 const msg = solTx.compileMessage().serialize()
 const req = {
-  startPath: [   // Derivation path of the first requested pubkey
+  signerPath: [   // Derivation path of the first requested pubkey
     0x80000000 + 44,
     0x80000000 + 60,
     0x80000000,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gridplus-sdk",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "SDK to interact with GridPlus Lattice1 device",
   "scripts": {
     "build": "tsc -p tsconfig.json",

src/client.ts

@@ -73,6 +73,7 @@ export class Client {
   private privKey: Buffer;
   private retryCount: number;
   private fwVersion: Buffer;
+  private skipRetryOnWrongWallet: boolean;
 
   /** Temporary secret that is generated by the Lattice device */
   private ephemeralPub: KeyPair;
@@ -105,20 +106,25 @@ export class Client {
   /**
    * @param params - Parameters are passed as an object.
    */
-  constructor({ baseUrl, name, privKey, stateData, timeout, retryCount }: {
-    /** The base URL of the signing server. */
-    baseUrl?: string;
-    /** The name of the client. */
-    name?: string;
-    /** The private key of the client.*/
-    privKey?: Buffer;
-    /** Number of times to retry a request if it fails. */
-    retryCount?: number;
-    /** The time to wait for a response before cancelling. */
-    timeout?: number;
-    /** User can pass in previous state data to rehydrate connected session */
-    stateData?: string;
-  }) {
+  constructor({ 
+      baseUrl, name, privKey, stateData, timeout, retryCount, skipRetryOnWrongWallet 
+    }: {
+      /** The base URL of the signing server. */
+      baseUrl?: string;
+      /** The name of the client. */
+      name?: string;
+      /** The private key of the client.*/
+      privKey?: Buffer;
+      /** Number of times to retry a request if it fails. */
+      retryCount?: number;
+      /** The time to wait for a response before cancelling. */
+      timeout?: number;
+      /** User can pass in previous state data to rehydrate connected session */
+      stateData?: string;
+      /** If true we will not retry if we get a wrong wallet error code */
+      skipRetryOnWrongWallet: boolean;
+    }
+  ) {
     // Default state params
     // -----
     this.ephemeralPub = null;
@@ -138,6 +144,7 @@ export class Client {
         external: true,
       },
     };
+    this.skipRetryOnWrongWallet = skipRetryOnWrongWallet || false;
 
     // The user may pass in state data to rehydrate a session that was previously cached
     // -----
@@ -409,6 +416,9 @@ export class Client {
           // In v0.15.0 Lattice firmware removed the legacy ETH signing path, so
           // we need to convert such requests to general signing requests using
           // the EVM decoder.
+          // NOTE: Not every request can be converted, so users should switch
+          // to using general signing requests for newer firmware versions.
+          // EIP1559 and EIP155 legacy requests will convert, but others may not.
           const useEVMDecoder = (
             fwConstants.genericSigning &&
             fwConstants.genericSigning.encodingTypes &&
@@ -424,7 +434,8 @@ export class Client {
               payload = ethereum.ethConvertLegacyToGenericReq(data);
             } catch (err) {
               return cb(
-                `Please update Lattice firmware. Request failed. ${err.message}`
+                'Could not convert legacy request. Please switch to a general signing ' +
+                'request. See gridplus-sdk docs for more information.'
               );
             }
             data = {
@@ -1105,7 +1116,7 @@ export class Client {
             }
             this._request(payload, encReqCode, cb, retryCount - 1);
           });
-        } else if (canRetry && wrongWallet) {
+        } else if (canRetry && wrongWallet && !this.skipRetryOnWrongWallet) {
           // Incorrect wallet being requested. Clear wallet state.
           this._resetActiveWallets();
           // Refetch the active wallet.

src/ethereum.ts

@@ -934,7 +934,11 @@ const ethConvertLegacyToGenericReq = function(req) {
   if (!req.chainId || ensureHexBuffer(req.chainId).toString('hex') === '01') {
     common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Shanghai });
   } else {
-    common = Common.custom({ chainId: req.chainId });
+    // Not every network will support EIP1559 but we will allow it here.
+    common = Common.custom(
+      { chainId: req.chainId }, 
+      { hardfork: Hardfork.Shanghai, eips: [1559]}
+    );
   }
   // Newer transaction types
   if (req.type === 1) {