embarklabs
/
ethereumjs-wallet
mirror of https://github.com/embarklabs/ethereumjs-wallet.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add a comprehensive description in the README

This commit is contained in:
Alex Beregszaszi 2016-02-24 01:52:12 +00:00
parent fe88dd0e0e
commit 33e3e08293
1 changed files with 40 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -21,16 +21,47 @@ Features not supported:
Constructors: Constructors:
* `fromPrivateKey` - create an instance based on a raw key * `fromPrivateKey(input)` - create an instance based on a raw key
* `fromV1` - import a wallet (Version 1 of the Ethereum wallet format) * `fromV1(input, password)` - import a wallet (Version 1 of the Ethereum wallet format)
* `fromV3` - import a wallet (Version 3 of the Ethereum wallet format) * `fromV3(input, password)` - import a wallet (Version 3 of the Ethereum wallet format)
* `fromEthSale` - import an Ethereum Pre Sale wallet * `fromEthSale(input, password)` - import an Ethereum Pre Sale wallet
For the V1, V3 and EthSale formats the input is a JSON serialized string. All these formats require a password.
Instance methods: Instance methods:
* `getPrivateKey` - return the private key * `getPrivateKey()` - return the private key
* `getPublicKey` - return the public key * `getPublicKey()` - return the public key
* `getAddress` - return the address * `getAddress()` - return the address
* `toV3` - return the wallet as a JSON string (Version 3 of the Ethereum wallet format) * `toV3(password, [options])` - return the wallet as a JSON string (Version 3 of the Ethereum wallet format)
All of the above instance methods return a Buffer or JSON. Use the `String` suffixed versions for a string output, such as `getPrivateKeyString`. All of the above instance methods return a Buffer or JSON. Use the `String` suffixed versions for a string output, such as `getPrivateKeyString()`.
### Remarks about `toV3`
The `options` is an optional object hash, where all the serialization parameters can be fine tuned:
- uuid - UUID. One is randomly generated.
- salt - Random salt for the `kdf`. Size must match the requirements of the KDF (key derivation function). Random number generated via `crypto.getRandomBytes` if nothing is supplied.
- iv - Initialization vector for the `cipher`. Size must match the requirements of the cipher. Random number generated via `crypto.getRandomBytes` if nothing is supplied.
- kdf - The key derivation function, see below.
- dklen - Derived key length. For certain `cipher` settings, this must match the block sizes of those.
- cipher - The cipher to use. Names must match those of supported by `OpenSSL`, e.g. `aes-128-ctr` or `aes-128-cbc`.
Depending on the `kdf` selected, the following options are available too.
For `pbkdf2`:
- `c` - Number of iterations. Defaults to 262144.
- `prf` - The only supported (and default) value is `hmac-sha256`. So no point changing it.
For `scrypt`:
- `n` - Iteration count. Defaults to 262144.
- `r` - Block size for the underlying hash. Defaults to 8.
- `p` - Parallelization factor. Defaults to 1.
The following settings are favoured by the Go Ethereum implementation and we default to the same:
- `kdf`: `scrypt`
- `dklen`: `32`
- `n`: `262144`
- `r`: `8`
- `p`: `1`
- `cipher`: `aes-128-ctr`