Skip to content
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

Improve revert docstring #47

Merged
merged 1 commit into from
Apr 23, 2024
Merged

Improve revert docstring #47

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: 8 additions & 2 deletions wallet/update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,14 @@ type (
// removed.
ApplyIndex(index types.ChainIndex, created, spent []types.SiacoinElement, events []Event) error
// RevertIndex is called with the chain index that is being reverted.
// Any transactions and siacoin elements that were created by the index
// should be removed.
// Any transactions that were added by the index should be removed
//
// removed contains the siacoin elements that were created by the index
// and should be deleted.
//
// unspent contains the siacoin elements that were spent and should be
// recreated. They are not necessarily created by the index and should
// not be associated with it.
RevertIndex(index types.ChainIndex, removed, unspent []types.SiacoinElement) error
}
)
Expand Down
Loading