Skip to content

Commit

Permalink
Merge pull request #395 from blockfrost/feat/drep-exp
Browse files Browse the repository at this point in the history 
feat: DRep expiration and last active epoch
  • Loading branch information
@vladimirvolek
vladimirvolek authored Jan 16, 2025
2 parents 2f69bd5 + c465de9 commit b49e619
Show file tree
Hide file tree
Showing 8 changed files with 154 additions and 13 deletions.
20 changes: 19 additions & 1 deletion blockfrost-openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6358,27 +6358,45 @@ components:
active:
type: boolean
description: Registration state of the DRep
deprecated: true
active_epoch:
type: integer
nullable: true
description: Epoch of the most recent action - registration or deregistration
description: Epoch of the most recent registration
deprecated: true
has_script:
type: boolean
description: Flag which shows if this DRep credentials are a script hash
retired:
type: boolean
description: Indicates the registration state of the DRep. Set to `true` if the DRep has been deregistered; otherwise, `false`.
expired:
type: boolean
description: Indicates whether the DRep has been inactive for a consecutive number of epochs (determined by a epoch parameter `drep_activity`)
last_active_epoch:
type: integer
nullable: true
description: Epoch of the most recent action - registration, update, deregistration or voting
required:
- drep_id
- hex
- amount
- active
- active_epoch
- has_script
- retired
- expired
- last_active_epoch
example:
drep_id: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc
hex: a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d
amount: '2000000'
active: true
active_epoch: 420
has_script: true
last_active_epoch: 509
retired: false
expired: false
drep_delegators:
type: array
items:
Expand Down
26 changes: 25 additions & 1 deletion docs/blockfrost-openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6663,27 +6663,51 @@ components:
active:
type: boolean
description: Registration state of the DRep
deprecated: true
active_epoch:
type: integer
nullable: true
description: Epoch of the most recent action - registration or deregistration
description: Epoch of the most recent registration
deprecated: true
has_script:
type: boolean
description: Flag which shows if this DRep credentials are a script hash
retired:
type: boolean
description: >-
Indicates the registration state of the DRep. Set to `true` if the
DRep has been deregistered; otherwise, `false`.
expired:
type: boolean
description: >-
Indicates whether the DRep has been inactive for a consecutive
number of epochs (determined by a epoch parameter `drep_activity`)
last_active_epoch:
type: integer
nullable: true
description: >-
Epoch of the most recent action - registration, update,
deregistration or voting
required:
- drep_id
- hex
- amount
- active
- active_epoch
- has_script
- retired
- expired
- last_active_epoch
example:
drep_id: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc
hex: a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d
amount: '2000000'
active: true
active_epoch: 420
has_script: true
last_active_epoch: 509
retired: false
expired: false
drep_delegators:
type: array
items:
Expand Down
2 changes: 1 addition & 1 deletion json-schema.json
View file

Large diffs are not rendered by default.

29 changes: 25 additions & 4 deletions openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8698,16 +8698,31 @@
},
"active": {
"type": "boolean",
"description": "Registration state of the DRep"
"description": "Registration state of the DRep",
"deprecated": true
},
"active_epoch": {
"type": "integer",
"nullable": true,
"description": "Epoch of the most recent action - registration or deregistration"
"description": "Epoch of the most recent registration",
"deprecated": true
},
"has_script": {
"type": "boolean",
"description": "Flag which shows if this DRep credentials are a script hash"
},
"retired": {
"type": "boolean",
"description": "Indicates the registration state of the DRep. Set to `true` if the DRep has been deregistered; otherwise, `false`."
},
"expired": {
"type": "boolean",
"description": "Indicates whether the DRep has been inactive for a consecutive number of epochs (determined by a epoch parameter `drep_activity`)"
},
"last_active_epoch": {
"type": "integer",
"nullable": true,
"description": "Epoch of the most recent action - registration, update, deregistration or voting"
}
},
"required": [
Expand All @@ -8716,15 +8731,21 @@
"amount",
"active",
"active_epoch",
"has_script"
"has_script",
"retired",
"expired",
"last_active_epoch"
],
"example": {
"drep_id": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc",
"hex": "a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d",
"amount": "2000000",
"active": true,
"active_epoch": 420,
"has_script": true
"has_script": true,
"last_active_epoch": 509,
"retired": false,
"expired": false
}
},
"drep_delegators": {
Expand Down
26 changes: 25 additions & 1 deletion openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6663,27 +6663,51 @@ components:
active:
type: boolean
description: Registration state of the DRep
deprecated: true
active_epoch:
type: integer
nullable: true
description: Epoch of the most recent action - registration or deregistration
description: Epoch of the most recent registration
deprecated: true
has_script:
type: boolean
description: Flag which shows if this DRep credentials are a script hash
retired:
type: boolean
description: >-
Indicates the registration state of the DRep. Set to `true` if the
DRep has been deregistered; otherwise, `false`.
expired:
type: boolean
description: >-
Indicates whether the DRep has been inactive for a consecutive
number of epochs (determined by a epoch parameter `drep_activity`)
last_active_epoch:
type: integer
nullable: true
description: >-
Epoch of the most recent action - registration, update,
deregistration or voting
required:
- drep_id
- hex
- amount
- active
- active_epoch
- has_script
- retired
- expired
- last_active_epoch
example:
drep_id: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc
hex: a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d
amount: '2000000'
active: true
active_epoch: 420
has_script: true
last_active_epoch: 509
retired: false
expired: false
drep_delegators:
type: array
items:
Expand Down
21 changes: 18 additions & 3 deletions src/generated-types.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6739,7 +6739,10 @@ export interface components {
* "amount": "2000000",
* "active": true,
* "active_epoch": 420,
* "has_script": true
* "has_script": true,
* "last_active_epoch": 509,
* "retired": false,
* "expired": false
* } */
drep: {
/** @description Bech32 encoded DRep address */
Expand All @@ -6748,12 +6751,24 @@ export interface components {
hex: string;
/** @description The total amount of voting power this DRep is delegated. */
amount: string;
/** @description Registration state of the DRep */
/**
* @deprecated
* @description Registration state of the DRep
*/
active: boolean;
/** @description Epoch of the most recent action - registration or deregistration */
/**
* @deprecated
* @description Epoch of the most recent registration
*/
active_epoch: number | null;
/** @description Flag which shows if this DRep credentials are a script hash */
has_script: boolean;
/** @description Indicates the registration state of the DRep. Set to `true` if the DRep has been deregistered; otherwise, `false`. */
retired: boolean;
/** @description Indicates whether the DRep has been inactive for a consecutive number of epochs (determined by a epoch parameter `drep_activity`) */
expired: boolean;
/** @description Epoch of the most recent action - registration, update, deregistration or voting */
last_active_epoch: number | null;
};
/** @example [
* {
Expand Down
20 changes: 19 additions & 1 deletion src/schemas/governance/drep.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,25 @@ properties:
active:
type: boolean
description: Registration state of the DRep
deprecated: true
active_epoch:
type: integer
nullable: true
description: Epoch of the most recent action - registration or deregistration
description: Epoch of the most recent registration
deprecated: true
has_script:
type: boolean
description: Flag which shows if this DRep credentials are a script hash
retired:
type: boolean
description: Indicates the registration state of the DRep. Set to `true` if the DRep has been deregistered; otherwise, `false`.
expired:
type: boolean
description: Indicates whether the DRep has been inactive for a consecutive number of epochs (determined by a epoch parameter `drep_activity`)
last_active_epoch:
type: integer
nullable: true
description: Epoch of the most recent action - registration, update, deregistration or voting

required:
- drep_id
Expand All @@ -27,10 +39,16 @@ required:
- active
- active_epoch
- has_script
- retired
- expired
- last_active_epoch
example:
drep_id: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc
hex: a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d
amount: "2000000"
active: true
active_epoch: 420
has_script: true
last_active_epoch: 509
retired: false
expired: false
23 changes: 22 additions & 1 deletion test/tests/__snapshots__/get-schema-for-endpoint.test.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10936,16 +10936,21 @@ under which it is valid
"active_epoch": 420,
"amount": "2000000",
"drep_id": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc",
"expired": false,
"has_script": true,
"hex": "a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d",
"last_active_epoch": 509,
"retired": false,
},
"properties": {
"active": {
"deprecated": true,
"description": "Registration state of the DRep",
"type": "boolean",
},
"active_epoch": {
"description": "Epoch of the most recent action - registration or deregistration",
"deprecated": true,
"description": "Epoch of the most recent registration",
"nullable": true,
"type": "integer",
},
Expand All @@ -10957,6 +10962,10 @@ under which it is valid
"description": "Bech32 encoded DRep address",
"type": "string",
},
"expired": {
"description": "Indicates whether the DRep has been inactive for a consecutive number of epochs (determined by a epoch parameter \`drep_activity\`)",
"type": "boolean",
},
"has_script": {
"description": "Flag which shows if this DRep credentials are a script hash",
"type": "boolean",
Expand All @@ -10965,6 +10974,15 @@ under which it is valid
"description": "The raw bytes of the DRep",
"type": "string",
},
"last_active_epoch": {
"description": "Epoch of the most recent action - registration, update, deregistration or voting",
"nullable": true,
"type": "integer",
},
"retired": {
"description": "Indicates the registration state of the DRep. Set to \`true\` if the DRep has been deregistered; otherwise, \`false\`.",
"type": "boolean",
},
},
"required": [
"drep_id",
Expand All @@ -10973,6 +10991,9 @@ under which it is valid
"active",
"active_epoch",
"has_script",
"retired",
"expired",
"last_active_epoch",
],
"type": "object",
},
Expand Down

0 comments on commit b49e619

Please sign in to comment.