Allow to specify minted amount and max supply of native tokens

Author: jkrvivian

Diff for: pkg/tests/combined_account_transition_test.go

@@ -252,7 +252,7 @@ func createNativetoken(ts *testsuite.TestSuite) {
 	node1 := ts.Node("node1")
 	node2 := ts.Node("node2")
 
-	tx := wallet.CreateNativeTokenFromInput("TX7", "TX5:0", "TX4:0")
+	tx := wallet.CreateNativeTokenFromInput("TX7", "TX5:0", "TX4:0", 50_000, 100_000)
 	ts.IssueBasicBlockWithOptions("block6", wallet, tx)
 
 	ts.AssertTransactionsExist(wallet.Transactions("TX7"), true, node1)

Diff for: pkg/testsuite/mock/wallet_transactions.go

@@ -10,6 +10,7 @@ import (
 	"github.com/iotaledger/hive.go/lo"
 	"github.com/iotaledger/hive.go/runtime/options"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/utxoledger"
+	"github.com/iotaledger/iota-core/pkg/testsuite/depositcalculator"
 	iotago "github.com/iotaledger/iota.go/v4"
 	"github.com/iotaledger/iota.go/v4/builder"
 	"github.com/iotaledger/iota.go/v4/tpkg"
@@ -666,10 +667,18 @@ func (w *Wallet) CreateNFTFromInput(transactionName string, inputName string, op
 }
 
 //nolint:forcetypeassert
-func (w *Wallet) CreateNativeTokenFromInput(transactionName string, inputName string, accountOutputName string) *iotago.SignedTransaction {
+func (w *Wallet) CreateNativeTokenFromInput(transactionName string, inputName string, accountOutputName string, mintedAmount iotago.BaseToken, maxSupply iotago.BaseToken) *iotago.SignedTransaction {
 	input := w.Output(inputName)
 	accountOutput := w.AccountOutput(accountOutputName)
-	mintedAmount := input.BaseTokenAmount()
+
+	minMintedAmount := lo.PanicOnErr(depositcalculator.MinDeposit(w.Node.Protocol.CommittedAPI().ProtocolParameters(), iotago.OutputFoundry, depositcalculator.WithHasNativeToken()))
+	mintedAmount = lo.Max(minMintedAmount, mintedAmount)
+	maxSupply = lo.Max(maxSupply, mintedAmount)
+
+	if mintedAmount > input.BaseTokenAmount() {
+		panic(fmt.Sprintf("input %s does not have enough funds to mint native token", inputName))
+	}
+	remainderAmount := input.BaseTokenAmount() - mintedAmount
 
 	// transition account output, increase foundry counter by 1, the amount of account stays the same
 	accID := accountOutput.Output().(*iotago.AccountOutput).AccountID
@@ -681,7 +690,7 @@ func (w *Wallet) CreateNativeTokenFromInput(transactionName string, inputName st
 	foundryID, _ := iotago.FoundryIDFromAddressAndSerialNumberAndTokenScheme(accAddr, accTransitionOutput.FoundryCounter, iotago.TokenSchemeSimple)
 	tokenScheme := &iotago.SimpleTokenScheme{
 		MintedTokens:  big.NewInt(int64(mintedAmount)),
-		MaximumSupply: big.NewInt(int64(mintedAmount)),
+		MaximumSupply: big.NewInt(int64(maxSupply)),
 		MeltedTokens:  big.NewInt(0),
 	}
 
@@ -691,10 +700,22 @@ func (w *Wallet) CreateNativeTokenFromInput(transactionName string, inputName st
 			Amount: big.NewInt(int64(mintedAmount)),
 		}).MustBuild()
 
+	outputStates := iotago.Outputs[iotago.Output]{accTransitionOutput, foundryOutput}
+	// prepare remainder output if needed
+	if remainderAmount > 0 {
+		outputStates = append(outputStates, &iotago.BasicOutput{
+			Amount: remainderAmount,
+			UnlockConditions: iotago.BasicOutputUnlockConditions{
+				&iotago.AddressUnlockCondition{Address: w.Address()},
+			},
+			Features: iotago.BasicOutputFeatures{},
+		})
+	}
+
 	return w.createSignedTransactionWithOptions(
 		transactionName,
 		WithInputs(utxoledger.Outputs{accountOutput, input}),
-		WithOutputs(iotago.Outputs[iotago.Output]{accTransitionOutput, foundryOutput}),
+		WithOutputs(outputStates),
 		WithBlockIssuanceCreditInput(&iotago.BlockIssuanceCreditInput{
 			AccountID: accID,
 		}),

Diff for: tools/docker-network/tests/accounttransition_test.go

@@ -55,5 +55,5 @@ func Test_AccountTransitions(t *testing.T) {
 
 	// create native token
 	fmt.Println("\nCreating native token")
-	account2 = d.CreateNativeToken(account2)
+	account2 = d.CreateNativeToken(account2, 5000, 10000)
 }

Diff for: tools/docker-network/tests/dockerframework.go

@@ -22,6 +22,7 @@ import (
 	"github.com/iotaledger/hive.go/lo"
 	"github.com/iotaledger/hive.go/runtime/options"
 	"github.com/iotaledger/iota-core/pkg/protocol"
+	"github.com/iotaledger/iota-core/pkg/testsuite/depositcalculator"
 	"github.com/iotaledger/iota-core/pkg/testsuite/snapshotcreator"
 	iotago "github.com/iotaledger/iota.go/v4"
 	"github.com/iotaledger/iota.go/v4/api"
@@ -484,28 +485,35 @@ func (d *DockerTestFramework) AllotManaTo(from *Account, to *Account, manaToAllo
 }
 
 // CreateNativeToken request faucet funds then use it to create native token for the account, and returns the updated Account.
-func (d *DockerTestFramework) CreateNativeToken(from *Account) (updatedAccount *Account) {
+func (d *DockerTestFramework) CreateNativeToken(from *Account, mintedAmount iotago.BaseToken, maxSupply iotago.BaseToken) (updatedAccount *Account) {
 	// requesting faucet funds for native token creation
 	ctx := context.TODO()
 	fundsAddr, privateKey := d.getAddress(iotago.AddressEd25519)
 	fundsOutputID, fundsUTXOOutput := d.RequestFaucetFunds(ctx, fundsAddr)
 
-	mintedAmount := fundsUTXOOutput.BaseTokenAmount()
-
 	clt := d.Node("V1").Client
 	currentSlot := clt.LatestAPI().TimeProvider().SlotFromTime(time.Now())
 	apiForSlot := clt.APIForSlot(currentSlot)
 
+	minMintedAmount, err := depositcalculator.MinDeposit(apiForSlot.ProtocolParameters(), iotago.OutputFoundry, depositcalculator.WithHasNativeToken())
+	require.NoError(d.Testing, err)
+
+	mintedAmount = lo.Max(minMintedAmount, mintedAmount)
+	require.GreaterOrEqual(d.Testing, mintedAmount, fundsUTXOOutput.BaseTokenAmount())
+	maxSupply = lo.Max(maxSupply, mintedAmount)
+
+	remainderAmount := fundsUTXOOutput.BaseTokenAmount() - mintedAmount
+
 	// increase foundry counter
 	accTransitionOutput := builder.NewAccountOutputBuilderFromPrevious(from.AccountOutput).
 		FoundriesToGenerate(1).MustBuild()
 
-	// build foundry output, consume all amount from the UTXO output
+	// build foundry output
 	foundryID, err := iotago.FoundryIDFromAddressAndSerialNumberAndTokenScheme(from.AccountAddress, accTransitionOutput.FoundryCounter, iotago.TokenSchemeSimple)
 	require.NoError(d.Testing, err)
 	tokenScheme := &iotago.SimpleTokenScheme{
 		MintedTokens:  big.NewInt(int64(mintedAmount)),
-		MaximumSupply: big.NewInt(int64(mintedAmount)),
+		MaximumSupply: big.NewInt(int64(maxSupply)),
 		MeltedTokens:  big.NewInt(0),
 	}
 
@@ -515,17 +523,28 @@ func (d *DockerTestFramework) CreateNativeToken(from *Account) (updatedAccount *
 			Amount: big.NewInt(int64(mintedAmount)),
 		}).MustBuild()
 
-	// prepare transaction
+	addressKeys := []iotago.AddressKeys{
+		iotago.NewAddressKeysForEd25519Address(fundsAddr.(*iotago.Ed25519Address), privateKey),
+		iotago.NewAddressKeysForEd25519Address(from.AccountOutput.UnlockConditionSet().Address().Address.(*iotago.Ed25519Address), from.BlockIssuerKey),
+	}
+
+	signedTxBuilder := builder.NewTransactionBuilder(apiForSlot)
+
+	// prepare remainder output if needed
+	if remainderAmount > 0 {
+		receiveAddr, privKey := d.getAddress(iotago.AddressEd25519)
+		remainderOutput := builder.NewBasicOutputBuilder(receiveAddr, remainderAmount).MustBuild()
+		addressKeys = append(addressKeys, iotago.NewAddressKeysForEd25519Address(receiveAddr.(*iotago.Ed25519Address), privKey))
+		signedTxBuilder = signedTxBuilder.AddOutput(remainderOutput)
+	}
+
 	issuerResp, err := clt.BlockIssuance(ctx)
 	require.NoError(d.Testing, err)
 
 	congestionResp, err := clt.Congestion(ctx, from.AccountAddress, lo.PanicOnErr(issuerResp.LatestCommitment.ID()))
 	require.NoError(d.Testing, err)
 
-	signer := iotago.NewInMemoryAddressSigner(iotago.NewAddressKeysForEd25519Address(fundsAddr.(*iotago.Ed25519Address), privateKey),
-		iotago.NewAddressKeysForEd25519Address(from.AccountOutput.UnlockConditionSet().Address().Address.(*iotago.Ed25519Address), from.BlockIssuerKey))
-
-	signedTx, err := builder.NewTransactionBuilder(apiForSlot).
+	signedTx, err := signedTxBuilder.
 		AddInput(&builder.TxInput{
 			UnlockTarget: fundsAddr,
 			InputID:      fundsOutputID,
@@ -543,7 +562,7 @@ func (d *DockerTestFramework) CreateNativeToken(from *Account) (updatedAccount *
 		AddCommitmentInput(&iotago.CommitmentInput{CommitmentID: lo.Return1(issuerResp.LatestCommitment.ID())}).
 		WithTransactionCapabilities(iotago.TransactionCapabilitiesBitMaskWithCapabilities(iotago.WithTransactionCanDoAnything())).
 		AllotAllMana(currentSlot, from.AccountID).
-		Build(signer)
+		Build(iotago.NewInMemoryAddressSigner(addressKeys...))
 	require.NoError(d.Testing, err)
 
 	blkID := d.SubmitPayload(ctx, signedTx, wallet.NewEd25519Account(from.AccountID, from.BlockIssuerKey), congestionResp, issuerResp)