fix: duplicate state history #151
Conversation
| @@ -10,6 +10,7 @@ import ( | |||
| type DelegationState string | |||
|
|
|||
| const ( | |||
| StateCreated DelegationState = "CREATED" // Initial state when a delegation is first created in the indexer before receiving inclusion proof or covenant signatures | |||
There was a problem hiding this comment.
Hi @gusin13 why not we skip the state update if detected the previous state + sub state is the same?
Changing the pending to created here would break the indexer + api + FE contract on state transitions, no?
There was a problem hiding this comment.
yes if we add new state then it will break the api contract
in general my thinking was if the prev state/substate combination is same then it is a bug in indexer and shouldn't happen, so indexer shouldn't handle this case
there is another way to solve the problem without making a new state, as this problem only occurs in old flow, so
- when delegation is created - we mark as Pending (already being done before this pr)
- when inclusion proof received - babylon emits Pending and indexer w/o checking inserts Pending again, in this case I simply check if this is old flow don't insert Pending
even after the above solution if there are duplicates then its another bug
There was a problem hiding this comment.
The more I think about it, the more I feel like it's a bug on BBN side. Why does babylon emit pending state twice from difference messages?
Does the inclusion proof received event require emitting the pending state?
There was a problem hiding this comment.
no, so babylon actually doesn't emit twice, it only emits Pending state in the old flow in the inclusion proof event
so actually the transition in babylon events is like this
Verified -> Active (new flow)
Pending -> Active (old flow)
but the confusing thing is Babylon has a GetStatus method which returns the current status of delegation, so if the covenant quoram has not reached it treats it as Pending
so internally query wise, Babylon returns Pending (in both flows) but emits Pending only in the old flow.
the indexer should ideally when the delegation is created should use Pending state by default (becasue the quorem hasn't been achieved yet, we were already doing this before this pr)
| @@ -100,7 +100,7 @@ func TestStakingEarlyUnbonding(t *testing.T) { | |||
| stakingMsgTxHash := stakingMsgTx.TxHash() | |||
|
|
|||
| // Wait for delegation to be PENDING in Indexer DB | |||
There was a problem hiding this comment.
will this comment be relevant after these changes ?
| @@ -4,6 +4,7 @@ on: | |||
| push: | |||
| branches: | |||
| - 'main' | |||
| - '115-duplicate-entries-in-state_history-2' | |||
There was a problem hiding this comment.
can you please elaborate why this change is required, or you using it while developing
|
Sorry guys, realized in offline discussion this is not needed. The duplicated event is indeed legit. |
Fixes - #115
This is the usual flow of events
Now there are 2 staking flows
in the old flow babylon emits state in inclusion proof event
while in the new flow babylon emits state in inclusion proof event
the problem was indexer used to initialize state when 1.delegation was created
this created double entry in old flow because when inclusion proof is received, babylon will again send state.
so in this pr, i have created a new state which is the initial state when delegation is created, we need not store this in state history, the state history will be inserted once the inclusion proof is received so
notice there is no Pending state now in the pre-approval flow