@nakji-network/connectorts
v0.0.1
Published
TypeScript library for building blockchain connectors on nakji network.
Downloads
8
Maintainers
Readme
ConnectorTS
ConnectorTS allows building connectors running on nakji network using TypeScript. A connector is a piece of software that either extracts blockchain data and transforms them to Protocol Buffer type and pushes them, or directly listens to messages from nakji network.
Table of Contents
Getting Started
To get started with connectorTS, you can follow these steps:
Prerequisites
Make sure you have the following software installed on your system:
- Node.js (version 18 or higher)
- Typescript (version 4 or higher)
- ts-node (version 10 or higher)
- protoc (version 3 or higher)
- buf
- Docker
- docker-compose
Installing
- Add this library to your project:
npm -i connectorts
- Install the required dependencies:
npm install
Usage
Below you can find source connector examples running on Ethereum.
- Aave: Connector for Aave protocol
- Ethereum: Connector for blockchain-specific events such as block data and transactions
Contributing
Read our Contribution Guide
