https://github.com/filecoin-station/voyager-evaluate

Evaluate service
https://github.com/filecoin-station/voyager-evaluate

Last synced: 1 day ago
JSON representation

Evaluate service

• Host: GitHub
• URL: https://github.com/filecoin-station/voyager-evaluate
• Owner: filecoin-station
• License: other
• Created: 2024-03-07T13:44:31.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-04-22T11:39:55.000Z (9 months ago)
• Last Synced: 2024-04-22T12:54:56.488Z (9 months ago)
• Language: JavaScript
• Size: 126 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# voyager-evaluate

Evaluate service

- [Meridian spec](https://www.notion.so/pl-strflt/Meridian-Design-Doc-07-Flexible-preprocessing-1b8f2f19ca7d4fd4b74a1e57e7d7ef8a?pvs=4)

- [Meridian evaluate service](https://github.com/Meridian-IE/evaluate-service)

## Development

Set up [PostgreSQL](https://www.postgresql.org/) with default settings:

 - Port: 5432

 - User: _your system user name_

 - Password: _blank_

 - Database: voyager_stats

Alternatively, set the environment variable `$DATABASE_URL` with

`postgres://${USER}:${PASS}@${HOST}:${POST}/${DATABASE}`.

The Postgres user and database need to exist already, and the user

needs full management permissions for the database.

You can also run the following command to set up the PostgreSQL server via Docker:

```bash

docker run -d --name voyager-db \

  -e POSTGRES_HOST_AUTH_METHOD=trust \

  -e POSTGRES_USER=$USER \

  -e POSTGRES_DB=voyager_stats \

  -p 5432:5432 \

  postgres

```

## Run the tests

```bash

$ npm test

```

## Run the service

```bash

$ WALLET_SEED=$(cat secrets/mnemonic) npm start

```

## Troubleshooting

You can perform a dry-run evaluation of a given Meridan round using the script `bin/dry-run.js`.

At the moment, the script requires CID(s) of measurements to load. (In the future, we may discover

those CIDs from on-chain events.)

Example: evaluate round `273` of Meridian version `0x3113b83ccec38a18df936f31297de490485d7b2e` with measurements from CID `bafybeie5rekb2jox77ow64wjjd2bjdsp6d3yeivhzzd234hnbpscfjarv4z`.

```shell

❯ node bin/dry-run.js 0x3113b83ccec38a18df936f31297de490485d7b2e 273 bafybeie5rekb2jox77ow64wjjd2bjdsp6d3yeivhzzd234hnbpscfjarv4

```

## Deployment

```bash

$ git push

```