Skip to content

Commit

Permalink
Merge pull request #47 from SiaFoundation/nate/update-docstring
Browse files Browse the repository at this point in the history
Improve revert docstring
  • Loading branch information
ChrisSchinnerl committed Apr 23, 2024
2 parents a3dce82 + b100d0f commit 45aa6bf
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions wallet/update.go
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

0 comments on commit 45aa6bf

Please sign in to comment.