shardeum / archive-server

The shardus archive-server

The Shardus Archiver

This is a node that runs as part of the shardus network, with the function of remembering the cycle chain and state data, depending on the app. Archiver nodes store the complete state and history of the network.

Releasing

To release, just run npm run release

Health Check

GET /is-alive this endpoint returns 200 if the server is running. GET /is-healthy currently the same as /is-alive but will be expanded.

Contributing

Contributions are very welcome! Everyone interacting in our codebases, issue trackers, and any other form of communication, including chat rooms and mailing lists, is expected to follow our code of conduct so we can all enjoy the effort we put into this project.

archive-server's Issues

Test Ticket 2

Create an in-depth documentation for the README.md file

Update the READM file in this repository to be more in-depth and cover the project in more detail.

A potential table of content for the file could look like:

• Overview of the project
• How to get started or local setup instruction
• Call out any specific configs or files that is a must-know for contributors
• How to contribute to the project, any special instructions

Function doing redundant work?

archive-server/src/ShardFunctions.ts

Line 161 in 30ef2fa

static calculatePartitionRangeInternal(

The third "if" statement seems like it will redo all the calculations in the first two.

(Also, could there be a case where there's a split range and we somehow wind up with "start < end" and we don't catch that? What would happen?)

Typo in variable name in some functions

archive-server/src/ShardFunctions.ts

Line 280 in 30ef2fa

static testAddressInRange(address: string, wrappableParitionRange: WrappablePartitionRange): boolean {

"Par[t]ition" with some (including this line), but not all, missing the marked t (and other cases in this file).