Handle MetaMask Errors

Just a small update to handle a change to MetaMask's error object and to add a notification for the txError event that happens when there is no stack or message parameter on the error object returned from MetaMask.

Change log:

• Handle error object (#377)
• Notification for txError event (f274dd3)

Opt Out of Browser Check

This update adds the ability to opt of the valid browser check via a config option, fixes an error that would occur when trying to parse an undefined message parameter of a send transaction error and also updates some dependencies that had vulnerabilities.

Change log:

• Browser check opt out (#374)
• Error parsing error message (#370)
• Update mixin-deep (fb53af0)
• Update eslint-utils (e0d2eae)

Update Dependency

Just a minor update to resolve a vulnerability in one of our dependencies that uses lodash.

Change log:

• Bump lodash from 4.17.11 to 4.17.15 (cf3a4bc)

Support web3.js 1.2 and separate pending and confirmed stalls

We received feedback that our txStall notification is unclear as to where the stall occurs. Therefore, we separated the stall notification into two new notification states: txStallPending and txStallConfirmed. See the documentation for setting up custom messages and timeouts for the newly separated stall states. https://github.com/blocknative/assist/blob/master/README.md#config

NOTE: This is a breaking change for this release. The previous txStall state is no longer supported and will generate a console log message.

If you use txStall configs, you must replace old txStall configs to use the new txStallPending and txStallConfirmed configs. This also applies to handleNotificationEvent and inline custom message (https://github.com/blocknative/assist/blob/master/README.md#custom-transaction-messages)

Change Log:

• Update docs to include tx receipt (#350)
• Add documentation on fname minification (#354)
• Throw human friendly error when a Truffle contract is ID'd as a web3 contract (#354)
• Support web3.js v1.2.0 (#355)
• update Assist onboarding to recognize hardware wallets (#361)
• Improve error handling for transactions, add notification for low gas error (#359)
• Remove nonce from txStallPending message as it hasn't been received from the server, update snapshot

Transaction logs in custom messages

This release adds the full receipt, including the transaction logs, that are received for confirmed transactions so that it can be accessed in the handleNotificationEvent function. An example receipt is:

Change log:

• FEATURE: Add tx receipt transaction logs to tx object (#341)
• FIX: Set a default empty object for notificationsOptions to avoid error (#345)
• FIX: Make promievent errors and events match web3 js (#329)

Custom click handlers for notifications

With this release you can add a click handler to Assist notifications. If a user clicks on the notification, your custom click handler will be called with appropriate context. See more details in the documentation at https://github.com/blocknative/assist/blob/master/README.md#click-handlers-for-transaction-notifications

Changes

• FEATURE: Add custom click handlers to notifications (#231)
• FIX: Send correct contract args to event (#337)
• FIX: Make sure consistent categoryCode for lifecycle of tx (#339)
• FIX: Make sure txOptions are passed in with correct key (#344)

Configurable on-boarding wallet selection

This release give the Dapp developer control over which wallets are suggested for the initial on-boarding screen. A new config field supports specifying wallets for desktop and mobile that should appear in the initial on-boarding screen, along with their icons and links to install wallet.

We encourage developers to test their Dapp with available wallets and only include those that are verified to work with the Dapp.

The documentation provides link and icon URLs at time of writing for wallets currently known to work with Assist.

https://github.com/blocknative/assist/tree/master#recommended-wallets

Changes

• FEATURE: Configurable Wallet Onboarding (#330)
• FIX: Add transaction.to field after it is available (#332)

Track signed transactions

With this release, Dapps can track an already signed transaction (e.g. signed by a hardware wallet), by passing the transaction hash to the Transaction method. See docs for more details:

https://github.com/blocknative/assist#transactiontxobjectorhash--callback--inlinecustommsgs

This release also adds support for Goerli testnet.

• Track by transaction hash (#319)
• Add Goerli as a valid network (#320)
• Update documentation for handleNotificationEvent (#326)

Original hash in callbacks

When transactions are sped-up or cancelled, a new transaction is created with the same nonce and higher gas. This new transaction replaces the original in the mempool, effectively dropping the original transaction. This means the original transaction hash is defunct, never to be seen again.

With this update, our API provides the original transaction hash, as originalHash, in the transaction object passed to a handleNotificationEvent callback, allowing the Dapp to handle any additional UI updates that are tied to the original transaction hash. This is especially usefully if the Dapp uses the transaction hash as a key for backed services. The Dapp can now modify that key when receiving txSpeedup and txCancel events.

See https://github.com/blocknative/assist/tree/master#handling-notifications for details on handleNotificationEvent and the contents of the transaction object passed to the callback.

• Add original hash (#316)

Bug fixes and more browser recommendations

This release adds Opera and Brave to our recommended browser list if running on a browser that does not support web3 (e.g. Safari). Similarly, on mobile devices this release adds Opera Touch as a recommended browser wallet. (#313)

We also fixed a few bugs in our 0.9 release:

• Fixed error in headlessMode with iFrame handling (#309)
• Fixed incorrect validation of minimumBalance from config (#311)