Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weavevm/wvm-gateway
ARIO Arweave gateway for weaveVM
https://github.com/weavevm/wvm-gateway
arweave gateway wvm
Last synced: 5 days ago
JSON representation
ARIO Arweave gateway for weaveVM
- Host: GitHub
- URL: https://github.com/weavevm/wvm-gateway
- Owner: weaveVM
- License: agpl-3.0
- Created: 2023-12-22T22:26:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2023-12-22T22:53:44.000Z (11 months ago)
- Last Synced: 2023-12-23T01:38:13.917Z (11 months ago)
- Topics: arweave, gateway, wvm
- Language: TypeScript
- Homepage: https://wvm-gateway.xyz
- Size: 1.85 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## About
This repository is an implementation of the [ar-io-node](https://github.com/ar-io/ar-io-node) gateway's codebase, offering a tailored implementation designed to provide the weaveVM (WVM) with scalability and high-performance access to the Permaweb.
## Gateway base endpoint: https://wvm-gateway.xyz/
## Dev Workflow
```console
yarn install // install dependencies
yarn db:migrate up // initialize the SQLite DB
yarn lint:check // run lint check
yarn test // run the tests
yarn start
```
Starting at an arbitrary block (only works immediately after initial DB
migration):
`START_HEIGHT=888888 yarn start`
## Dev Docs
## Docker
### Standalone AR.IO Node
You can run the ar.io gateway as a standalone docker container:
```shell
docker build . -t ar-io-core:latest
docker run -p 4000:4000 -v ar-io-data:/app/data ar-io-core:latest
```
To run with a specified start height (sets height on first run only):
```shell
docker run -e START_HEIGHT=800000 -v $PWD/data/:/app/data ar-io-core:latest
```
### Envoy & AR.IO Node
You can also run [Envoy] along side an `ar.io` node via [Docker Compose]. Envoy
will proxy routes to `arweave.net` not yet implemented in the ar.io node.
```shell
docker compose up --build
```
or:
```shell
docker-compose up --build
```
Once running, requests can be directed to Envoy server at `localhost:3000`.
## Credits
This repository is an implementation of the [ar-io-node codebase](https://github.com/ar-io/ar-io-node) and is licensed under the [GNU License](./LICENSE)