0g-chain/x/bep3/spec/06_begin_block.md
Denali Marsh 2d7f5c4080
[R4R] Better docs (#541)
* update sidebar order

* update event backticks

* fix broken links

* fix spelling
2020-06-03 14:54:31 -04:00

1.3 KiB

Begin Block

At the start of each block, atomic swaps that meet certain criteria are expired or deleted.

func BeginBlocker(ctx sdk.Context, k Keeper) {
	k.UpdateExpiredAtomicSwaps(ctx)
	k.DeleteClosedAtomicSwapsFromLongtermStorage(ctx)
}

Expiration

If an atomic swap's ExpireHeight is greater than the current block height, it will be expired. The logic to expire atomic swaps is as follows:

	var expiredSwapIDs []string
	k.IterateAtomicSwapsByBlock(ctx, uint64(ctx.BlockHeight()), func(id []byte) bool {
		atomicSwap, found := k.GetAtomicSwap(ctx, id)
		if !found {
			return false
		}
		// Expire the uncompleted swap and update both indexes
		atomicSwap.Status = types.Expired
		k.RemoveFromByBlockIndex(ctx, atomicSwap)
		k.SetAtomicSwap(ctx, atomicSwap)
		expiredSwapIDs = append(expiredSwapIDs, hex.EncodeToString(atomicSwap.GetSwapID()))
		return false
	})

Deletion

Atomic swaps are deleted 86400 blocks (one week, assuming a block time of 7 seconds) after being completed. The logic to delete atomic swaps is as follows:

k.IterateAtomicSwapsLongtermStorage(ctx, uint64(ctx.BlockHeight()), func(id []byte) bool {
	swap, found := k.GetAtomicSwap(ctx, id)
	if !found {
		return false
	}
	k.RemoveAtomicSwap(ctx, swap.GetSwapID())
	k.RemoveFromLongtermStorage(ctx, swap)
	return false
})