Skip to content

Commit

Permalink
Merge pull request #9 from MetaMask/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
Bruno Barbieri committed Jul 4, 2018
2 parents 641af68 + fe61a72 commit 8f8e408
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
eth-trezor-keyring [![CircleCI](https://circleci.com/gh/brunobar79/eth-trezor-keyring.svg?style=svg)](https://circleci.com/gh/brunobar79/eth-trezor-keyring)
==================

An implementation of MetaMask's [Keyring interface](https://github.com/MetaMask/eth-simple-keyring#the-keyring-class-protocol), that uses a trezor hardware
An implementation of MetaMask's [Keyring interface](https://github.com/MetaMask/eth-simple-keyring#the-keyring-class-protocol), that uses a TREZOR hardware
wallet for all cryptographic operations.

In most regards, it works in the same way as
[eth-hd-keyring](https://github.com/MetaMask/eth-hd-keyring), but using a Trezor
[eth-hd-keyring](https://github.com/MetaMask/eth-hd-keyring), but using a TREZOR
device. However there are a number of differences:

- Because the keys are stored in the device, operations that rely on the device
will fail if there is no Trezor device attached, or a different Trezor device
will fail if there is no TREZOR device attached, or a different TREZOR device
is attached.
- It does not support the `signMessage`, `signTypedData` or `exportAccount`
methods, because Trezor devices do not support these operations.
- The method `signPersonalMessage` will be enabled in the next version of the trezor firmware based on [this conversation](https://github.com/trezor/connect/issues/109#issuecomment-396217063))
methods, because TREZOR devices do not support these operations.
- The method `signPersonalMessage` requires the firmware version 2.0.7+ for TREZOR Model T and 1.6.2+ on TREZOR ONE

Using
-----

In addition to all the known methods from the [Keyring class protocol](https://github.com/MetaMask/eth-simple-keyring#the-keyring-class-protocol),
there are a few others:

- **unlock** : Connects to the trezor device and exports the extended public key, which is later used to read the available ethereum addresses inside the trezor account.
- **unlock** : Connects to the TREZOR device and exports the extended public key, which is later used to read the available ethereum addresses inside the trezor account.

- **setAccountToUnlock** : the index of the account that you want to unlock in order to use with the signTransaction and signPersonalMessage methods

- **getNextPage** : returns the next ordered set of accounts from the Trezor account based on the current page
- **getNextPage** : returns the next ordered set of accounts from the TREZOR account based on the current page

- **getPreviousPage** : returns the previous ordered set of accounts from the Trezor account based on the current page
- **getPreviousPage** : returns the previous ordered set of accounts from the TREZOR account based on the current page

Testing
-------
Expand All @@ -41,4 +41,4 @@ npm test

Attributions
-------
This code was inspired by [eth-ledger-keyring](https://github.com/jamespic/eth-ledger-keyring) and [eth-hd-keyring](https://github.com/MetaMask/eth-hd-keyring)
This code was inspired by [eth-ledger-keyring](https://github.com/jamespic/eth-ledger-keyring) and [eth-hd-keyring](https://github.com/MetaMask/eth-hd-keyring)

0 comments on commit 8f8e408

Please sign in to comment.