A TypeScript SDK for blockchain interactions using Sidehub.
Web3-Sidehub is a TypeScript SDK designed to facilitate blockchain interactions using various blockchain networks. It integrates with Ethereum via ethers and web3.js, as well as Solana through @solana/web3.js. This repository serves as a starting point for developers building blockchain applications with a unified SDK.
- TypeScript support for robust development.
- Integration with Ethereum and Solana blockchains.
- Ready-made scripts for building, running, and development using nodemon.
-
src/
: Contains the TypeScript source code. -
example.ts
: An example script demonstrating how to use the SDK. -
.env.example
: Example environment variables configuration. -
tsconfig.json
: TypeScript configuration file. -
package.json
: Contains project metadata and dependencies.
Ensure you have Node.js and npm installed. (Recommended version: Node.js 14.x or above)
Clone the repository and install dependencies:
git clone https://github.com/AmanUpadhyay1609/Web3_SIDEHUB.git
cd Web3_SIDEHUB
npm install
To compile the TypeScript code, run:
npm run build
After building, start the project using:
npm run start
For automatic recompilation and restart during development, run:
npm run dev
Rename .env.example
to .env
and fill in the necessary environment variables.
Contributions are welcome! Please follow the standard GitHub flow: fork the repository, create a new branch, and submit a pull request.
This project is licensed under the MIT License.
For any inquiries, please reach out to Aman Upadhyay.