Feature/add stake entities and params #26

Alann27 · 2024-10-29T17:57:08Z

Summary

Added the following entities that can be staked and their related messages/events:
- Application
- Supplier
- Gateway.

The functionality to save the this entities from the genesis were added too.

Added functionality to parse params from genesis and update the parameters that came in an authz exec transaction.

Details

The following entities related to Service were added:
- Service: This entity represents a specific service with their current state.
- AddServiceMsg: message emitted when a service is added.
The following entities related to Application were added:
- Application: This entity represents a specific application with their current state.
- ApplicationDelegatedToGateway: many-to-many relationship between Application and Gateway representing the delegation of an application to a gateway.
- ApplicationService: many-to-many relationship between Application and Service representing the service staked to an application.
- TransferApplicationBeginEvent: event emitted when an application started their transfer process.
- TransferApplicationEndEvent: event emitted when an application ended their transfer process.
- TransferApplicationErrorEvent: event emitted when an application failed to be transferred.
- EventApplicationUnbondingBegin: event emitted when an application started their unbonding process.
- EventApplicationUnbondingEnd: event emitted when an application ended their unbonding process.
- AppMsgStake: message emitted when an application its staked (or re-staked).
- AppMsgStakeService: many-to-many relationship between AppMsgStake and Service representing the service staked to an application in a specific AppMsgStake.
- AppMsgUnstake: message emitted when an application its unstaked.
- MsgDelegateToGateway: message emitted when an application its delegated to a gateway.
- MsgUndelegateToGateway: message emitted when an application it's undelegated from a gateway.
- MsgTransferApplication: message emitted when an application its transferred to another address.
The following entities related to Supplier were added:
- Supplier: This entity represents a specific supplier with their current state.
- SupplierMsgStake: message emitted when a supplier its staked (or re-staked).
- SupplierMsgStakeService: many-to-many relationship between SupplierMsgStake and Service representing the service staked to a supplier in a specific SupplierMsgStake.
- SupplierMsgUnstake: message emitted when a supplier its unstaked.
- SupplierService: many-to-many relationship between Supplier and Service representing the service staked to a supplier.
- SupplierUnbondingBeginEvent: event emitted when a supplier started their unbonding process.
- SupplierUnbondingEndEvent: event emitted when a supplier ended their unbonding process.
The following entities related to Gateway were added:
- Gateway: This entity represents a specific gateway with their current state.
- GatewayStakeMsg: message emitted when a gateway its staked (or re-staked).
- GatewayUnstakeMsg: message emitted when a gateway its unstaked.
- GatewayUnstakedEvent: event emitted when a gateway its unstaked.

To be able to handle the parameters update, we added a new handler called handleAuthzExec. This is a message handler that is called when a message is executed by the authz module and inside of it, it has encoded messages like MsgUpdateParams. We are decoding those MsgUpdateParams and updating the parameters accordingly.

The following entities related to parameters were added:
- AuthzExec: authz module execution message.
- AuthzExecMessage: many-to-many relationship between AuthzExec and Message representing the message that was executed by the authz module.
- AppParams: application module parameters.
- AuthParam: auth module parameters.
- BankParam: bank module parameters.
- DistributionParam: distribution module parameters.
- GatewayParam: gateway module parameters.
- GovParam: gov module parameters.
- MintParam: mint module parameters.
- ProofParam: proof module parameters.
- ServiceParam: service module parameters.
- SessionParam: session module parameters.
- SharedParams: shared module parameters.
- SlashingParam: slashing module parameters.
- StakingParam: staking module parameters.
- SupplierParam: supplier module parameters.
- TokenomicsParam: tokenomics module parameters.
- ConsensusParam: consensus module parameters.

Other changes

Created genesis.ts file to handle the genesis parsing.
Updated import of GeneratedType inside src/cosmjs directory to add type to the import statement.
Updated version of @subql/node-cosmos to ^4.1.4. This version includes the fix to the block events not being emitted.
Updated version of @subql/cli to ^5.3.0 and @subql/types-cosmos to ^4.0.0.
Added global.ts file to fix an issue with the method getFieldsBy of store.
Updated code where events were being handled because block events not include msg and tx fields.

Issue

Update @subql/node-cosmos to ^4.1.4 so we can handle the block events.
Add functionality to save Applications, Suppliers, Gateways, and Services.
ADd functionality to parse params from genesis and update the parameters that came in an authz exec transaction.

Type of change

Select one or more:

Sanity Checklist

I have tested my changes using the available tooling
I have commented my code
I have performed a self-review of my own code; both comments & source code
I create and reference any new tickets, if applicable
I have left TODOs throughout the codebase, if applicable

…s, added global.ts file to fix an issue caused via the new version of `@subql/types-cosmos` dependency, changed type of computeUnitsPerRelay to BigInt

Olshansk · 2024-11-06T19:08:43Z

@bryanchriswhite PTAL when you have a chance.

…he fields of the entities, changed enums for int, added missing params to block

jorgecuesta

LGTM. Great job @Alann27

schema.graphql

src/mappings/authz/exec.ts

src/mappings/genesis.ts

bryanchriswhite

Great work @Alann27! 🙌 Thanks for all the effort it undoubtedly took to get to this point, I love seeing the indexer come together! 😍 🚀

I'm out of time on this for this morning but will resume review again after I've made some progress on other things:

Some very general feedback: there's waaaay too much going on here for anyone to review as thoroughly as this deserves to be reviewed, especially at this particular stage of the project. High quality review depends on reviewers being able to reason about the entire change holistically. In my view, this perspective is what makes the review context so incredibly useful as compared to the development context. Without clear boundaries between changes though, it becomes extremely difficult to form a holistic picture without risking omitting some relevant detail that's gotten lost in the noise of unrelated changes or being otherwise distracted by unrelated changes.

Going forward, (pretty) please prefer to open several smaller PRs over one large one. It makes review orders of magnitude easier for everyone. 🙏🙏🙏🙏

My number 1 recommendation to facilitate this is to commit related changes frequently. Even if it's not clear from the outset what changes you're going to be making and how it naturally makes sense to organize them, if you prefer many small commits over fewer larger ones, it becomes much more easy to rearrange and squash related changes such that it is then trivial to split the unrelated changes into separate branches, prior to review. If you would like to chat about this in more detail, I would be more than happy to discuss it over a screensharing session or something.

To give you a concrete example, I would've split this PR into the following:

Update poktroll protobuf files
Add parameter update indexing
Add service module indexing
Add gateway module indexing
Add application module indexing
Add supplier module indexing
Refactor genesis processing
Add authz message indexing

src/cosmjs/proto/bank.ts

src/mappings/utils.ts

src/mappings/authz/exec.ts

bryanchriswhite · 2024-11-11T09:21:57Z

src/mappings/utils.ts

NO ACTION REQUIRED AT THIS TIME

I think we should start thinking about how to split this file up and reorganize the contents. Additionally, there seems to be another utils.ts file in src/cosmjs. IMHO "utils" files/packages/modules/etc. are generally an antipattern, indicative of a need to reorganize/restructure.

schema.graphql

bryanchriswhite · 2024-11-11T10:26:15Z

schema.graphql

+  id: ID!
+  source: Application!
+  destination: Application!
+  transaction: Transaction


Suggested change

transaction: Transaction

transaction: Transaction # End-block event; never has tx

bryanchriswhite · 2024-11-11T10:26:25Z

schema.graphql

+  source: Application!
+  destination: Account!
+  error: String!
+  transaction: Transaction


Suggested change

transaction: Transaction

transaction: Transaction # End-block event; never has tx

bryanchriswhite · 2024-11-11T10:26:32Z

schema.graphql

+  reason: Int!
+  sessionEndHeight: BigInt!
+  unstakingEndHeight: BigInt!
+  transaction: Transaction


Suggested change

transaction: Transaction

transaction: Transaction # End-block event; never has tx

schema.graphql

bryanchriswhite

I have to stop again for this morning but this is coming along amazingly! 🙌 Thank you for your persistence and patience. 💪 🙏

ACK re: enum types. We can revisit once SubQuery releases the update that makes GQL enums indexable.

My feedback seems to mostly be about consistency in the following areas:

Message and event types include relations to all their primitives
Message and event entity naming (with protobuf types)
Join table entity naming (i.e. Entity1Entity2)
"Similar" field names (e.g. begin/end block/height fields) AND which fields (blocks / heights / both).

schema.graphql

bryanchriswhite · 2024-11-12T09:37:16Z

schema.graphql

+  id: ID!
+  source: Application!
+  destination: Application!
+  transaction: Transaction


bryanchriswhite · 2024-11-12T09:37:19Z

schema.graphql

+  source: Application!
+  destination: Account!
+  error: String!
+  transaction: Transaction


bryanchriswhite · 2024-11-12T09:37:22Z

schema.graphql

+  reason: Int!
+  sessionEndHeight: BigInt!
+  unstakingEndHeight: BigInt!
+  transaction: Transaction


schema.graphql

src/mappings/poktroll/suppliers.ts

bryanchriswhite · 2024-11-13T09:57:23Z

schema.graphql

+  service: Service!
+  revShare: [SupplierRevShare]!
+  endpoints: [SupplierEndpoint]!


Suggested change

service: Service!

revShare: [SupplierRevShare]!

endpoints: [SupplierEndpoint]!

serviceConfigs: [SupplierServiceConfig]!

schema.graphql

bryanchriswhite

Almost there! 😅

schema.graphql

bryanchriswhite · 2024-11-14T09:25:58Z

schema.graphql

+  service: Service!
+  revShare: [SupplierRevShare]!
+  endpoints: [SupplierEndpoint]!


(bump)

Do you disagree here?

src/mappings/poktroll/suppliers.ts

schema.graphql

src/mappings/genesis.ts

src/mappings/utils.ts

bryanchriswhite

I think this may be the last round of feedback - thank you so much for bearing with me! 🙌 🙇‍♂️

This is great work @Alann27! 🚀 🚀

src/mappings/genesis.ts

src/mappings/poktroll/applications.ts

src/mappings/poktroll/gateways.ts

src/mappings/types/global.ts

bryanchriswhite

🚀 🚀 🚀 🚀 🚀

bryanchriswhite · 2024-11-19T19:15:21Z

src/mappings/types/global.ts

+// This declaration resolves a type mismatch with the `store.getByField` method
+// in the generated files. The original method from the library does not
+// support a generic type, which causes TypeScript errors when used with generics.
+// To fix this, we redefine the `getByField` method to explicitly accept a generic type.


Alann27 added 3 commits October 28, 2024 14:38

added staking entities and params handling

7609302

updated version of @subql/cli and @subql/types-cosmos dependencie…

0927f5a

…s, added global.ts file to fix an issue caused via the new version of `@subql/types-cosmos` dependency, changed type of computeUnitsPerRelay to BigInt

fixed complexity of getEntityParamName function

a93e8e6

Alann27 marked this pull request as ready for review November 6, 2024 16:49

jorgecuesta assigned Alann27 Nov 6, 2024

jorgecuesta requested a review from bryanchriswhite November 6, 2024 16:49

jorgecuesta added the enhancement New feature or request label Nov 6, 2024

jorgecuesta requested review from jorgecuesta and Olshansk November 6, 2024 16:49

Olshansk removed their request for review November 6, 2024 19:08

fixed names of events and msgs, using stake instead of bond to name t…

3609a42

…he fields of the entities, changed enums for int, added missing params to block

Alann27 force-pushed the feature/add-stake-entities-and-params branch from 5838bd8 to 3609a42 Compare November 7, 2024 19:53

jorgecuesta approved these changes Nov 8, 2024

View reviewed changes

bryanchriswhite requested changes Nov 11, 2024

View reviewed changes

Alann27 mentioned this pull request Nov 11, 2024

Replace the use of Int for Enums in schema.graphql #27

Open

applied recommended changes

0363ea9

Alann27 requested a review from bryanchriswhite November 11, 2024 20:18

replaced readonly object with enum

60eb5be

bryanchriswhite requested changes Nov 12, 2024

View reviewed changes

applied recommended changes

28055b8

Alann27 requested a review from bryanchriswhite November 12, 2024 19:19

bryanchriswhite reviewed Nov 13, 2024

View reviewed changes

applied recommended changes

939988b

Alann27 requested a review from bryanchriswhite November 13, 2024 21:23

bryanchriswhite requested changes Nov 14, 2024

View reviewed changes

bryanchriswhite requested changes Nov 18, 2024

View reviewed changes

jorgecuesta mentioned this pull request Nov 18, 2024

Add supply indexing #28

Merged

10 tasks

applied recommended changes

c6234ef

Alann27 requested a review from bryanchriswhite November 19, 2024 18:21

bryanchriswhite approved these changes Nov 19, 2024

View reviewed changes

jorgecuesta merged commit 5ecfc6b into pokt-network:main Nov 19, 2024
4 checks passed

jorgecuesta mentioned this pull request Nov 19, 2024

chore: update @subql/node-cosmos #25

Closed

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/add stake entities and params #26

Feature/add stake entities and params #26

Alann27 commented Oct 29, 2024 •

edited

Loading

Olshansk commented Nov 6, 2024

jorgecuesta left a comment

bryanchriswhite left a comment •

edited

Loading

bryanchriswhite Nov 11, 2024

bryanchriswhite Nov 11, 2024

bryanchriswhite Nov 12, 2024

bryanchriswhite Nov 11, 2024

bryanchriswhite Nov 12, 2024

bryanchriswhite Nov 11, 2024

bryanchriswhite Nov 12, 2024

bryanchriswhite left a comment

bryanchriswhite Nov 12, 2024

bryanchriswhite Nov 12, 2024

bryanchriswhite Nov 12, 2024

bryanchriswhite Nov 13, 2024

bryanchriswhite left a comment

bryanchriswhite Nov 14, 2024

bryanchriswhite left a comment

bryanchriswhite left a comment

bryanchriswhite Nov 19, 2024

	transaction: Transaction
	transaction: Transaction # End-block event; never has tx

Feature/add stake entities and params #26

Feature/add stake entities and params #26

Conversation

Alann27 commented Oct 29, 2024 • edited Loading

Summary

Details

Other changes

Issue

Type of change

Sanity Checklist

Olshansk commented Nov 6, 2024

jorgecuesta left a comment

Choose a reason for hiding this comment

bryanchriswhite left a comment • 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

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

bryanchriswhite 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

bryanchriswhite left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bryanchriswhite left a comment

Choose a reason for hiding this comment

bryanchriswhite left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alann27 commented Oct 29, 2024 •

edited

Loading

bryanchriswhite left a comment •

edited

Loading