https://github.com/demox-labs/aleo-record-scanner

An RPC (remote procedure call) for scanning Aleo records
https://github.com/demox-labs/aleo-record-scanner

Last synced: about 2 months ago
JSON representation

An RPC (remote procedure call) for scanning Aleo records

• Host: GitHub
• URL: https://github.com/demox-labs/aleo-record-scanner
• Owner: demox-labs
• Created: 2024-06-26T01:15:02.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-29T06:01:56.000Z (7 months ago)
• Last Synced: 2024-06-29T07:21:55.069Z (7 months ago)
• Language: TypeScript
• Size: 456 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Installation & Running

1. Install [docker desktop](https://www.docker.com/products/docker-desktop/).

2. Install [Postgres](https://www.postgresql.org/download/).

3. Install protobuf: ` brew install protobuf`.

4. Rename `.env.example` to `.env`.

5. Run `yarn && yarn install`.

6. Start the local aleo database inside of a docker container: `yarn local-db-up`.

7. Apply database migrations: `yarn migrate`.

8. Run `yarn start:dev`.

Tests:

Run `yarn test`.

## Examples

### Get Height 

```

curl --location --request POST 'localhost:3000' \

--header 'Content-Type: application/json' \

--data-raw '{

    "jsonrpc": "2.0",

    "id": 1,

    "method": "getHeight"

}'

```

>>>

```

{

    "jsonrpc": "2.0",

    "id": 1,

    "result": {

        "height": "120087"

    }

}

```