-
Notifications
You must be signed in to change notification settings - Fork 12
/
btc_delegations.go
224 lines (195 loc) · 7.48 KB
/
btc_delegations.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
package keeper
import (
"context"
"fmt"
"cosmossdk.io/store/prefix"
"github.com/btcsuite/btcd/chaincfg/chainhash"
"github.com/cosmos/cosmos-sdk/runtime"
sdk "github.com/cosmos/cosmos-sdk/types"
asig "github.com/babylonlabs-io/babylon/crypto/schnorr-adaptor-signature"
bbn "github.com/babylonlabs-io/babylon/types"
"github.com/babylonlabs-io/babylon/x/btcstaking/types"
)
// AddBTCDelegation adds a BTC delegation post verification to the system, including
// - indexing the given BTC delegation in the BTC delegator store,
// - saving it under BTC delegation store, and
// - emit events about this BTC delegation.
func (k Keeper) AddBTCDelegation(
ctx sdk.Context,
btcDel *types.BTCDelegation,
minUnbondingTime uint32,
) error {
if err := btcDel.ValidateBasic(); err != nil {
return err
}
// get staking tx hash
stakingTxHash, err := btcDel.GetStakingTxHash()
if err != nil {
return err
}
// for each finality provider the delegation restakes to, update its index
for _, fpBTCPK := range btcDel.FpBtcPkList {
fpBTCPK := fpBTCPK // remove when update to go1.22
// get BTC delegation index under this finality provider
btcDelIndex := k.getBTCDelegatorDelegationIndex(ctx, &fpBTCPK, btcDel.BtcPk)
if btcDelIndex == nil {
btcDelIndex = types.NewBTCDelegatorDelegationIndex()
}
// index staking tx hash of this BTC delegation
if err := btcDelIndex.Add(stakingTxHash); err != nil {
return types.ErrInvalidStakingTx.Wrapf(err.Error())
}
// save the index
k.setBTCDelegatorDelegationIndex(ctx, &fpBTCPK, btcDel.BtcPk, btcDelIndex)
}
// save this BTC delegation
k.setBTCDelegation(ctx, btcDel)
if err := ctx.EventManager().EmitTypedEvents(types.NewBtcDelCreationEvent(
stakingTxHash.String(),
btcDel,
)); err != nil {
panic(fmt.Errorf("failed to emit events for the new pending BTC delegation: %w", err))
}
// NOTE: we don't need to record events for pending BTC delegations since these
// do not affect voting power distribution
// NOTE: we only insert unbonded event if the delegation already has inclusion proof
if btcDel.HasInclusionProof() {
if err := ctx.EventManager().EmitTypedEvent(types.NewInclusionProofEvent(
stakingTxHash.String(),
btcDel.StartHeight,
btcDel.EndHeight,
types.BTCDelegationStatus_PENDING,
)); err != nil {
panic(fmt.Errorf("failed to emit EventBTCDelegationInclusionProofReceived for the new pending BTC delegation: %w", err))
}
// record event that the BTC delegation will become unbonded at endHeight-w
// This event will be generated to subscribers as block event, when the
// btc light client block height will reach btcDel.EndHeight-wValue
unbondedEvent := types.NewEventPowerDistUpdateWithBTCDel(&types.EventBTCDelegationStateUpdate{
StakingTxHash: stakingTxHash.String(),
NewState: types.BTCDelegationStatus_UNBONDED,
})
// NOTE: we should have verified that EndHeight > btcTip.Height + max(w, min_unbonding_time)
k.addPowerDistUpdateEvent(ctx, btcDel.EndHeight-minUnbondingTime, unbondedEvent)
}
return nil
}
// addCovenantSigsToBTCDelegation adds signatures from a given covenant member
// to the given BTC delegation
func (k Keeper) addCovenantSigsToBTCDelegation(
ctx sdk.Context,
btcDel *types.BTCDelegation,
covPK *bbn.BIP340PubKey,
parsedSlashingAdaptorSignatures []asig.AdaptorSignature,
unbondingTxSig *bbn.BIP340Signature,
parsedUnbondingSlashingAdaptorSignatures []asig.AdaptorSignature,
params *types.Params,
) {
hadQuorum := btcDel.HasCovenantQuorums(params.CovenantQuorum)
// All is fine add received signatures to the BTC delegation and BtcUndelegation
btcDel.AddCovenantSigs(
covPK,
parsedSlashingAdaptorSignatures,
unbondingTxSig,
parsedUnbondingSlashingAdaptorSignatures,
)
k.setBTCDelegation(ctx, btcDel)
if err := ctx.EventManager().EmitTypedEvent(types.NewCovenantSignatureReceivedEvent(
btcDel,
covPK,
unbondingTxSig,
)); err != nil {
panic(fmt.Errorf("failed to emit EventCovenantSignatureRecevied for the new active BTC delegation: %w", err))
}
// If reaching the covenant quorum after this msg, the BTC delegation becomes
// active. Then, record and emit this event
// We only emit power distribution events, and external quorum events if it
// is the first time the quorum is reached
if !hadQuorum && btcDel.HasCovenantQuorums(params.CovenantQuorum) {
if btcDel.HasInclusionProof() {
quorumReachedEvent := types.NewCovenantQuorumReachedEvent(
btcDel,
types.BTCDelegationStatus_ACTIVE,
)
if err := ctx.EventManager().EmitTypedEvent(quorumReachedEvent); err != nil {
panic(fmt.Errorf("failed to emit emit for the new verified BTC delegation: %w", err))
}
// record event that the BTC delegation becomes active at this height
activeEvent := types.NewEventPowerDistUpdateWithBTCDel(
&types.EventBTCDelegationStateUpdate{
StakingTxHash: btcDel.MustGetStakingTxHash().String(),
NewState: types.BTCDelegationStatus_ACTIVE,
},
)
btcTip := k.btclcKeeper.GetTipInfo(ctx)
k.addPowerDistUpdateEvent(ctx, btcTip.Height, activeEvent)
} else {
quorumReachedEvent := types.NewCovenantQuorumReachedEvent(
btcDel,
types.BTCDelegationStatus_VERIFIED,
)
if err := ctx.EventManager().EmitTypedEvent(quorumReachedEvent); err != nil {
panic(fmt.Errorf("failed to emit emit for the new verified BTC delegation: %w", err))
}
}
}
}
// btcUndelegate adds the signature of the unbonding tx signed by the staker
// to the given BTC delegation
func (k Keeper) btcUndelegate(
ctx sdk.Context,
btcDel *types.BTCDelegation,
u *types.DelegatorUnbondingInfo,
) {
btcDel.BtcUndelegation.DelegatorUnbondingInfo = u
k.setBTCDelegation(ctx, btcDel)
if !btcDel.HasInclusionProof() {
return
}
// notify subscriber about this unbonded BTC delegation
event := &types.EventBTCDelegationStateUpdate{
StakingTxHash: btcDel.MustGetStakingTxHash().String(),
NewState: types.BTCDelegationStatus_UNBONDED,
}
// record event that the BTC delegation becomes unbonded at this height
unbondedEvent := types.NewEventPowerDistUpdateWithBTCDel(event)
btcTip := k.btclcKeeper.GetTipInfo(ctx)
k.addPowerDistUpdateEvent(ctx, btcTip.Height, unbondedEvent)
}
func (k Keeper) setBTCDelegation(ctx context.Context, btcDel *types.BTCDelegation) {
store := k.btcDelegationStore(ctx)
stakingTxHash := btcDel.MustGetStakingTxHash()
btcDelBytes := k.cdc.MustMarshal(btcDel)
store.Set(stakingTxHash[:], btcDelBytes)
}
// GetBTCDelegation gets the BTC delegation with a given staking tx hash
func (k Keeper) GetBTCDelegation(ctx context.Context, stakingTxHashStr string) (*types.BTCDelegation, error) {
// decode staking tx hash string
stakingTxHash, err := chainhash.NewHashFromStr(stakingTxHashStr)
if err != nil {
return nil, err
}
btcDel := k.getBTCDelegation(ctx, *stakingTxHash)
if btcDel == nil {
return nil, types.ErrBTCDelegationNotFound
}
return btcDel, nil
}
func (k Keeper) getBTCDelegation(ctx context.Context, stakingTxHash chainhash.Hash) *types.BTCDelegation {
store := k.btcDelegationStore(ctx)
btcDelBytes := store.Get(stakingTxHash[:])
if len(btcDelBytes) == 0 {
return nil
}
var btcDel types.BTCDelegation
k.cdc.MustUnmarshal(btcDelBytes, &btcDel)
return &btcDel
}
// btcDelegationStore returns the KVStore of the BTC delegations
// prefix: BTCDelegationKey
// key: BTC delegation's staking tx hash
// value: BTCDelegation
func (k Keeper) btcDelegationStore(ctx context.Context) prefix.Store {
storeAdapter := runtime.KVStoreAdapter(k.storeService.OpenKVStore(ctx))
return prefix.NewStore(storeAdapter, types.BTCDelegationKey)
}