Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

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)