Skip to content

Commit

Permalink
chore(readme): add missing indices
Browse files Browse the repository at this point in the history
  • Loading branch information
slowbackspace committed Nov 4, 2024
1 parent 9eac74f commit db63d94
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [2.3.1] - 2024-11-04

### Fixed

- Don't list unregistered stake addresses in `/governance/dreps/:drep/delegators`
- SQL optimization in `/governance/dreps/:drep/delegators`

## [2.3.0] - 2024-11-04

Expand Down
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ CREATE INDEX IF NOT EXISTS bf_idx_ma_tx_mint_ident ON ma_tx_mint USING btree (id
CREATE INDEX IF NOT EXISTS bf_idx_ma_tx_out_ident ON ma_tx_out USING btree (ident);
CREATE INDEX IF NOT EXISTS bf_idx_reward_rest_addr_id ON reward_rest USING btree (addr_id);
CREATE INDEX IF NOT EXISTS bf_idx_reward_rest_spendable_epoch ON reward_rest USING btree (spendable_epoch);
CREATE INDEX bf_idx_stake_address_raw ON public.drep_hash USING hash (raw);
CREATE INDEX bf_idx_stake_address_view ON public.drep_hash USING hash (view);
CREATE INDEX bf_idx_delegation_vote_addr_id ON delegation_vote USING HASH (addr_id);
```

### Experimental features
Expand All @@ -118,11 +122,12 @@ All Mithril-related endpoints are available under the `/mithril` path.
For list of available endpoints please visit https://mithril.network/doc/aggregator-api/.

To enable this experimental feature add following lines to your config:

```yaml
mithril:
enabled: true # ENV var BLOCKFROST_MITHRIL_ENABLED=true
aggregator: "https://aggregator.pre-release-preview.api.mithril.network/aggregator" # ENV var BLOCKFROST_MITHRIL_AGGREGATOR
snapshotCDN: "https://example.com/" # Optional, ENV var BLOCKFROST_MITHRIL_SNAPSHOT_CDN
enabled: true # ENV var BLOCKFROST_MITHRIL_ENABLED=true
aggregator: 'https://aggregator.pre-release-preview.api.mithril.network/aggregator' # ENV var BLOCKFROST_MITHRIL_AGGREGATOR
snapshotCDN: 'https://example.com/' # Optional, ENV var BLOCKFROST_MITHRIL_SNAPSHOT_CDN
```

Then you can simply query Mithril API using Blockfrost Backend:
Expand All @@ -133,7 +138,6 @@ curl localhost:3000/mithril/artifact/snapshots

If you set `mithril.snapshotCDN` option, then the response of `/artifact/snapshots` and `/artifact/snapshot/{digest}` endpoints is enhanced with additional link to the list of snapshot locations.


### Docker

We are hosting latest release of this software on Dockerhub. To run it using Docker:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "blockfrost-backend-ryo",
"version": "2.3.0",
"version": "2.3.1",
"description": "",
"keywords": [],
"license": "Apache-2.0",
Expand Down

0 comments on commit db63d94

Please sign in to comment.