Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Permissionless-Software-Foundation/psf-slp-indexer
Indexer for validating SLP transactions. Uses LevelDB.
https://github.com/Permissionless-Software-Foundation/psf-slp-indexer
Last synced: about 1 month ago
JSON representation
Indexer for validating SLP transactions. Uses LevelDB.
- Host: GitHub
- URL: https://github.com/Permissionless-Software-Foundation/psf-slp-indexer
- Owner: Permissionless-Software-Foundation
- License: gpl-2.0
- Created: 2021-11-03T20:26:07.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-07T03:45:46.000Z (6 months ago)
- Last Synced: 2024-06-07T04:47:34.332Z (6 months ago)
- Language: JavaScript
- Size: 10.6 MB
- Stars: 11
- Watchers: 1
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-bitcoin-cash - [code - Functional SLP token indexer running token infrastructure for several businesses. (Simple Ledger Protocol (SLP Token) / Libraries)
README
# psf-slp-indexer
[](http://standardjs.com) [](https://github.com/semantic-release/semantic-release)
This application crawls the Bitcoin Cash (BCH) blockchain and indexes SLP token transactions. This code base is intended to be a replacement for [SLPDB](https://github.com/Permissionless-Software-Foundation/docker-slpdb). The work is based on [this report](https://gist.github.com/christroutner/77c46f1fa9adaf593074d41a508a6401) and the work was funded by [this Flipstarter](https://flipstarter.fullstack.cash/).
This indexer is one part of a collection of blockchain infrastructure. To understand how all the pieces fit together, read the [Cash Stack Documentation](https://cashstack.info).
If you have question or need help, ask in the [community support Telegram channel](https://t.me/psf_slp).
## Videos
- [Installing the psf-slp-indexer](https://youtu.be/5gF4ON9lRHI)
- [Additional Infrastructure Videos](https://psfoundation.cash/video/) in the 'Dev Ops & Infrastructure' section.
## Installation and Usage
This software is intended to be run inside a Docker container, controlled with Docker Compose, on a Ubuntu 20 OS.
- Enter the `production/docker` directory.
- Build the image with `docker-compose build --no-cache`
- Ensure you have a BCHN full node running and fully synced. [docker-bchn](https://github.com/Permissionless-Software-Foundation/docker-bchn) is recommended for running a full node.
- Start the indexer with `docker-compose up -d`
## Features
- Written in [standard JavaScript](https://www.npmjs.com/package/standard), using the [Clean Architecture](https://christroutner.github.io/trouts-blog/blog/clean-architecture) design pattern.
- 100% unit test coverage. This allows for operational reliability and easy code collaboration.
- [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) Licensed to encourage wide adoption and free use throughout the crypto ecosystem.
- [LevelDB](https://github.com/google/leveldb) used for fast, efficient indexing and querying.
- Drastically reduced memory usage, compared to SLPDB.
- Fast indexing using transaction maps.
- Docker container for easy deployment and horizontal scaling.
## Development Environment
**See the [developer documentation](./dev-docs) for more information.**
### Requirements
- Ubuntu Linux OS v20.4+
- node **^16.17.0**
- npm **^8.15.0**
### Dev Environment Installation
Customize the [slp-indexer.sh](./slp-indexer.sh) bash shell script to point to the a BCH full node with the standard JSON RPC. [docker-bchn](https://github.com/Permissionless-Software-Foundation/docker-bchn) is recommended for running a full node.
```
git clone https://github.com/Permissionless-Software-Foundation/psf-slp-indexer
cd psf-slp-indexer
npm install
./slp-indexer.sh
```
**See the [developer documentation](./dev-docs) for more information.**
## Usage
- `npm start` Start server on live mode
- `npm run docs` Generate API documentation
- `npm test` Run mocha tests
- `docker-compose build` Build a 'production' Docker container
- `docker-compose up` Run the docker container
## License
[GPLv2](./LICENSE.md)
## Contributing
Contribution are welcome! Check out the [Contribution guide](./CONTRIBUTING.md) for guidence on contributing to this repository.