Skip to content
This repository has been archived by the owner on Mar 12, 2022. It is now read-only.

Latest commit

 

History

History
81 lines (57 loc) · 3.53 KB

README.md

File metadata and controls

81 lines (57 loc) · 3.53 KB
Raw

Nano DPoW Service

A DPoW service requests proofs of work from the DPoW server. In order to prevent potential spam, we need to consider and evaluate each service individually.

Apply to use

Applications are currently closed due to a large number of registered services. For alternatives, check out the Nano Center discord server.

How to use

Using a middleware

The first option is to use the Betsy middleware to integrate DPoW easily into your application. This approach is recommended if any of the following apply to you:

  • You don't want to change your application's code
  • You need to use DPoW along with other work peers (more fallbacks than the server running the application)

Native integration

The second option is to integrate the DPoW API into your application's code.

You can request work using POST requests or websocket connections. We recommend using websockets, as some operating systems will perform an SSL handshake for each POST request, adding latency (at least 200 millisseconds).

  • POST requests should be sent to https://dpow-api.nanos.cc/service/. An example is provided.
  • Websocket connections should target wss://dpow-api.nanos.cc/service_ws/. An example is provided. You should try to keep the websocket connection alive.

Request

A request should be json-encoded and contain the following information:

{
  "user": "your_given_user",
  "api_key": "your_given_api_key",
  "hash": "nano_block_hash",
  "account": "nano_valid_account",
  "id": 100,
  "timeout": 5,
  "difficulty": "ffffffc000000000",
  "multiplier": 1.0
}

Description of the fields:

  • user + api_key - you should receive this information after being accepted to use DPoW
  • hash - this is the 64-character hash for which you need a proof of work. See the Nano documentation for more information
  • account (optional, advised) - sending an account is not required, but helps DPoW precache work for the next transaction, which means it will be faster to reply the next time. It is possible, but with a possibility of failure, to precache even without this field
  • id (optional) - the server will reply to the request with the same id. Useful when doing multiple requests asynchronously
  • timeout (optional, default 5) - time in seconds (rounded down) before the server replies with a timeout error message
  • difficulty (optional) - hex string without 0x. In case you need higher difficulty for your work. Maximum difficulty is 5x Nano base difficulty, minimum is Nano base difficulty.
  • multiplier (optional) - decimal number. Desired difficulty multiplier from Nano main network base difficulty. Overrides difficulty. Maximum is 5.0, minimum 1.0.

Response

A typical response from the server will be:

{
  "work": "8fe6b617f9dd1ae9",
  "id": 100,
}

id is only included if the request contained an id.

In case of an error, the response will be:

{
  "error": "Description of the error",
  "timeout": true
}

The timeout field is only included if the error was a timeout, making it easy to check e.g., in python:

if "timeout" in response: (...)

During normal operation, the only kind of error you should receive are timeout errors. Any other errors should only occur during setup. If you find another error during normal operation, please create a Github issue with the information.