Loading repository dataβ¦
Loading repository dataβ¦
web3batman / repository
Rune Airdrop Backend (This π¦ repository contains the backend π§© services for the π Rune Airdrop π project, featuring a Swagger UI π for API π οΈ documentation π and π§ͺ testing)
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
The Runestone Airdrop Backend is a server application that facilitates the airdrop of Runestone tokens. The backend is developed using Node.js and Express.js and includes API endpoints for various functionalities such as redeeming fees, estimating transaction fees, and managing different amounts for airdrops. The project also integrates Swagger UI for API documentation.
root/
βββ config/
β βββ config.ts
βββ routes
β βββ AirdropRoute
β βββ different-amount.route.ts
β βββ large-different-amount.route.ts
β βββ large-different-amount-airdrop.route.ts
β βββ same-amount.route.ts
β βββ EstimateRoute
β βββ different-amount-estimate.route.ts
β βββ same-amount-estimate.route.ts
β βββ SubRoute
β βββ runestone-fee.route.ts
βββ service/
β βββ psbt/
β βββ CreateAirdropRunestonePsbt.ts
β βββ redeemRunestoneAmountRunestone.ts
β βββ redeemRunestoneSameAmount.ts
β βββ RuneOne.ts
β βββ RuneSub.ts
β βββ SameAmountEstimate.ts
βββ test/
β βββ CreateTest.ts
β βββ freeTierAirdrop.ts
β βββ matchTests.ts
β βββ MWtests.ts
βββ utils/
β βββ blockcypher.api.ts
β βββ mempool.api.ts
β βββ TS
β β βββ mw.ts
β β βββ TsUtils.ts
β βββ unisat.api.ts
βββ .env.example
βββ package.json
βββ README.md
βββ swagger.yaml
βββ tsconfig.json
βββ yarn.lock
env
Clone the repository:
git clone git clone https://github.com/leionion/rune-airdrop-backend.git
cd rune-airdrop-backend
Install dependencies:
yarn install
Create a .env file:
cp .env.example .env
Configure the environment variables in .env file:
PORT=your-port
Start the server:
yarn dev
The server should be running on the specified port. You can visit http://localhost:[PORT] to check if the server is up and running.
Access the API documentation via Swagger UI at http://localhost:[PORT]/api-docs.
Here are some key API endpoints provided by the backend:
cors package.body-parser and express.json.Swagger UI is integrated to provide interactive API documentation. The swagger.yaml file is required to configure API documentation, which can be accessed at /api-docs.
Mutex from async-mutex is used for API rate limit protection functionality.
app.locals.walletIndex: Global iterator for wallet management.app.locals.iterator: Global iterator for unisat API distribution.The base URL for the API is:
http://localhost:5000/apihttps://rune-airdrop-backend.onrender.com/api/different-amount/large-different-amount/large-different-amount-airdrop/same-amount/runestone-fee/estimate/different-amount/estimate/same-amountIn case of errors, the API responds with appropriate HTTP status codes along with error messages in the response body.