Elliot Lee
de3e2a9867
Docs: Fix whitespace
...
Do not use newline-trimming ending tag
Fix #1175 (bug introduced in #1153 )
2020-01-17 15:24:23 -08:00
Hans Bergren
e10df203b7
Update documentation for functions that can be called offline ( #1159 )
...
You can also generate an X-Address without a connection to the ledger.
2020-01-09 10:33:12 -05:00
FKSRipple
85a8ab32ef
update docs dependencies ( #1153 )
2020-01-07 15:30:29 -08:00
FKSRipple
53afa8c276
Merge pull request #1121 from r0bertz/develop
...
Document message type 'path_find' that connection can listen on
2020-01-07 11:34:57 -08:00
Elliot Lee
138e7942da
Add support for AccountDelete ( #1120 )
...
https://xrpl.org/accountdelete.html
2020-01-06 04:01:10 -08:00
Robert Zhang
932be02e9e
Document message type 'path_find' that connection can listen on
2019-12-21 20:01:00 -08:00
Elliot Lee
29bc5303ae
Fix tests ( #1109 )
...
* Revert "[docs] Update getTransactions example request/response (#1106 )"
This reverts commit 5314e5e7e9 .
* Redo #1106 but with passing tests
2019-12-11 22:54:33 -08:00
Elliot Lee
5314e5e7e9
[docs] Update getTransactions example request/response ( #1106 )
2019-12-11 14:45:04 -08:00
Elliot Lee
14ec58ef9a
Fix link
2019-11-14 21:00:33 -08:00
Elliot Lee
8f4f6f3de0
Release 1.4.2
2019-11-14 20:50:29 -08:00
Elliot Lee
f8c0ac3ce0
Update docs
...
* Add tickSize parameter
* Fix formatting
2019-11-14 20:38:40 -08:00
mDuo13
f158390ba1
getAccountObjects doc fix
...
Add necessary blank line for the list to render properly. (xrpl.org's
Markdown parser won't recognize the list without it.)
2019-10-29 14:23:10 -07:00
Elliot Lee
e1964ac5ed
Add support for the X-address format ( #1041 )
...
* Update schema-validator
* Update to ripple-address-codec 4.0.0
* Update ./src/common/hashes/index.ts
* Add generateXAddress method
* Deprecate generateAddress method
* Add unit tests
* Add documentation
2019-10-23 12:03:59 -07:00
Elliot Lee
1d7cb41218
Add rippleTimeToISO8601.md.ejs
2019-09-04 00:31:02 -07:00
Elliot Lee
1a685e2b68
Fix #1032 ( #1033 )
...
* Update ripple-address-codec@latest
* Export and document rippleTimeToISO8601
2019-09-03 16:38:56 -07:00
Rome Reginelli
9c561885a1
Docs: update recommended Node ver. ( #1031 )
2019-08-29 20:34:25 -07:00
Elliot Lee
e2572c61cf
Add details about transaction fees, master keys, and multi-signing
2019-06-05 00:27:25 -07:00
Elliot Lee
5bf6f1849a
Fix typos in docs
2019-03-12 15:27:19 -07:00
Rome Reginelli
68735ddb35
Docs: Fix prepareTransaction method specification ( #986 )
2019-02-11 23:39:41 -08:00
Elliot Lee
2445004333
Change prepare* methods to reject Promise on error ( #984 )
...
* Reject Promise on error, update docs, and add tests:
* preparePayment
* prepareTrustline
* prepareOrder
* prepareOrderCancellation
* prepareSettings
* prepareEscrowCreation
* prepareEscrowExecution
* prepareCheckCreate
* prepareCheckCash
* prepareCheckCancel
* preparePaymentChannelCreate
* preparePaymentChannelFund
* preparePaymentChannelClaim
Note that we can't update mocha to ^5.2.0 because it causes testing to hang indefinitely; this needs to be investigated.
2019-01-29 15:22:18 -08:00
Elliot Lee
0f5056221f
Fix getOrderbook ( #970 )
...
* Fix `getOrderbook` (Fix #766 )
* Add `formatBidsAndAsks` as a recommended alternative to `getOrderbook`
* Add `renameCounterpartyToIssuer`
2018-11-26 15:25:15 -08:00
Elliot Lee
418987476e
Add DepositPreauth ( #958 )
...
* Expose parseAccountFlags() and add docs
* Add example snippet
* Default to node v10 for nvm
* Maintain existing behavior for getSettings
* Increase max line length from 80 to 120 (ter-max-len)
2018-10-31 16:27:32 -07:00
Elliot Lee
5fed1f08e4
Document xrpToDrops, dropsToXrp, iso8601ToRippleTime, schemaValidator, and more
...
The following methods are available directly under the RippleAPI object,
not under schemaValidator:
isValidAddress, isValidSecret, deriveKeypair, deriveAddress
2018-10-18 01:16:50 -07:00
Elliot Lee
37edede728
Use object instead of Object ( #936 )
2018-10-02 02:13:28 -07:00
Elliot Lee
79971f906b
Update release notes
2018-09-11 18:45:52 -07:00
Mo Morsi
34215eb309
Add docs for newly exposed API methods
2018-09-09 09:39:25 -04:00
Elliot Lee
09541dae86
docs: rippled APIs use issuer
2018-08-30 14:12:45 -07:00
Elliot Lee
0550fab73e
Update escrowCreation error message and docs ( #934 )
...
Fix #933
2018-08-29 19:03:33 -07:00
Elliot Lee
181cfd69de
Prevent 'amount' from being misinterpreted ( #924 )
...
The 'amount' field should almost never be used.
With partial payments, the field can show an amount that is
significantly less than the amount that the transaction actually
delivered. This change sets amount to 0 XRP when it may be misleading.
This change omits the `amount` when parsing payment transactions.
See `HISTORY.md` for recommended alternatives.
2018-08-23 16:17:23 -07:00
Elliot Lee
569766b8f8
Rename json schemas ( #931 )
...
Rename files for consistency with their titles:
* Rename amount-base to amountbase
* Rename tx-hash to transaction-hash
* Rename id to transactionHash
* Rename objects/settings.json to objects/settings-plus-memos.json
* Rename ledgerversion to ledger-version
2018-08-22 14:41:41 -07:00
Elliot Lee
53a232ebdc
Update docs
2018-08-14 20:05:50 -07:00
Elliot Lee
4c9a2ff538
Improve Order docs. Fix #776
2018-08-14 19:27:50 -07:00
Elliot Lee
14704eee6b
Add more tests of getFee ( #897 )
2018-07-25 01:53:27 -07:00
Elliot Lee
e07fa11923
Maximum fee values ( #902 )
...
* Add maxFeeXRP (default 2 XRP) as an optional RippleAPI constructor parameter
- No calculated or specified fee can exceed this value
- If the fee exceeds 2 XRP, throw a ValidationError
* sign() - throw ValidationError when Fee exceeds maxFeeXRP
* Document getFee parameters
* Explain new fee limits in HISTORY.md
* Deprecate `maxFee`
2018-06-07 23:29:24 -07:00
Elliot Lee
d55aa2339f
Improve docs (raw order data)
2018-05-24 20:02:45 -07:00
Daniel Davis
65d8260908
Updated yarn command ( #900 )
...
`yarn install` deprecated in favor of `yarn add`
2018-05-23 23:05:09 -07:00
Elliot Lee
1aa9feda71
Allow specifying amounts in drops ( #892 )
...
* Accept "drops" in lieu of "XRP"
* Export xrpToDrops() and dropsToXrp()
* Throw our own validation errors instead of BigNumber Errors
2018-05-21 13:19:18 -07:00
Elliot Lee
b2b6715ac0
Add request(), hasNextPage(), and requestNextPage() ( #887 )
...
* Add support for all rippled APIs, including subscriptions.
* Add support for arbitrary stream message types.
* Note that rippled APIs take amounts in drops.
* request() will be available in ripple-lib version 1.0.0+
2018-05-10 15:43:56 -07:00
Elliot Lee
f28ec27614
getOrderbook - return raw order data ( #886 )
...
Fix #799
2018-05-08 15:05:41 -07:00
Elliot Lee
e978ef1888
Add getAccountObjects ( #881 )
...
Squashed commit of the following:
commit 361ead8cbbbe4fa25ecba614f8f11930ff679996
commit 5ff26d7d2defbbaaa7c50d6b3b5b74bf30be19ef
commit 97f5dfc86d4730082fd016197b0c025e499912e3
commit d48654098601f2a19484d9bbae7c65786e3c5dd4
commit 4790401123e7836f6bea8d03111bce60dcf95114
commit 57512f7fc000689bb8224f33173ba91221f27281
commit e75a7e95b11368b26c40e8e6e7b583d978475e95
2018-04-11 14:37:37 -07:00
amougel
2570e2a6d8
Add signWithKeypair ( #769 )
2018-04-03 15:33:24 -07:00
mDuo13
8eba827d11
Improve Payment Channel documentation
2018-03-28 11:54:05 -07:00
Elliot Lee
27ab98160a
Fix link to checkCash ( #871 )
...
Fix source file for 4eaaa8188d
2018-03-19 14:41:18 -07:00
Elliot Lee
facc513a52
Add support for Checks ( #853 )
...
- See https://github.com/ripple/rippled/pull/2245
* Add support for depositAuth flag
* Upgrade ripple-binary-codec to 0.1.13
2018-03-01 21:42:46 -08:00
Elliot Lee
6d39e072f8
Docs: getFee() returns a string
2018-01-23 16:13:27 -08:00
Elliot Lee
cc1ab7ae97
Update references of npm to yarn
2017-11-03 15:30:41 -07:00
Elliot Lee
ec2100094a
Docs: Specify Node 6.11.3
...
- Add .nvmrc and update HISTORY.md
2017-09-27 15:45:50 -07:00
mDuo13
50db68dff7
Fix case-sensitive broken link for preparePaymentChannelClaim
2017-09-01 15:12:58 -07:00
mDuo13
c61a15e4f3
Fix 'Paymment' typo
2017-09-01 14:50:02 -07:00
mDuo13
ed62b20645
Rebrand 'Ripple Consensus Ledger' to 'XRP Ledger'
2017-07-31 14:05:40 -07:00