Merge pull request #719 from iotaledger/feat/benchmark-workscore

New WorkScoreParameters

Author: muXxer

go.mod

@@ -36,6 +36,7 @@ require (
 	github.com/multiformats/go-varint v0.0.7
 	github.com/otiai10/copy v1.14.0
 	github.com/prometheus/client_golang v1.18.0
+	github.com/sajari/regression v1.0.1
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.8.4
 	github.com/zyedidia/generic v1.2.1

go.sum

@@ -580,6 +580,8 @@ github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQD
 github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
 github.com/ryanuber/columnize v2.1.0+incompatible/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
 github.com/ryanuber/go-glob v1.0.0/go.mod h1:807d1WSdnB0XRJzKNil9Om6lcp/3a0v4qIHxIXzX/Yc=
+github.com/sajari/regression v1.0.1 h1:iTVc6ZACGCkoXC+8NdqH5tIreslDTT/bXxT6OmHR5PE=
+github.com/sajari/regression v1.0.1/go.mod h1:NeG/XTW1lYfGY7YV/Z0nYDV/RGh3wxwd1yW46835flM=
 github.com/samber/lo v1.39.0 h1:4gTz1wUhNYLhFSKl6O+8peW0v2F4BCY034GRpU9WnuA=
 github.com/samber/lo v1.39.0/go.mod h1:+m/ZKRl6ClXCE2Lgf3MsQlWfh4bn1bz6CXEOxnEXnEA=
 github.com/sasha-s/go-deadlock v0.3.1 h1:sqv7fDNShgjcaxkO0JNcOAlr8B9+cV5Ey/OB71efZx0=

pkg/tests/accounts_test.go

@@ -36,7 +36,7 @@ func Test_TransitionAndDestroyAccount(t *testing.T) {
 		// Nil address will be replaced with the address generated from genesis seed.
 		Address: nil,
 		// Set an amount enough to cover storage deposit and more issuer keys.
-		Amount: mock.MinIssuerAccountAmount(ts.API.ProtocolParameters()) * 10,
+		Amount: mock.MinIssuerAccountAmount(ts.API.ProtocolParameters()) * 2,
 		Mana:   0,
 		// AccountID is derived from this field, so this must be set uniquely for each account.
 		IssuerKey: oldGenesisOutputKey,
@@ -472,7 +472,13 @@ func Test_NegativeBIC_BlockIssuerLocked(t *testing.T) {
 	node1 := ts.AddValidatorNode("node1")
 	node2 := ts.AddNode("node2")
 
-	wallet1BIC := iotago.BlockIssuanceCredits(100_000_000)
+	testPayload := &iotago.TaggedData{}
+	testPayloadWorkScore := lo.PanicOnErr(testPayload.WorkScore(ts.API.ProtocolParameters().WorkScoreParameters()))
+	minRMC := ts.API.ProtocolParameters().CongestionControlParameters().MinReferenceManaCost
+	testPayloadCost := iotago.BlockIssuanceCredits(testPayloadWorkScore) * iotago.BlockIssuanceCredits(minRMC)
+
+	// wallet 1 starts with enough BIC to issue two test payloads
+	wallet1BIC := 2 * testPayloadCost
 	wallet2BIC := iotago.BlockIssuanceCredits(0)
 
 	wallet1 := ts.AddGenesisWallet("wallet 1", node2, testsuite.WithWalletBlockIssuanceCredits(wallet1BIC))
@@ -505,20 +511,13 @@ func Test_NegativeBIC_BlockIssuerLocked(t *testing.T) {
 	// MODIFY EXISTING GENESIS ACCOUNT
 	var block1Slot iotago.SlotIndex = 1
 	var latestParents []iotago.BlockID
-	// The cost of the block that will make the account go negative.
-	// We store it so we can allot that amount later to unlock it.
-	block12ManaCost := iotago.Mana(0)
 	// Issue one block from each of the two block-issuers - one will go negative and the other has enough BICs.
 	{
 		block1Commitment := iotago.NewEmptyCommitment(ts.API)
 		block1Commitment.ReferenceManaCost = ts.API.ProtocolParameters().CongestionControlParameters().MinReferenceManaCost
 		ts.SetCurrentSlot(block1Slot)
-		block11 := ts.IssueBasicBlockWithOptions("block1.1", wallet1, &iotago.TaggedData{}, mock.WithSlotCommitment(block1Commitment))
-		block12 := ts.IssueBasicBlockWithOptions("block1.2", wallet2, &iotago.TaggedData{}, mock.WithStrongParents(block11.ID()), mock.WithSlotCommitment(block1Commitment))
-
-		var err error
-		block12ManaCost, err = block12.ProtocolBlock().ManaCost(block1Commitment.ReferenceManaCost)
-		require.NoError(t, err)
+		block11 := ts.IssueBasicBlockWithOptions("block1.1", wallet1, testPayload, mock.WithSlotCommitment(block1Commitment))
+		block12 := ts.IssueBasicBlockWithOptions("block1.2", wallet2, testPayload, mock.WithStrongParents(block11.ID()), mock.WithSlotCommitment(block1Commitment))
 
 		// Commit BIC burns and check account states.
 		ts.CommitUntilSlot(ts.BlockID("block1.2").Slot(), block12.ID())
@@ -552,9 +551,9 @@ func Test_NegativeBIC_BlockIssuerLocked(t *testing.T) {
 	{
 		block2Commitment := node1.Protocol.Engines.Main.Get().SyncManager.LatestCommitment().Commitment()
 
-		block21 := ts.IssueBasicBlockWithOptions("block2.1", wallet1, &iotago.TaggedData{}, mock.WithSlotCommitment(block2Commitment))
+		block21 := ts.IssueBasicBlockWithOptions("block2.1", wallet1, testPayload, mock.WithSlotCommitment(block2Commitment))
 
-		block22 := ts.IssueBasicBlockWithOptions("block2.2", wallet2, &iotago.TaggedData{}, mock.WithStrongParents(ts.BlockID("block2.1")), mock.WithSlotCommitment(block2Commitment))
+		block22 := ts.IssueBasicBlockWithOptions("block2.2", wallet2, testPayload, mock.WithStrongParents(ts.BlockID("block2.1")), mock.WithSlotCommitment(block2Commitment))
 
 		ts.AssertBlockFiltered([]*blocks.Block{block22}, iotago.ErrAccountLocked, wallet2.Node)
 
@@ -586,7 +585,7 @@ func Test_NegativeBIC_BlockIssuerLocked(t *testing.T) {
 	// Allot some mana to the locked account to unlock it.
 	// The locked wallet 2 is preparing and signs the transaction, but it's issued by wallet 1 whose account is not locked.
 	{
-		allottedBIC := iotago.BlockIssuanceCredits(block12ManaCost)
+		allottedBIC := testPayloadCost
 		tx1 := wallet2.AllotManaFromInputs("TX1",
 			iotago.Allotments{&iotago.Allotment{
 				AccountID: wallet2.BlockIssuer.AccountID,
@@ -627,7 +626,7 @@ func Test_NegativeBIC_BlockIssuerLocked(t *testing.T) {
 	{
 		block4Commitment := node1.Protocol.Engines.Main.Get().SyncManager.LatestCommitment().Commitment()
 
-		block4 := ts.IssueBasicBlockWithOptions("block4", wallet2, &iotago.TaggedData{}, mock.WithStrongParents(latestParents...), mock.WithSlotCommitment(block4Commitment))
+		block4 := ts.IssueBasicBlockWithOptions("block4", wallet2, testPayload, mock.WithStrongParents(latestParents...), mock.WithSlotCommitment(block4Commitment))
 
 		ts.CommitUntilSlot(ts.BlockID("block4").Slot(), block4.ID())
 
@@ -768,7 +767,17 @@ func Test_NegativeBIC_AccountOutput(t *testing.T) {
 	// Allot some mana to the locked account to unlock it.
 	// The locked wallet 1 is preparing and signs the transaction, but it's issued by wallet 2 whose account is not locked.
 	{
-		allottedBIC := iotago.BlockIssuanceCredits(100_000_000)
+		// create a dummy TX of the kind we want wallet 1 to issue next, so we can calculate it's cost.
+		dummyTx := wallet1.TransitionAccount(
+			"TX3",
+			"Genesis:2",
+			mock.WithAddBlockIssuerKey(newWallet1IssuerKey),
+			mock.WithBlockIssuerExpirySlot(newExpirySlot),
+		)
+		dummyTxCost := iotago.BlockIssuanceCredits(lo.PanicOnErr(dummyTx.WorkScore(ts.API.ProtocolParameters().WorkScoreParameters()))) + iotago.BlockIssuanceCredits(ts.API.ProtocolParameters().CongestionControlParameters().MinReferenceManaCost)
+
+		// allot enough Mana to unlock the account AND cover the cost of the next transaction.
+		allottedBIC := dummyTxCost + 1
 		tx2 := wallet1.AllotManaFromInputs("TX2",
 			iotago.Allotments{&iotago.Allotment{
 				AccountID: wallet1.BlockIssuer.AccountID,

pkg/testsuite/mock/wallet.go

@@ -121,26 +121,26 @@ func (w *Wallet) TransactionID(alias string) iotago.TransactionID {
 	return lo.PanicOnErr(w.Transaction(alias).ID())
 }
 
-func (w *Wallet) Address() iotago.DirectUnlockableAddress {
-	address := w.keyManager.Address(iotago.AddressEd25519)
+func (w *Wallet) Address(index ...uint32) iotago.DirectUnlockableAddress {
+	address := w.keyManager.Address(iotago.AddressEd25519, index...)
 	//nolint:forcetypeassert
 	return address.(*iotago.Ed25519Address)
 }
 
-func (w *Wallet) ImplicitAccountCreationAddress() *iotago.ImplicitAccountCreationAddress {
-	address := w.keyManager.Address(iotago.AddressImplicitAccountCreation)
+func (w *Wallet) ImplicitAccountCreationAddress(index ...uint32) *iotago.ImplicitAccountCreationAddress {
+	address := w.keyManager.Address(iotago.AddressImplicitAccountCreation, index...)
 	//nolint:forcetypeassert
 	return address.(*iotago.ImplicitAccountCreationAddress)
 }
 
-func (w *Wallet) HasAddress(address iotago.Address) bool {
-	return address.Equal(w.Address()) || address.Equal(w.ImplicitAccountCreationAddress())
+func (w *Wallet) HasAddress(address iotago.Address, index ...uint32) bool {
+	return address.Equal(w.Address(index...)) || address.Equal(w.ImplicitAccountCreationAddress(index...))
 }
 
 func (w *Wallet) KeyPair() (ed25519.PrivateKey, ed25519.PublicKey) {
 	return w.keyManager.KeyPair()
 }
 
-func (w *Wallet) AddressSigner() iotago.AddressSigner {
-	return w.keyManager.AddressSigner()
+func (w *Wallet) AddressSigner(indexes ...uint32) iotago.AddressSigner {
+	return w.keyManager.AddressSigner(indexes...)
 }