xrpl.js

1.0.0-beta.5 (2018-08-11)

• Fix a TypeScript error by importing the Prepare type

1.0.0-beta.4 (2018-08-10)

• Add prepareTransaction()
• Internal improvements and cleanup

1.0.0-beta.3 (2018-07-17)

• For payment channel transactions, getTransaction includes a new
  channelChanges property that describes the details of the payment channel.
  (#920)

Bug Fixes

• A bug caused calculated fees to use too many decimal places. This was fixed by
  rounding fees to 6 decimal places. (#912)
• When using the Settings transaction to set up a multi-signing list, the
  threshold and weights fields are required. (#909)
• Docs: Fix the MIMETYPE in examples with memos. (#914)

1.0.0-beta.2 (2018-06-08)

Breaking Changes

• During transaction preparation, there is now a maximum fee. Also, when a transaction is signed, its fee is checked and an error is thrown if the fee exceeds the maximum. The default maxFeeXRP is '2' (2 XRP). Override this value in the RippleAPI constructor.
• Attempting to prepare a transaction with an exact fee higher than maxFeeXRP causes a ValidationError to be thrown.
• Attempting to sign a transaction with a fee higher than maxFeeXRP causes a ValidationError to be thrown.
• The value returned by getFee() is capped at maxFeeXRP.

Other Changes

• In Transaction Instructions, the maxFee parameter is deprecated. Use the maxFeeXRP parameter in the RippleAPI constructor.

Overview of new fee limit

Most users of ripple-lib do not need to make any code changes to accommodate the new soft limit on fees. The limit is designed to protect against the most severe cases where an unintentionally high fee may be used.

• When having ripple-lib provide the fee with a prepare* method, a maximum fee of maxFeeXRP (default 2 XRP) applies. You can prepare more economical transactions by setting a lower maxFeeXRP, or support high-priority transactions by setting a higher maxFeeXRP in the RippleAPI constructor.
• When using sign with a Fee higher than maxFeeXRP, a ValidationError is thrown.

If you have any questions or concerns, please open an issue on GitHub.

1.0.0-beta.1 (2018-05-24)

Breaking Changes

• Amounts in drops and XRP are checked for validity. Some
  methods may now throw a BigNumber Error or ValidationError if the amount
  is invalid. This may include methods that previously did not throw.
  • Note that 1 drop is equivalent to 0.000001 XRP and 1 XRP is equivalent to 1,000,000 drops.
  • Using drops is recommended. All rippled APIs require XRP amounts to be
    expressed in drops.

Other Changes

• Allow specifying amounts in drops for consistency with the rippled APIs.
  • Export xrpToDrops() and dropsToXrp() functions.
• Potentially breaking change: Improve errors. For example, RippledError now includes the full response from
  the rippled server (#687). NotConnectedError
  may be thrown with a different message than before.

1.0.0-beta.0 (2018-05-10)

• Add request, hasNextPage, and requestNextPage.
  • This provides support for all rippled APIs, including subscriptions.
  • Note that rippled APIs take and return XRP amounts in drops (1 drop = 0.000001 XRP).

0.22.0 (2018-05-10)

• getOrderbook - return raw order data. The full BookOffer data is now provided under data.

0.21.0 (2018-04-11)

• Upgrade https-proxy-agent
• Add getAccountObjects

0.20.0 (2018-04-09)

• Add support for using a keypair with sign()
• Fix a bug caused by jsonschema v1.2.3 by pinning to v1.2.2
• Improve Payment Channel documentation

0.19.1 (2018-03-22)

• Fix: Include TypeScript declarations in npm package
• Fix: Documentation link to checkCash
• Internal: Clean up types and migrate more APIs to new request method
• Internal: Fix Payment source and destination types

0.19.0 (2018-03-02)

• Add support for Checks
• Add support for the Deposit Authorization account root flag
• Generate .ts.d TypeScript declaration files
• Improve documentation of getTransactions params
• Add new request interface (private for now)

0.18.2 (2018-02-13)

• Fix: Publish updated browser builds to npm so that users can easily use
  CDNs
• Fix: Browserify fails due to dependency on ws
• Fix: build script fails when node_modules is in path
• Reduce size of published npm package
• Clean up files from Flow (we migrated to TypeScript)
• Typos and code cleanup

Note: A version of RippleAPI built for the browser has been attached to this release. SHA-256 checksums of these files are in HISTORY.md. This can be used when using RippleAPI in a browser; to use it with Node.js, continue to use npm. (#824)

0.18.1 (2018-01-27)

• Fix: isSameIssue() should check counterparty. This bug caused getOrderbook() to return incorrect values.

This release also includes the changes from 0.18.0:

0.18.0 (2018-01-25)

• Convert from Flow to TypeScript
• Use ES Module syntax (Babel still compiles these to common.js modules for
  distribution)
• Docs: Improve escrow creation example/test
• Fix type errors
• Fix lint errors

New: A version of RippleAPI built for the browser has been attached to this release. This can be used when using RippleAPI in a browser; to use it with Node.js, continue to use npm. (#824)

0.17.9 (2017-11-14)

• Update ws dependency to 3.3.1
• Remove unnecessary polyfills
• Fix lint errors (#786, #808)
• Update ripple-keypairs dependency to 0.10.1

0.17.8 (2017-11-06)

• Fix: Freezing in Safari 10.1 (updated bignumber.js) (closes #762)
• Fix: getSettings should include signers
• Update for Node 6
• Update lodash dependency
• Migrate to yarn

replace AJV with jsonschema

Fixes

e17b6f1 [FIX] on connect return error if server doesn't have validated ledgers