Skip to content

docs(tbtcpg,spv): document wallet-action package roles #4189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
piotr-roslaniec wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(tbtcpg,spv): document wallet-action package roles #4189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions pkg/maintainer/spv/spv.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
// Package spv implements the proof-maintenance half of the tBTC wallet-action
// domain. For each wallet action whose transaction has been executed on Bitcoin
// (deposit sweep, redemption, moving funds, moved funds sweep) it finds the
// unproven transactions and submits their SPV proofs to the host chain.
//
// Its counterpart is pkg/tbtcpg, the proposal-generation half, which decides
// which actions a wallet should take. The two packages deliberately mirror
// each other's file layout: a file here (deposit_sweep.go, redemptions.go,
// moving_funds.go, moved_funds_sweep.go) proves the transaction produced by
// the action whose proposal is generated by the same-named file there.
package spv

import (
Expand Down
13 changes: 13 additions & 0 deletions pkg/tbtcpg/tbtcpg.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
// Package tbtcpg implements the proposal-generation half of the tBTC
// wallet-action domain. For each wallet action (deposit sweep, redemption,
// moving funds, moved funds sweep, heartbeat) it inspects the host chain and
// Bitcoin state and produces the corresponding proposal for the wallet
// coordinator to consider.
//
// Its counterpart is pkg/maintainer/spv, the proof-maintenance half, which
// submits SPV proofs for the transactions these actions ultimately produce.
// The two packages deliberately mirror each other's file layout: for the
// actions that result in an on-chain transaction, a file here
// (deposit_sweep.go, redemptions.go, moving_funds.go, moved_funds_sweep.go)
// generates the proposal whose resulting transaction is proven by the
// same-named file there.
package tbtcpg

import (
Expand Down
Loading