ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-20 04:05:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Elliot Lee
2020-01-22 17:57:21 -08:00
parent f8e80f7132
commit a7bfc2f4ae
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/ripple-keypairs/README.md
View File

@@ -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) # 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 [elliptic](https://github.com/indutny/elliptic) which supports rfc6979 and
eddsa deterministic signatures. eddsa deterministic signatures.
@@ -11,7 +11,7 @@ eddsa deterministic signatures.
``` ```
generateSeed({entropy?: Array<integer>, algorithm?: string}) -> string generateSeed({entropy?: Array<integer>, 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} 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 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 deriveNodeAddress(publicKey: string) -> string
@@ -39,7 +39,7 @@ deriveNodeAddress(publicKey: string) -> string
Derive a node address from a public key. Derive a node address from a public key.
## Generate a random Ripple address ## Generate a random XRP Ledger address
``` ```
const seed = generateSeed(); const seed = generateSeed();