Skip to content

Latest commit

 

History

History
133 lines (92 loc) · 3.2 KB

README.md

File metadata and controls

133 lines (92 loc) · 3.2 KB
Raw

Nanocurrency Workestrator

Nanocurrency Proof of Work RPC Gateway

About

The objective of this project is provide a robust gateway of the Nano Proof of Work, to give more performance, redundancy and consistency for Nanocurrency implementations.

This is done by allowing distribution of PoW between different workers concurrently, handling errors and caching works.

Stack

This project is made with Typescript and was designed to run on EDGE. It implements:

  • Hono: A small, simple, and ultrafast web framework for the Edges
  • Cloudflare Workers: a low cost, fast and scalable serverless environment
  • Durable Objects: allow us to cache Proof of Work with low latency in-memory.
  • D1: D1 is Cloudflare’s native serverless database

Running locally

First, copy the example.dev.vars to .dev.vars and edit the WORKER_URLS with your own workers list separated with comma. Example:

RPC_URLS = "https://pow-rpc.com,http://127.0.0.1:7076"

Install dependencies:

pnpm install

Run:

npm run dev

Manage Workers

Add a new worker:

curl --request PUT \
  --url "http://127.0.0.1:7090/workers" \
  --header "Content-Type: application/json" \
  --data '{
	"name": "my-nano-node",
	"url": "http://127.0.0.1:7076"
}'

List workers:

curl "http://127.0.0.1:7090/workers"

Delete a worker

curl --request DELETE "http://127.0.0.1:7090/workers/[id]"

Usage

To generate a proof of work, we use the JSON HTTP POST requests just like Nano Node RPC Protocol

curl --request POST \
  --url "http://127.0.0.1:7090" \
  --header "Content-Type: application/json" \
  --data '{
	"action": "work_generate",
	"hash": "DA112538B6566B5555725F724B281E013D7C5DE42498C71D9A1CD44B8AA0CD3A",
	"threshold": "fffffff800000000"
}'

Threshold is optional. When omitted, we use the SEND / CHANGE threshold by default.

JSON Response:

{
	"work": "000020c3204e1b6a",
	"hash": "DA112538B6566B5555725F724B281E013D7C5DE42498C71D9A1CD44B8AA0CD3A",
	"threshold": "fffffff800000000",
	"workerName": "my-worker-name",
	"workerId": 1,
	"startedAt": 1693983379659,
	"took": 1076,
	"cached": false
}

Deploying

Fist, you will need a Cloudflare account with Workers Paid plan enabled. Currently costs 5 USD / month

Then login to your Cloudflare account:

pnpm wrangler login

When in production, it is highly recommended to use the authentication key. Add the environments to your Cloudflare Worker:

pnpm wrangler secret put AUTH_KEY

Finally, deploy:

pnpm run deploy

Authenticated calls

You can use 2 different strategies

  • Header: "Authorization": "Bearer xxxxx"
  • URL Query: ?authKey=xxxxx

Donate Ӿ

If you find this project useful and want to support its development please consider donating: nano_3dqh8z8ncswmf7151gryu7mqpwbw4f68hi7d8g433omtuabfi438etyyp9ik