GAFI-WHITELIST

Provide offchain-worker whitelist

Table of contents

• Quick Start
  • Requirements
  • Reference
  • Installation
• API
  • create
  • add
  • verify
  • get

Quick Start

 $ git clone https://github.com/grindytech/gafi-whitelist-ts
 
 $ cd gafi-whitelist
 
 $ yarn
 
 $ yarn start:dev

Requirements

OS: Linux

Development environment: NodeJs

Reference

Installation

API

create

example: https://whitelist.gafi.network/create

method: POST

Body: 
{
    "id": "3bf5f0bc42626c7c630507f607fe85b344f9b857579c0c9ffd322611b6cd1275",
    "whitelist": [
        "0x4a1fb7f41007295aa73476541986e12b976c47907e3bce162b835e46a9a3ff0b"
    ]
}

successResponse:
{
    "id": "3bf5f0bc42626c7c630507f607fe85b344f9b857579c0c9ffd322611b6cd1275",
    "whitelist": [
        "0x4a1fb7f41007295aa73476541986e12b976c47907e3bce162b835e46a9a3ff0b"
    ]
}

RequestField	Type	Description
id	string	64 characters
whitelist	[string]	list of valid address(hex string)

add

description: add new addresses to whitelist

example: https://whitelist.gafi.network/add

method: POST

Body:
{
   "id": "3bf5f0bc42626c7c630507f607fe85b344f9b857579c0c9ffd322611b6cd1275",
   "whitelist": [
       "0x58880deb6e45ea913801786036f0183d8357104647501dfec35c7eebca7a0406"
   ]
}


successResponse:
{
   "id": "3bf5f0bc42626c7c630507f607fe85b344f9b857579c0c9ffd322611b6cd1275",
   "whitelist": [
       "0x4a1fb7f41007295aa73476541986e12b976c47907e3bce162b835e46a9a3ff0b",
       "0x58880deb6e45ea913801786036f0183d8357104647501dfec35c7eebca7a0406"
   ]
}

RequestField	Type	Description
id	string	64 characters
whitelist	[string]	list of valid address(hex string)

verify

url: /verify?id={}&address={}

example: https://whitelist.gafi.network/verify?id=3bf5f0bc42626c7c630507f607fe85b344f9b857579c0c9ffd322611b6cd1275&address=0x4a1fb7f41007295aa73476541986e12b976c47907e3bce162b835e46a9a3ff0b

method: GET

successResponse: true/false

RequestField	Type	Description
id	string	64 characters
address	string	valid address(hex string)

get

url: /get?id={}

example: https://whitelist.gafi.network/get?id=3bf5f0bc42626c7c630507f607fe85b344f9b857579c0c9ffd322611b6cd1275
method: GET

successResponse:
{
   "id": "3bf5f0bc42626c7c630507f607fe85b344f9b857579c0c9ffd322611b6cd1275",
   "whitelist": [
       "0x4a1fb7f41007295aa73476541986e12b976c47907e3bce162b835e46a9a3ff0b",
       "0x58880deb6e45ea913801786036f0183d8357104647501dfec35c7eebca7a0406"
   ]
}

RequestField	Type	Description
id	string	64 characters