philipp review changes

iotaledger · Aug 2, 2023 · 6d88589 · 6d88589
1 parent 7ad1c0d
commit 6d88589
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/output.go b/output.go
@@ -35,7 +35,7 @@ type Output interface {
 	NonEphemeralObject
 	ProcessableObject
 
-	// BaseTokenAmount the amount of base tokens held by this Output.
+	// BaseTokenAmount returns the amount of base tokens held by this Output.
 	BaseTokenAmount() BaseToken
 
 	// StoredMana returns the stored mana held by this output.
@@ -294,7 +294,7 @@ func (outputIDs OutputIDs) OrderedSet(set OutputSet) Outputs[Output] {
 }
 
 var (
-	// ErrAmountMustBeGreaterThanZero returned if the base token amount of an output is less or equal zero.
+	// ErrAmountMustBeGreaterThanZero gets returned if the base token amount of an output is less or equal zero.
 	ErrAmountMustBeGreaterThanZero = ierrors.New("base token amount must be greater than zero")
 	// ErrChainMissing gets returned when a chain is missing.
 	ErrChainMissing = ierrors.New("chain missing")
@@ -751,7 +751,7 @@ func OutputsSyntacticalDepositAmount(protoParams ProtocolParameters) OutputsSynt
 			case storageDep.Amount < minStorageDepositForReturnOutput:
 				return ierrors.Wrapf(ErrStorageDepositLessThanMinReturnOutputStorageDeposit, "output %d, needed %d, have %d", index, minStorageDepositForReturnOutput, storageDep.Amount)
 			case storageDep.Amount > amount:
-				return ierrors.Wrapf(ErrStorageDepositExceedsTargetOutputAmount, "output %d, target output's amount %d < storage deposit %d", index, amount, storageDep.Amount)
+				return ierrors.Wrapf(ErrStorageDepositExceedsTargetOutputAmount, "output %d, target output's base token amount %d < storage deposit %d", index, amount, storageDep.Amount)
 			}
 		}
 

diff --git a/transaction_essence.go b/transaction_essence.go
@@ -62,7 +62,7 @@ var (
 	// ErrOutputsSumExceedsTotalSupply gets returned if the sum of the output deposits exceeds the total supply of tokens.
 	ErrOutputsSumExceedsTotalSupply = ierrors.New("accumulated output balance exceeds total supply")
 	// ErrOutputAmountMoreThanTotalSupply gets returned if an output base token amount is more than the total supply.
-	ErrOutputAmountMoreThanTotalSupply = ierrors.New("an output can not have base token amount more than the total supply")
+	ErrOutputAmountMoreThanTotalSupply = ierrors.New("an output's base token amount cannot exceed the total supply")
 	// ErrStorageDepositLessThanMinReturnOutputStorageDeposit gets returned when the storage deposit condition's amount is less than the min storage deposit for the return output.
 	ErrStorageDepositLessThanMinReturnOutputStorageDeposit = ierrors.New("storage deposit return amount is less than the min storage deposit needed for the return output")
 	// ErrStorageDepositExceedsTargetOutputAmount gets returned when the storage deposit condition's amount exceeds the target output's base token amount.