block-accounting/backend/README.md

NoNameBlockchainAccounting backend

Build

Locally

1. Install Go >= 1.22

curl -LO https://get.golang.org/$(uname)/go_installer && \
        chmod +x go_installer && \
        ./go_installer && \
        rm go_installer

2. Install docker:

output=$(which docker);
if [ -z "${output}" ]; then 
    sudo dnf remove docker \
                  docker-client \
                  docker-client-latest \
                  docker-common \
                  docker-latest \
                  docker-latest-logrotate \
                  docker-logrotate \
                  docker-selinux \
                  docker-engine-selinux \
                  docker-engine
    sudo apt -y install dnf-plugins-core
    sudo dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo
    sudo dnf install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
    sudo systemctl start docker
fi

3. Build it!:

make bin.build

4. Start the server:

make d.net && \
sudo docker compose up blockd-db -d && \
make run.debug

Or

make d.net && \
sudo docker compose up blockd-db -d && \
make run.local

Docker

Just run

make up

API

Request content type: application/json
Response content type: application/json

POST /join

Request body:

name (string, optional)
credentals (object, optional)
credentals.email (string, optional)
credentals.phone (string, optional)
credentals.telegram (string, optional)
mnemonic (string, required)

Example

Request:

curl --location 'http://localhost:8081/join' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Bladee The Grand Drainer",
    "credentals": {
        "email": "bladeee@gmail.com",
        "phone": "+79999999999",
        "telegram": "@thebladee"
    },
    "mnemonic":"airport donate language disagree dumb access insect tribe ozone humor foot jealous much digital confirm"
}'

Response:

{
    "token": "token-here"
}

POST /login

Request body:

mnemonic (string, required)

Example

Request:

curl --location 'http://localhost:8081/login' \
--header 'Content-Type: application/json' \
--data '{
    "mnemonic":"airport donate language disagree dumb access insect tribe ozone humor foot jealous much digital confirm"
}'

Response:

{
    "token": "token-here"
}

POST /organizations

Request body:

name (string, required)
address (string, optional) wallet_mnemonic (string, optional. if not provided, creators mnemonic will me used)

Example

Request:

curl --location 'http://localhost:8081/organizations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MTU0NTY4Mzg4NTAsInVpZCI6ImI2NmU1Mjk4LTU1ZTctNGIxNy1hYzliLTA0MzU3YjBlN2Q0ZSJ9.K1I0QoZEdDYK_HEsJ0PdWOfZ8ugTcPfLqy7fHhvK9nk' \
--data '{
    "name": "The Drain Gang Inc",
    "address": "Backsippestigen 22, 432 36 Varberg, Sweden"
}'

Response:

{
    "id": "dfac7846-0f0a-11ef-9262-0242ac120002"
}

GET /organizations

Request body:

cursor (string, optional)
limit (uint8, optional. Max:50, Default:50) offset_date (uint63, optional. time as unix milli)

Example

Request:

curl --location --request GET 'http://localhost:8081/organizations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MTU2MDIyNDMwOTEsInVpZCI6IjUyNTNkMzdjLTMxZDQtNDgxMi1iZTcxLWE5ODQwMTVlNGVlMyJ9.IKd-sM9cy5ehj0Scvbi3HPvhjnWD1MDl-POUlvVo9sA' \
--data '{
    "limit":10
}'

Response:

{
    "items": [
        {
            "id": "758787be-7c09-4bc5-950b-e41adaf9cc0d",
            "name": "ertyertyrtye",
            "address": "rtyrtyetyetry",
            "created_at": 0,
            "updated_at": 0
        },
        {
            "id": "eb691423-cd34-43b4-bb92-3bb3cd646e63",
            "name": "ertyertyrtye",
            "address": "rtyrtyetyetry",
            "created_at": 0,
            "updated_at": 0
        },
        {
            "id": "7840246b-a67b-4e7b-a26c-43a11c2baec9",
            "name": "ertyertyrtye",
            "address": "rtyrtyetyetry",
            "created_at": 0,
            "updated_at": 0
        },
        {
            "id": "79a649aa-dfc9-4009-9e04-1a3bdbf49959",
            "name": "ertyertyrtye",
            "address": "rtyrtyetyetry",
            "created_at": 0,
            "updated_at": 0
        },
        {
            "id": "d13ff660-9927-4d08-b679-146818c00d0c",
            "name": "ertyertyrtye",
            "address": "rtyrtyetyetry",
            "created_at": 0,
            "updated_at": 0
        }
    ],
    "pagination": {
        "next_cursor": "eyJpZCI6ImQxM2ZmNjYwLTk5MjctNGQwOC1iNjc5LTE0NjgxOGMwMGQwYyJ9",
        "total_items": 5
    }
}