firmastation-restake-api

KO | EN

gitlite — search

#react #ai #typescript #golang #android #machine-learning #rust #linux #nodejs #java #windows #kubernetes #awesome-list #vue

firmastation-restake-api

(★ 10)

No description available.

firmastation-restake-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FirmaStation Restake API

## **Overview**
This project is an API server application that retrieves data saved in the database by the restake scheduler.

## **Features**
Firmastation Restake API Server provides the following functionalities using the GET method: query the last restake information, query all restake rounds, and query restake statistical data. These information is used in data queries in FirmaStation (Desktop, Mobile).

## **Build Instructions**
```bash
# Clone the repository
$ git clone https://github.com/FirmaChain/restake-api-server.git

# Move to the project directory
$ cd restake-api-server

# Install necessary packages
$ npm install

# Copy config.sample.ts file to config.ts
$ cp config.sample.ts config.ts
```

## **Environment Setup**
For the environment setup, you should first create the config.ts file by copying the config.sample.ts file, and then set appropriate values for the following variables.

- `PORT`: Specifies the port on which the server will run (e.g., 3000).

- `MONGODB_URI`: Specifies the URI of the MongoDB to be used.

- `MINIMUM_UFCT_REWARD_AMOUNT`: Specifies the minimum UFCT reward amount.

- `RESTAKE_FREQUENCY`: Specifies the restake frequency.

- `STATUS_ROUND_DATA_FILE_NAME`: Specifies the name of the status round data file ("statusRoundData.json").

## **Execution**
```bash
# Start the server (development mode)
$ npm run start:dev

# Start the server (production mode)
$ npm run start
```

## **Testing**
Here are some methods to check if the build has been successful.
```bash
# Query restake statistical data
$ curl -X GET http://localhost:3060/restake/info

# Query all restake rounds
$ curl -X GET http://localhost:3060/restake/status

# Query the last restake amount of the delegator
$ curl -X GET http://localhost:3060/restake/reward/:delegatorAddress
```

firmastation-restake-api

firmastation-restake-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

firmastation-restake-api

firmastation-restake-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README