About The Project

creator-api is a reworked lightweight version of https://github.com/fbslo/creator for providing an API for HIVE account creation.

It works as an out-of-the-box solution for HIVE stakeholders, who like to provide a 3rd party access to their HIVE account creation tickets without the need to exposing any key.

Installation

• Fork the repository

git clone https://github.com/christianfuerst/creator-api

• Install frontend dependencies

cd creator-api
npm install

Configuration

• Create a new file config.json from the template file in the same folder

{
  "accounts": [
    {
      "account": "INSERT-HIVE-ACCOUNT",
      "key": "INSERT-HIVE-ACTIVE-KEY",
      "rcThreshold": 20,
      "autoClaimDelaySeconds": 60,
      "setPostingAccountAuth": false
    }
  ],
  "httpHost": "localhost",
  "httpPort": 8880,
  "rpc": [
    "https://api.hive.blog",
    "https://api.hivekings.com",
    "https://anyx.io",
    "https://api.openhive.network"
  ],
  "auth": [{ "key": "API-KEY", "label": "LABEL-FOR-AUTHORIZED-ENTITY" }],
  "debug": false
}

For production it's highly recommended to use a reverse proxy like Nginx and proxy the selected http port to a secure https connection.

Run

node server.js

How to Use

Remotly create an account (with default config)

Endpoint: http://localhost:8880/createAccount

Method: POST

Header: authority:API-KEY

Body:

{
  "name": "account_name",
  "publicKeys": {
    "active": "STM6Zh5jRNQt7AhVjWmKpG4FdrrquYEc5RZ9bA6r7WCcjtMF4bqDr",
    "memo": "STM6Usi2cv13tQSAhgwkjRdYCGo6WDEZ5uLiBaHZuNrFBdNHgJSMF",
    "owner": "STM863Fp3N7gQV2bk1XJKzpBS8SbMvUs89LqVAVzkSDfkjr6q6HDz",
    "posting": "STM5ikEMZgWiS36BcTEqMpwhSt6yYAhXPR3xoSqMnD1Wm7a7FsJd8"
  },
  "metaData": {
    "createdBy": "creator_name"
  },
  "creator": "account_name_creator",
  "creatorRequested": false
}

Dependencies

• @hivechain/dhive: Hive blockchain RPC client library
• body-parser: Node.js body parsing middleware
• cors: Node.js CORS middleware
• express: Fast, unopinionated, minimalist web framework
• lodash: Lodash modular utilities.
• signale: 👋 Hackable console logger