Elliot Lee
4ab808b6de
Deprecate submit() in favor of request('submit', {...}) ( #1294 )
...
Using request('submit', ...) allows the ripple-lib API to be effectively
identical to the underlying rippled API. Whereas submit() returns only
certain fields from rippled, using request('submit') gives you rippled's
full response, including the new fields added in rippled v1.5.0.
2020-06-09 09:04:01 -07:00
Yusuf Şahin HAMZA
be961fb9a7
Fix generateXAddress example ( #1286 )
2020-05-08 19:36:12 -07:00
Elliot Lee
851d84bde8
Update docs
2020-05-07 00:06:02 -07:00
Elliot Lee
854c4ebfdd
Update Transaction Streams link ( #1278 )
2020-05-06 14:55:44 -07:00
Elliot Lee
bc352c4cf0
Document computeBinaryTransactionHash
2020-04-28 23:29:46 -07:00
Elliot Lee
6cabb2e935
Release 1.7.0
2020-04-28 14:34:49 -07:00
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
7c6b8398cf
Improve documentation for generateXAddress() ( #1169 )
...
It takes an optional property for including the classic address in the
return payload
Co-authored-by: Elliot Lee
2020-01-13 23:39:02 -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
Hans Bergren
eea20a6eab
Improve documentation for address generation ( #1158 )
...
The documentation previously just stated that any array of integers
was acceptable for providing as entropy, but it must be an array of
length 16 where the values are from 0-255 (uint8) to ensure we have
16 bytes of entropy.
2020-01-08 18:30:08 -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
7a027bdd93
Update README ( #1111 )
2019-12-14 10:24:05 -08:00
RareData
5f92b230aa
Add support for WalletLocator ( #1083 )
...
Being able to fetch the WalletLocator field opens up new use-cases. The field can store for example a transaction hash, referencing a transaction with memos containing useful data.
2019-12-11 23:47:41 -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
RareData
8ebad98912
Add support for tick size ( #1090 )
2019-11-14 20:13:58 -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
Sohail Salehi
eb521faa8d
Doc update for sign() method ( #1010 )
...
* Add multi-signing example to the sign() method
Explains why the `signAs` option is compulsory for multi-signing scenarios.
2019-10-08 11:59:12 -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
c5b1d4daac
Update lodash to ^4.14.136, fix docs typo, update HISTORY.md
2019-08-07 12:20:56 -07:00
mDuo13
7ca7a07942
Phrasing cleanup in schema descriptions
...
- Change 'Ripple address'→'XRP Ledger address'
- Change 'is exclusive with'→'cannot be used with'
2019-07-15 14:26:43 -07:00
Elliot Lee
1be2ee5875
Docs: fix #574 ( #1011 )
...
destination.address
2019-06-14 14:57:14 -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
7df2b74d43
Update get-server-info.json
2019-05-27 14:37:38 -07:00
Elliot Lee
4da80028bf
Prevent prepareTransaction from overwriting values in txJSON ( #1000 )
...
Fix #997
2019-04-13 11:33:16 -07:00
Elliot Lee
d82703f41b
prepareTransaction should not overwrite Sequence ( #990 )
...
* Cleans up some code and fixes some type errors
* Clarify how null settings work
* Document updated RippledError
* Updates per review by @mDuo13
2019-03-18 15:55:42 -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
Alexandru Chiriac
5419e67dbc
GetLedger by hash option ( #980 )
...
* update ledger input schema
* include ledgerHash option
2018-12-12 11:02:50 -08:00
Alexandru Chiriac
8d37da0952
Update Submit Response ( #978 )
...
* update submit output schema
* update submit response object
2018-12-04 15:35:07 -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
Scott M Sunarto
b15abd5376
Update server regex to accommodate UDS ( #944 )
2018-09-18 11:47:46 -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
dbe20d6574
getLedger: include raw transaction with each transaction
...
computeLedgerHash: support new getLedger response by using
rawTransaction
BREAKING CHANGES:
* Remove the `rawTransactions` field and replace it with a new `rawTransaction` field in each transaction.
* Rename the `metaData` field (in each raw transaction) to `meta` (for consistency with rippled's `tx` method).
* Add `ledger_index` to each raw transaction.
2018-08-30 13:28:52 -07:00
Elliot Lee
0550fab73e
Update escrowCreation error message and docs ( #934 )
...
Fix #933
2018-08-29 19:03:33 -07:00