tangle-hornet-api

command module
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 3, 2023 License: MIT Imports: 5 Imported by: 0

README

Tangle Hornet API

API written in Go to use Tangle Hornet Network.

How to use

Requirements

This library was mainly tested with Go version 1.20.x

We recommend you update Go to the latest stable version to use the library.

Downloading the API
  1. You can get the latest version of the API by clicking here;
  2. Give the permission to execute the API:
    sudo chmod +x tangle-hornet-api
    
  3. If you want to change some parameters, create a file named tangle-hornet.conf in the /etc/ directory;
    1. Check the tangle-hornet.conf to see all the parameters you can override.
  4. Run the API:
    ./tangle-hornet-api
    
Build the project on your own
  1. Clone this repository;
  2. Download all the dependencies:
    go mod tidy
    
  3. Execute the project:
    go run main.go
    

Endpoints

Method Enpoint Description
GET /nodeInfo Shows information about Tangle Hornet Network.
GET /nodeInfo/all Shows all information about Tangle Hornet Network.
GET /message/messageId/{messageId} Get a message by given message ID.
GET /message/{index} Get all messages using a specific index.
GET /message/{index}/{maxMessages} Get a maximum number of messages from the last hour, using a specific index.
POST /message Create and submit a new message.

You also can use the files in the apiClientFiles directory to import all routes into your API Client.

POST Body Examples
Routes
  • /message:
    {
      	"index": "LB_STATUS",
      	"data": {"available": true, "avgLoad": 3, "createdAt": 1695652263921, "group": "group4", "lastLoad": 4, "publishedAt": 1695652267529, "source": "source4", "type": "LB_STATUS"}
      }
    

License

The MIT license can be found here.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL