diff --git a/packages/ripple-keypairs/README.md b/packages/ripple-keypairs/README.md index 9f513838..82eb196a 100644 --- a/packages/ripple-keypairs/README.md +++ b/packages/ripple-keypairs/README.md @@ -1,6 +1,6 @@ # ripple-keypairs [![NPM](https://img.shields.io/npm/v/ripple-keypairs.svg)](https://npmjs.org/package/ripple-keypairs) [![Build Status](https://img.shields.io/travis/ripple/ripple-keypairs/master.svg)](https://travis-ci.org/ripple/ripple-keypairs) -An implementation of ripple keypairs & wallet generation using +An implementation of XRP Ledger keypairs & wallet generation using [elliptic](https://github.com/indutny/elliptic) which supports rfc6979 and eddsa deterministic signatures. @@ -11,7 +11,7 @@ eddsa deterministic signatures. ``` generateSeed({entropy?: Array, algorithm?: string}) -> string ``` -Generate a seed that can be used to generate keypairs. Entropy can be provided as an array of bytes expressed as integers in the range 0-255. If provided, it must be at least 16 bytes long. If not provided, entropy will be automatically generated. The "algorithm" defaults to "ecdsa-secp256k1", but can also be set to "ed25519". The result is a seed encoded in base58, starting with "s". +Generate a seed that can be used to generate keypairs. Entropy can be provided as an array of bytes expressed as integers in the range 0-255. If provided, it must be 16 bytes long (additional bytes are ignored). If not provided, entropy will be automatically generated. The "algorithm" defaults to "ecdsa-secp256k1", but can also be set to "ed25519". The result is a seed encoded in base58, starting with "s". ``` deriveKeypair(seed: string) -> {privateKey: string, publicKey: string} @@ -31,7 +31,7 @@ Verify a signature for a given hex-encoded message and public key. Returns true ``` deriveAddress(publicKey: string) -> string ``` -Derive a Ripple address from a public key. +Derive an XRP Ledger classic address from a public key. ``` deriveNodeAddress(publicKey: string) -> string @@ -39,7 +39,7 @@ deriveNodeAddress(publicKey: string) -> string Derive a node address from a public key. -## Generate a random Ripple address +## Generate a random XRP Ledger address ``` const seed = generateSeed();