Skip to content

Commit

Permalink
Add comment to help explain txntest.Txn rationale
Browse files Browse the repository at this point in the history
Adds commentary based on context found in algorand#2730.
  • Loading branch information
michaeldiamant committed Feb 4, 2022
1 parent f0b85f6 commit 7df7f75
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions data/txntest/txn.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,10 @@ import (
"github.com/algorand/go-algorand/protocol"
)

// Txn exists purely to make it easier to write a
// transaction.Transaction in Go source.
// Txn exists to simplify writing tests where transaction.Transaction might be unwieldy.
// Txn simplifies testing in these ways:
// * Provides a flat structure to simplify object construction.
// * Defines convenience methods to help setup test state.
type Txn struct {
Type protocol.TxType

Expand Down

0 comments on commit 7df7f75

Please sign in to comment.