Nathan Nichols
b9b32eb3d2
docs: generate documentation with typedoc ( #1607 )
...
* docs: generate documentation with typedoc
2021-10-04 14:10:12 -04:00
Mayukha Vadari
62538a75b1
Switches from yarn to npm ( #1591 )
...
* remove yarn.lock
* reinstall with npm
* fix package.json
* update xrplf eslint
* fix all other instances of yarn
2021-10-04 14:10:11 -04:00
Mayukha Vadari
0b08de5956
Removes methods that were just rippled wrappers ( #1550 )
...
* remove getAccountInfo
* remove getAccountObjects
* remove getBalanceSheet (gateway_balances)
* remove getLedger
* remove getOrders (account_orders)
* remove getPaymentChannel (ledger_entry)
* remove getTransaction(s) (tx/account_tx)
* remove getSettings (account_info)
* remove getServerInfo (server_info)
* fix integ tests
* remove submit (also deprecated)
* fix integ tests
* add TODO
2021-10-04 14:10:09 -04:00
Nathan Nichols
8a815e17ca
Correctly export txFlags and accountSetFlags ( #1571 )
...
* fix: export txFlags and accountSetFlags
2021-09-09 08:52:07 -07:00
Nathan Nichols
ec121ee62d
docs: Add documentation for generateFaucetWallet() ( #1529 )
...
* docs: Add documentation for generateFaucetWallet()
2021-08-17 14:32:06 -05:00
Nathan Nichols
decc395e5b
docs: export and document asf Flags ( #1525 )
...
* docs: export and document asf Flags
2021-08-12 11:30:26 -07:00
Jackson Mills
8b79fe6ba1
Update sign docs with more info about keypairs ( #1523 )
...
* Add links to how to derive keypairs and examples of keypairs to the 'sign' docs
2021-08-11 13:01:53 -07:00
Rome Reginelli
4e49b6a99c
docs: edit style and update old URLs ( #1420 )
...
Use example.com instead of ripple.com
Co-authored-by: Elliot Lee <github.public@intelliot.com >
2021-07-27 16:15:56 -07:00
Aaron Huang
d941653477
fix: multisig example in documentation ( #1463 )
...
Co-authored-by: Elliot Lee <github.public@intelliot.com >
2021-07-27 10:33:27 -07:00
Elliot Lee
b7de3b0ea9
feat: minor improvement to docs ( #1251 )
2021-07-26 16:12:15 -07:00
Elliot Lee
aa081a4348
refactor!: remove deprecated ledger fields ( #1160 )
...
Per https://github.com/ripple/rippled/issues/3214
The following fields are deprecated and may be removed without further notice: accepted, hash (use ledger_hash instead), seqNum (use ledger_index instead), totalCoins (use total_coins instead).
2021-07-26 16:10:55 -07:00
Rome Reginelli
53f35b5a99
Update boilerplate ( #1459 )
...
- Suggest XRPLF's public cluster; this is a better starter experience since
it's full-history and blocks known scam accounts
- Update the Node.js compatibility language to match the README.
- Remove dated language about ES5/ES6 Promises.
- Re-gen docs (this seems to have added a memo field that was previously
modified in some other PR)
2021-07-14 17:05:54 -07:00
Elliot Lee
fa2385ee1c
feat: expose address codec methods ( #1386 )
...
Fix #1385
* docs: add classicAddressToXAddress and xAddressToClassicAddress static methods
2021-03-16 20:58:16 -07:00
Rome Reginelli
32718d583b
docs: add missing transaction type links ( #1378 )
...
https://github.com/ripple/ripple-lib/pull/1352 had empty placeholder links for a few transaction types. This adds those.
2021-03-03 16:07:03 -08:00
Matthew Rosendin
08b76fba22
docs: update transactions.md.ejs ( #1348 )
...
Co-authored-by: Elliot Lee <github.public@intelliot.com >
2021-02-22 19:46:11 -08:00
Elliot Lee
2642589ea4
fix: update link to subscribe page ( #1354 )
2021-02-22 19:42:07 -08:00
Elliot Lee
965dc4bd87
fix: allow connectionTimeout option to be customized ( #1355 )
...
- Ref #1044
- Fix #1174
- Fix #1196
2021-02-11 23:55:33 -08:00
Rome Reginelli
c9689ec2a8
docs: add missing transaction specifications ( #1352 )
...
Add the following missing specifications to the list of transactionType
specifications:
- Ticket Create
- Account Delete
- Deposit Preauth
Rearrange the transaction type specifications to be in alphabetical
order.
2021-01-25 09:09:10 -08:00
Elliot Lee
03655b4ed2
fix(tickets): rename docs/src/prepareTicket.md.ejs to prepareTicketCreate.md.ejs
...
- Add note that TicketBatch amendment is required and is not yet
activated
2020-11-24 09:43:35 -08:00
Rome Reginelli
dd4c6a0353
Improve descriptions of get-ledger response time fields. ( #1326 )
2020-11-23 19:58:54 -08:00
Javi
1c1a3fa583
fix(refactor): rename prepareTicket to prepareTicketCreate ( https://github.com/ripple/ripple-lib/pull/1324#discussion_r519027049 )
2020-11-08 09:53:17 +01:00
Javi
81dfd99642
fix(docs): Update docs
2020-11-06 11:23:14 +01:00
Javi
6b4fa159ea
fix(doc): docgen
2020-11-06 10:48:06 +01:00
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