Litescribe API

Node/JS wrapper for litescribe.io API

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

You can install the package using npm:

npm install litescribe-api

or using yarn"

yarn add litescribe-api

Usage example

import {
  getAddressBalance,
  getListOfSpendableUtxos,
  getMultiAssets,
  getInscriptions,
  searchByDomainName,
  getInscriptionOutput,
  getInscriptionDetailOutput,
  getInscriptionsOutputs,
  getLtc20Tokens,
  getTokenSummary,
  getTransferableList,
  getTransaction,
  getOrderStatus,
  createOrder,
} from 'litescribe-api';

or

import api from 'litescribe-api';

or

const api = require('litescribe-api');

Contributing

Contributions are welcome! If you find a bug or have an enhancement in mind, please follow these steps:

1. Fork the repository.
2. Create a new branch: git checkout -b feature/your-feature.
3. Make your changes and commit them: git commit -m 'Add some feature'.
4. Push to the branch: git push origin feature/your-feature.
5. Submit a pull request.

License

This project is licensed under the ISC License.

License

ISC License

Copyright (c) 2023, Jan Osio

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.