ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update release notes

Browse Source
This commit is contained in:
Elliot Lee
2018-09-11 18:45:52 -07:00
parent 9eec98778f
commit 79971f906b
6 changed files with 26 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
HISTORY.md
View File

@@ -1,5 +1,17 @@
# ripple-lib Release History
## UNRELEASED
+ Add address/secret/key validation and derivation methods ([#932](https://github.com/ripple/ripple-lib/pull/932))
+ `isValidAddress(address: string) : boolean`: Checks if the specified string contains a valid address.
+ `isValidSecret(secret: string): boolean`: Checks if the specified string contains a valid secret.
+ `deriveKeypair(seed: string): {privateKey: string, publicKey: string}`: Derive a public and private key from a seed.
+ `deriveAddress(publicKey: string): string`: Derive an XRP Ledger address from a public key.
+ To derive an address from a secret:
1. Derive the public key from the secret.
2. Derive the address from the public key.
+ Example: `const address = api.deriveAddress(api.deriveKeypair(secret).publicKey)`
## 1.0.0 (2018-08-30)
We are pleased to announce the release of `ripple-lib` version 1.0.0.

14
docs/index.md
View File

@@ -5110,13 +5110,13 @@ return api.generateAddress();
## isValidAddress
`isValidAddress(address: string) : boolean
`isValidAddress(address: string): boolean`
Checks if the specified string contains a valid ledger address.
Checks if the specified string contains a valid address.
### Parameters
This method takes one parameter, the address which to validate.
This method takes one parameter, the address to validate.
### Return Value
@@ -5130,9 +5130,9 @@ return api.isValidAddress("address")
## isValidSecret
`isValidSecret(secret: string) : boolean
`isValidSecret(secret: string): boolean`
Checks if the specified string contains a valid ledger secret.
Checks if the specified string contains a valid secret.
### Parameters
@@ -5150,7 +5150,7 @@ return api.isValidSecret("secret")
## deriveKeypair
`deriveKeypair(seed: string) : {privateKey: string, publicKey: string}`
`deriveKeypair(seed: string): {privateKey: string, publicKey: string}`
Derive a public and private key from a seed.
@@ -5172,7 +5172,7 @@ var private_key = keypair.privateKey;
## deriveAddress
`deriveAddress(publicKey: string) : string
`deriveAddress(publicKey: string): string`
Derive an XRP Ledger address from a public key.

2
docs/src/deriveAddress.md.ejs
View File

@@ -1,6 +1,6 @@
## deriveAddress
`deriveAddress(publicKey: string) : string
`deriveAddress(publicKey: string): string`
Derive an XRP Ledger address from a public key.

2
docs/src/deriveKeypair.md.ejs
View File

@@ -1,6 +1,6 @@
## deriveKeypair
`deriveKeypair(seed: string) : {privateKey: string, publicKey: string}`
`deriveKeypair(seed: string): {privateKey: string, publicKey: string}`
Derive a public and private key from a seed.

6
docs/src/isValidAddress.md.ejs
View File

@@ -1,12 +1,12 @@
## isValidAddress
`isValidAddress(address: string) : boolean
`isValidAddress(address: string): boolean`
Checks if the specified string contains a valid ledger address.
Checks if the specified string contains a valid address.
### Parameters
This method takes one parameter, the address which to validate.
This method takes one parameter, the address to validate.
### Return Value

4
docs/src/isValidSecret.md.ejs
View File

@@ -1,8 +1,8 @@
## isValidSecret
`isValidSecret(secret: string) : boolean
`isValidSecret(secret: string): boolean`
Checks if the specified string contains a valid ledger secret.
Checks if the specified string contains a valid secret.
### Parameters