diff --git a/APPLICATIONS.md b/APPLICATIONS.md index ebee6337..32b5837b 100644 --- a/APPLICATIONS.md +++ b/APPLICATIONS.md @@ -1,6 +1,6 @@ -# Applications using ripple-lib (RippleAPI) +# Applications using xrpl.js -A curated list of some of the projects and apps that leverage `ripple-lib` in some way. +A curated list of some of the projects and apps that leverage `xrpl.js` in some way. **Have one to add?** Please edit this file and open a PR! @@ -53,7 +53,7 @@ Warning: Use at your own risk. - **[XRP Scan - XRP Ledger explorer](https://xrpscan.com)** XRP Ledger explorer, metrics and analytics. - + - **[xrplorer](https://xrplorer.com)** XRP Ledger explorer, API, metrics, and analytics using a graph database that is synchronized live with the XRPL. @@ -132,7 +132,7 @@ Warning: Use at your own risk. - **[XRP Faucets for Testnet and Devnet](https://xrpl.org/xrp-testnet-faucet.html)** - Get some test funds for development on the test network. The faucet uses `ripple-lib`. + Get some test funds for development on the test network. The faucet uses `xrpl.js`. ## Code samples and libraries @@ -156,7 +156,7 @@ Warning: Use at your own risk. For about $30 in parts (Raspberry Pi, 3.3V Relay board and a few wires) you can build your own power switch that will switch on if a streaming ILP payment comes in. When the payment stream stops, the power turns off. -## Related apps that do not appear to use ripple-lib +## Related apps that do not appear to use xrpl.js - **[XRP Stats](https://ledger.exposed/)** (ledger.exposed) diff --git a/README.md b/README.md index f0cb0b47..16d83597 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# ripple-lib (RippleAPI) +# xrpl.js -A JavaScript/TypeScript API for interacting with the XRP Ledger +A JavaScript/TypeScript library for interacting with the XRP Ledger -[![NPM](https://nodei.co/npm/ripple-lib.png)](https://www.npmjs.org/package/ripple-lib) +[![NPM](https://nodei.co/npm/xrpl.png)](https://www.npmjs.org/package/xrpl) This is the recommended library for integrating a JavaScript/TypeScript app with the XRP Ledger, especially if you intend to use advanced functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more. @@ -12,7 +12,7 @@ See the full reference documentation on the XRP Ledger Dev Portal. ## [➡️ Applications and Projects](APPLICATIONS.md) -What is ripple-lib used for? The applications on the list linked above use `ripple-lib`. Open a PR to add your app or project to the list! +What is xrpl.js used for? The applications on the list linked above use `xrpl.js`. Open a PR to add your app or project to the list! ### Features @@ -31,22 +31,22 @@ What is ripple-lib used for? The applications on the list linked above use `ripp See also: [RippleAPI Beginners Guide](https://xrpl.org/get-started-with-rippleapi-for-javascript.html) -In an existing project (with `package.json`), install `ripple-lib`: +In an existing project (with `package.json`), install `xrpl.js`: ``` -$ npm install ripple-lib +$ npm install xrpl ``` Then see the [documentation](#documentation). -### Using ripple-lib with React Native +### Using xrpl.js with React Native -If you want to use `ripple-lib` with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify). +If you want to use `xrpl.js` with React Native you will need to have some of the NodeJS modules available. To help with this you can use a module like [rn-nodeify](https://github.com/tradle/rn-nodeify). 1. Install dependencies (you can use `npm` as well): ```shell npm install react-native-crypto - npm install ripple-lib + npm install xrpl # install peer deps npm install react-native-randombytes # install latest rn-nodeify @@ -79,15 +79,15 @@ If you want to use `ripple-lib` with React Native you will need to have some of ... ``` -### Using ripple-lib with Deno +### Using xrpl.js with Deno -Until official support for [Deno](https://deno.land) is added, you can use the following work-around to use `ripple-lib` with Deno: +Until official support for [Deno](https://deno.land) is added, you can use the following work-around to use `xrpl.js` with Deno: ```javascript -import ripple from 'https://dev.jspm.io/npm:ripple-lib'; +import xrpl from 'https://dev.jspm.io/npm:xrpl'; (async () => { - const api = new (ripple as any).RippleAPI({ server: 'wss://s.altnet.rippletest.net:51233' }); + const api = new (xrpl as any).RippleAPI({ server: 'wss://s.altnet.rippletest.net:51233' }); const address = 'rH8NxV12EuV...khfJ5uw9kT'; api.connect().then(() => { @@ -106,7 +106,7 @@ import ripple from 'https://dev.jspm.io/npm:ripple-lib'; ### Mailing Lists -We have a low-traffic mailing list for announcements of new ripple-lib releases. (About 1 email per week) +We have a low-traffic mailing list for announcements of new xrpl.js releases. (About 1 email per week) + [Subscribe to ripple-lib-announce](https://groups.google.com/forum/#!forum/ripple-lib-announce) @@ -141,16 +141,10 @@ Run `npm run lint` to lint the code with `eslint`. ## Generating Documentation -Do not edit `./docs/index.md` directly because it is a generated file. - -Instead, edit the appropriate `.md.ejs` files in `./docs/src/`. - -If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running `npm run docgen`. +Update the documentation by running `npm run docgen`. ## More Information + [ripple-lib-announce mailing list](https://groups.google.com/forum/#!forum/ripple-lib-announce) - subscribe for release announcements + [RippleAPI Reference](https://xrpl.org/rippleapi-reference.html) - XRP Ledger Dev Portal + [XRP Ledger Dev Portal](https://xrpl.org/) - - [![Build Status](https://travis-ci.org/ripple/ripple-lib.svg?branch=master)](https://travis-ci.org/ripple/ripple-lib) diff --git a/SECURITY.md b/SECURITY.md index cdf6a417..594051c6 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,7 @@ ## Supported Versions -This table shows which versions of ripple-lib are currently supported with security updates: +This table shows which versions of xrpl.js are currently supported with security updates: | Version | Supported | | ------- | ---------------------- | diff --git a/package-lock.json b/package-lock.json index 9dfa7b47..a9632c25 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,10 +1,11 @@ { - "name": "ripple-lib", + "name": "xrpl", "version": "1.10.0", "lockfileVersion": 2, "requires": true, "packages": { "": { + "name": "xrpl", "version": "1.10.0", "license": "ISC", "dependencies": { diff --git a/package.json b/package.json index 23389fda..14806030 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "ripple-lib", + "name": "xrpl", "version": "1.10.0", "license": "ISC", "description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser", diff --git a/snippets/src/reliableTransactionSubmission.ts b/snippets/src/reliableTransactionSubmission.ts index 2f6bfe91..2b929f12 100644 --- a/snippets/src/reliableTransactionSubmission.ts +++ b/snippets/src/reliableTransactionSubmission.ts @@ -28,7 +28,7 @@ // * - https://xrpl.org/monitor-incoming-payments-with-websocket.html. // * // * For the implementation in this example, we have made the following decisions: -// * 1) The script will choose the account sequence and LastLedgerSequence numbers automatically. We allow ripple-lib to choose the fee. +// * 1) The script will choose the account sequence and LastLedgerSequence numbers automatically. We allow xrpl.js to choose the fee. // * Payments are defined upfront, and idempotency is not needed. If the script is run a second time, duplicate payments will result. // * 2) We will listen for notification that a new validated ledger has been found, and poll for transaction status at that time. // * Futhermore, as a precaution, we will wait until the server is 3 ledgers past the transaction's LastLedgerSequence diff --git a/test/localIntegrationRunner.html b/test/localIntegrationRunner.html index 9a44b2a2..68d7fef7 100644 --- a/test/localIntegrationRunner.html +++ b/test/localIntegrationRunner.html @@ -9,14 +9,14 @@
- + - +