add task that tracks stake delegation #157

ecioppettini · 2023-10-03T20:31:03Z

NOTE: I still need to do some cleanup, I copy-pasted some stuff from here and there that I need to re-check. Also naming of some things.

Currently this can be used like (I'm using preview, with some arbitrary stake key that I found):

curl -X "POST" "http://localhost:3000/delegation/address" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "address": "stake_test1uqnat2dv4gwx739kjy0vxufy7r63zkhkhuzurfsn008mh4crrhgyd",
  "until": { "absoluteSlot": 1462810 }
}'

echo ''

curl -X "POST" "http://localhost:3000/delegation/address" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "address": "stake_test1uqnat2dv4gwx739kjy0vxufy7r63zkhkhuzurfsn008mh4crrhgyd",
  "until": { "absoluteSlot": 1462811 }
}'

echo ''

curl -X "POST" "http://localhost:3000/delegation/address" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "address": "stake_test1uqnat2dv4gwx739kjy0vxufy7r63zkhkhuzurfsn008mh4crrhgyd",
  "until": { "absoluteSlot": 2498920 }
}'

echo ''

curl -X "POST" "http://localhost:3000/delegation/address" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "address": "stake_test1uqnat2dv4gwx739kjy0vxufy7r63zkhkhuzurfsn008mh4crrhgyd",
  "until": { "absoluteSlot": 2498921 }
}'

Which returns

// no delegation yet
{"pool":null,"txId":null}

// the delegation certificate is in this ( the next slot ) 
{"pool":"367d927a91eb9ecf15648779beeec8c710171566edcce18feb048265","txId":"348351606a363f5c81e267e509a14eaa486003201e6b68ecf7b0cbc101f7368d"}

// last slot before re-delegation
{"pool":"367d927a91eb9ecf15648779beeec8c710171566edcce18feb048265","txId":"348351606a363f5c81e267e509a14eaa486003201e6b68ecf7b0cbc101f7368d"}

// new delegation
{"pool":"e931eea8a3e9344656f3f233e55c32ea5056303b5c313015871bc57f","txId":"1aa52d8618fdebe4afd532b0381b5ffba3ac99f6a135a2ded3a353785c2b3d16"}

The until uses the absolute slot, since if you have a timestamp you can convert it to a slot and filter by time. And also, using block/latest can be used to get the absolute epoch too (even if the name of the field is just epoch), so it's possible to just get the latest one (or a close one).

gostkin

looks good, thanks @ecioppettini

indexer/migration/src/m20230927_231206_create_stake_delegation_table.rs

indexer/tasks/src/multiera/multiera_address_delegation.rs

webserver/shared/routes.ts

this helps getting un-delegation events by pool, since otherwise re-delegation doesn't directly address the pool that no longer has the delegation.

ecioppettini · 2023-10-12T02:23:39Z

webserver/server/app/models/delegation/delegationsForPool.sql

+	 	"StakeDelegationCredentialRelation".previous_pool IN :pools!
+	) AND
+	"Block".slot > :min_slot! AND
+	"Block".slot <= :max_slot!


we may want to have a way to paginate this in terms of number of entries in this range? Maybe by using the tx as a cursor, I need to check how hard would be it to re-use the existing pagination code for this.

Typical pagination cursors do not work since they don't generally expect rollbacks. If you use a pagination cursor, it has to be set up so that if the underlying data changes in the middle of pagination you do not get in an invalid state

ecioppettini · 2023-10-12T02:24:49Z

webserver/shared/models/DelegationForPool.ts

+};
+
+export type DelegationForPoolResponse = {
+    credential: Address;


Not sure yet what's the best way to show this, currently it's the credential in hex

ecioppettini · 2023-10-12T02:25:18Z

webserver/shared/models/Pool.ts

+export type PoolHex = string;
+
+export type Pool =
+  | PoolHex


would bech32 be useful to have here as an option?

I think just picking one option is fine

gostkin · 2023-11-07T10:34:44Z

indexer/migration/src/lib.rs

@@ -17,6 +17,7 @@ mod m20220528_000012_create_plutus_data_table;
 mod m20220808_000013_create_transaction_reference_input_table;
 mod m20221031_000014_create_dex_table;
 mod m20230223_000015_modify_block_table;
+mod m20230927_231206_create_stake_delegation_table;


let's probably keep the naming convention (date + number)?

good catch, I didn't notice that. The weird thing is that I created this file with sea-orm-cli, so I'm not sure why it's choosing that name

gostkin · 2023-11-07T10:38:28Z

indexer/entity/src/stake_delegation.rs

+pub struct Model {
+    #[sea_orm(primary_key, column_type = "BigInteger")]
+    pub id: i64,
+    pub stake_credential: i64,


shouldn't we add #[sea_orm(column_type = "BigInteger")]?

I'm not sure that does anything, to be honest. The columns already have bigint type for me, and it's what the docs say should happen I think (https://www.sea-ql.org/SeaORM/docs/next/generate-entity/entity-structure/).

But I can add it just in case anyway.

gostkin · 2023-11-07T10:38:34Z

indexer/entity/src/stake_delegation.rs

+    pub stake_credential: i64,
+    // pool registrations are not tracked in StakeCredentials,
+    pub pool_credential: Option<Vec<u8>>,
+    pub tx_id: i64,


here as well

gostkin · 2023-11-07T10:40:23Z

indexer/tasks/src/multiera/multiera_address_delegation.rs

+
+                let previous_entry = entity::stake_delegation::Entity::find()
+                    .filter(
+                        entity::stake_delegation::Column::StakeCredential.eq(stake_credential_id),


shouldn't we add an index for that col as well? postgres doesn't create it automatically afaik

it doesn't seem to make a huge difference in the first epochs, but I can add it just in case

ecioppettini added 2 commits October 3, 2023 17:06

introduce new relation that tracks stake delegation certs

e276231

add 'delegation/address' route

9d1dda3

ecioppettini requested a review from gostkin October 3, 2023 20:31

ecioppettini self-assigned this Oct 3, 2023

gostkin reviewed Oct 4, 2023

View reviewed changes

SebastienGllmt reviewed Oct 4, 2023

View reviewed changes

indexer/migration/src/m20230927_231206_create_stake_delegation_table.rs Outdated Show resolved Hide resolved

indexer/tasks/src/multiera/multiera_address_delegation.rs Outdated Show resolved Hide resolved

webserver/shared/routes.ts Show resolved Hide resolved

ecioppettini added 3 commits October 5, 2023 16:51

regen docs/bin/openapi.json

d09923b

remove copy-pasted comment in migration

df472ed

cleanup unused branches/variants of certificates

50b497f

SebastienGllmt approved these changes Oct 7, 2023

View reviewed changes

ecioppettini marked this pull request as ready for review October 9, 2023 12:30

ecioppettini added 2 commits October 11, 2023 21:54

add previous pool column

d7a1078

this helps getting un-delegation events by pool, since otherwise re-delegation doesn't directly address the pool that no longer has the delegation.

add endpoint get pool's delegation history by pool

b9ad7ab

ecioppettini commented Oct 12, 2023

View reviewed changes

ecioppettini added 2 commits October 24, 2023 00:18

add slot and pool fields to the delegation for pool query

21785b0

delegationForAddress: extract staking credential if arg is full address

02f0174

gostkin reviewed Nov 7, 2023

View reviewed changes

ecioppettini added 3 commits November 7, 2023 13:27

rename migration file and add stake credential column index

dc5338b

add limit for slot range and pools

d474564

eslint fixes

ac1aa29

SebastienGllmt merged commit b3deea0 into main Dec 1, 2023
2 checks passed

SebastienGllmt deleted the delegation-indexing-task branch December 1, 2023 13:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add task that tracks stake delegation #157

add task that tracks stake delegation #157

ecioppettini commented Oct 3, 2023

gostkin left a comment

ecioppettini Oct 12, 2023

SebastienGllmt Oct 12, 2023

ecioppettini Oct 12, 2023

ecioppettini Oct 12, 2023

SebastienGllmt Oct 12, 2023

gostkin Nov 7, 2023

ecioppettini Nov 7, 2023

gostkin Nov 7, 2023

ecioppettini Nov 7, 2023 •

edited

Loading

gostkin Nov 7, 2023

gostkin Nov 7, 2023

ecioppettini Nov 7, 2023

add task that tracks stake delegation #157

add task that tracks stake delegation #157

Conversation

ecioppettini commented Oct 3, 2023

gostkin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ecioppettini Nov 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ecioppettini Nov 7, 2023 •

edited

Loading