xpring-common-js

Xpring Common JavaScript

Xpring Common JavaScript Library provides common JavaScript functionality to all client side libraries in Xpring SDK (TS/JS version). This library is built to be consumed as a dependency to other libraries, rather than a standalone library.

Developers probably want to use one of the language specific libraries for Xpring SDK (TS/JS version), rather than consuming this library directly. However, developers with specific requirements for interacting with Xpring SDK may want to depend on this library.

Getting started

This library requires the Git submodules to be initialized and updated and depends on protobuf and gRPC-web. More about this in the "Building The Library" section.

Overview

Xpring Common JavaScript is composed of several classes:

• Wallet: Provides key management, address derivation, and signing / verify functionality.
• Signer: Provides utility functions for signing transactions.
• Serializer: Provides functionality for serializing Xpring Common JavaScript model objects for signing.
• Utils: Provides common utility functions.
• XrpUtils: Provides utility functions for working with XRP.

Contributing

Pull requests are welcome! To get started with building this library and opening pull requests, please see contributing.md.

Thank you to all the users who have contributed to this library!

License

Xpring SDK is available under the MIT license. See the LICENSE file for more info.