Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ernitingarg/irys-sdk-api-typescript
Backend API which internally uses Irys sdk functionality
https://github.com/ernitingarg/irys-sdk-api-typescript
arweave-blockchain expressjs irys sdk storage typescript
Last synced: about 4 hours ago
JSON representation
Backend API which internally uses Irys sdk functionality
- Host: GitHub
- URL: https://github.com/ernitingarg/irys-sdk-api-typescript
- Owner: ernitingarg
- Created: 2024-01-14T11:43:08.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-01-19T10:03:57.000Z (10 months ago)
- Last Synced: 2024-01-29T14:19:04.693Z (9 months ago)
- Topics: arweave-blockchain, expressjs, irys, sdk, storage, typescript
- Language: TypeScript
- Homepage: https://irys-sdk-api-typescript.vercel.app
- Size: 193 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# irys-sdk-api-typescript
Irys, formerly known as Bundlr, is a provenance layer on Arweave. It scales uploads to Arweave via bundling, lets you pay with different tokens than AR, and gives you strong provenance capabilities for your uploads.
## Prerequisite
```bash
npm init -y
npx tsc --init
npm install express multer dotenv
npm install @irys/sdk @irys/query
npm install --save-dev typescript @types/express @types/multer ts-node ts-node-dev @types/node nodemon @types/dotenv
```## Run locally
Note: Make sure to set environment variable 'PRIVATE_KEY' with wallet private key.
```
npm run start
OR
npm run start:dev
```## Vercel deplotment
```
npm run build
# commit and push the generated dist folder
```## Vercel URL
https://irys-sdk-api-typescript.vercel.app
## APIs
### GET /api/healthcheck
/api/healthcheck
![Healthcheck](attachments/healthcheck.png)### POST /api/upload
![Upload](attachments/upload.png)
### GET /api/query/irys/``
![Query](attachments/query.png)