Skip to content

Commit

Permalink
feat/refactor(release): 0.1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
1000101 committed Mar 12, 2021
1 parent b5c1cec commit f2828ae
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 12 deletions.
14 changes: 9 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- `/assets/{asset}/txs` call to list all transactions of a given asset
- `/assets/{asset}/txs` endpoint to list all transactions of a given asset
- Owners to `/txs/{hash}/pool_updates` endpoint

### Changed

- Altered functionality and description of `active_epoch` in `/accounts/{stake_address}` to better match its changed functionality. When account is deregistered (`active` field is `false`), this field contains the epoch number of deregistration.
- `reward_address` -> `reward_account` in `/pools/{pool_id}` and `/txs/{hash}/pool_updates` endpoints as the previous name was misleading and incorrect
- Deprecated `unit` field of not yet used `metadata` in `/assets/{asset}` endpoint
- Descriptions of few fields

### Fixed

- Multiple endpoints impacted by https://github.com/input-output-hk/cardano-db-sync/issues/474. We have addressed these issues with a temporary fix which will be in effect until the issue is resolved in the upstream. Please note that this mostly involved retired pools and their associated reward accounts. Affected endpoints and their parameters:
- Multiple endpoints impacted by [Cardano DB Sync issue](https://github.com/input-output-hk/cardano-db-sync/issues/474). We have addressed associated issues with a temporary fix which will be in effect until the issue is addressed in the upstream. Please note that this mostly involved retired pools and their associated reward accounts. Affected endpoints and their parameters:
- `/pools/{pool_id}`
- `live_stake`
- `live_size`
Expand All @@ -28,9 +32,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `/accounts/{stake_address}`
- `controlled_amount`
- `withdrawable_amount`
- Missing treasury in calculation of `live_stake` in `/pools/{pool_id}/delegators` endpoint. Other endpoints were not affected.
- Pool hopping account issues which were causing that some pools were displaying slightly higher `live_stake` values and thus also very slightly skewed `live_size` and `live_saturation` calculations in `/pools/{pool_id}` endpoint.
- `active_epoch` in `/accounts/{stake_address}` was previously displaying epoch of delegation, not de/registration.
- Missing treasury in calculation of `live_stake` in `/pools/{pool_id}/delegators` endpoint. Other endpoints were not affected
- Pool hopping account issues which were causing that some pools were displaying slightly higher `live_stake` values and thus also very slightly skewed `live_size` and `live_saturation` calculations in `/pools/{pool_id}` endpoint
- `active_epoch` in `/accounts/{stake_address}` was previously displaying epoch of delegation, not epoch of de/registration

## [0.1.4] - 2021-03-08

Expand Down
22 changes: 15 additions & 7 deletions swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3326,10 +3326,17 @@ components:
type: string
example: "340000000"
description: Fixed tax cost of the stake pool in Lovelaces
reward_address:
reward_account:
type: string
example: "stake1uxkptsa4lkr55jleztw43t37vgdn88l6ghclfwuxld2eykgpgvg3f"
description: Bech32 reward address of the stake pool
description: Bech32 reward account of the stake pool
owners:
type: array
items:
type: string
description: Bech32 accounts of the pool owners
example:
- "stake1u98nnlkvkk23vtvf9273uq7cph5ww6u2yq2389psuqet90sv4xv9v"
metadata:
type: object
nullable: true
Expand Down Expand Up @@ -3416,7 +3423,8 @@ components:
- pledge
- margin_cost
- fixed_cost
- reward_address
- reward_account
- owners
- metadata
- relays
- active_epoch
Expand Down Expand Up @@ -3982,15 +3990,15 @@ components:
type: string
example: "340000000"
description: Fixed tax cost of the stake pool
reward_address:
reward_account:
type: string
example: "stake1uxkptsa4lkr55jleztw43t37vgdn88l6ghclfwuxld2eykgpgvg3f"
description: Reward address of the stake pool
description: Bech32 reward account of the stake pool
owners:
type: array
items:
type: string
description: Account of the pool owner
description: Bech32 accounts of the pool owners
example:
- "stake1u98nnlkvkk23vtvf9273uq7cph5ww6u2yq2389psuqet90sv4xv9v"
registration:
Expand Down Expand Up @@ -4021,7 +4029,7 @@ components:
- live_pledge
- margin_cost
- fixed_cost
- reward_address
- reward_account
- owners
- registration
- retirement
Expand Down

0 comments on commit f2828ae

Please sign in to comment.