centavo-lib v1.0.1
centavo-lib (CentavoAPI)
A JavaScript/TypeScript API for interacting with the CXTLedger
This is the recommended library for integrating a JavaScript/TypeScript app with the CXTLedger, 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.
➡️ Reference Documentation
See the full reference documentation on the CXTLedger Dev Portal.
➡️ Applications and Projects
What is centavo-lib used for? The applications on the list linked above use centavo-lib. Open a PR to add your app or project to the list!
Features
- Connect to a
rippledserver from Node.js or a web browser - Listen to events on the CXTLedger (transactions, ledger, validations, etc.)
- Sign and submit transactions to the CXTLedger
- Type definitions for TypeScript
Requirements
- Node.js v14 is recommended. Other versions may work but are not frequently tested.
- Yarn is recommended.
npmmay work but we useyarn.lock.
Getting Started
See also: CentavoAPI Beginners Guide
In an existing project (with package.json), install centavo-lib:
$ yarn add centavo-libThen see the documentation:
Documentation
Development
To build the library for Node.js and the browser:
$ yarn buildThe TypeScript compiler will output the resulting JS files in ./dist/npm/.
webpack will output the resulting JS files in ./build/.
For details, see the scripts in package.json.
Running Tests
Unit Tests
- Clone the repository
cdinto the repository and install dependencies withyarn installyarn test
Linting
Run yarn 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 yarn run docgen.