Merge pull request #1 from iotaledger/feat/cleanup

Test CI setup and cleanup old unused code

.github/workflows/build.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   build:
     name: Build evil-tools
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
     steps:
       - name: Set up Go
         uses: actions/setup-go@v4

.github/workflows/codeql_analysis.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   analyze:
     name: Analyze
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
     permissions:
       actions: read
       contents: read

.github/workflows/golangci-lint.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   golangci-lint:
     name: GolangCI-Lint
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
     steps:
       - name: Check out code into the Go module directory
         uses: actions/checkout@v3

accountwallet/commands.go

@@ -12,7 +12,7 @@ import (
 	"github.com/iotaledger/iota.go/v4/builder"
 )
 
-// CreateAccount creates an implicit account and immediatelly transition it to a regular account.
+// CreateAccount creates an implicit account and immediately transition it to a regular account.
 func (a *AccountWallet) CreateAccount(params *CreateAccountParams) (iotago.AccountID, error) {
 	if params.Implicit {
 		return a.createAccountImplicitly(params)
@@ -23,7 +23,7 @@ func (a *AccountWallet) CreateAccount(params *CreateAccountParams) (iotago.Accou
 
 func (a *AccountWallet) createAccountImplicitly(params *CreateAccountParams) (iotago.AccountID, error) {
 	// An implicit account has an implicitly defined Block Issuer Key, corresponding to the address itself.
-	// Thus implicit accounts can issue blocks by signing them with the private key corresponding to the public key
+	// Thus, implicit accounts can issue blocks by signing them with the private key corresponding to the public key
 	// from which the Implicit Account Creation Address was derived.
 	implicitAccountOutput, privateKey, err := a.getFunds(params.Amount, iotago.AddressImplicitAccountCreation)
 	if err != nil {
@@ -39,7 +39,12 @@ func (a *AccountWallet) createAccountImplicitly(params *CreateAccountParams) (io
 
 	log.Debugf("Transitioning implicit account with implicitAccountID %s for alias %s to regular account", params.Alias, iotago.AccountIDFromOutputID(implicitAccountOutput.OutputID).ToHex())
 
-	implicitAccAddr := iotago.ImplicitAccountCreationAddressFromPubKey(privateKey.Public().(ed25519.PublicKey))
+	pubKey, isEd25519 := privateKey.Public().(ed25519.PublicKey)
+	if !isEd25519 {
+		return iotago.EmptyAccountID, ierrors.New("Failed to create account: only Ed25519 keys are supported")
+	}
+
+	implicitAccAddr := iotago.ImplicitAccountCreationAddressFromPubKey(pubKey)
 	addrKeys := iotago.NewAddressKeysForImplicitAccountCreationAddress(implicitAccAddr, privateKey)
 	implicitBlockIssuerKey := iotago.Ed25519PublicKeyHashBlockIssuerKeyFromImplicitAccountCreationAddress(implicitAccAddr)
 	blockIssuerKeys := iotago.NewBlockIssuerKeys(implicitBlockIssuerKey)
@@ -52,7 +57,7 @@ func (a *AccountWallet) transitionImplicitAccount(
 	implicitAccAddr *iotago.ImplicitAccountCreationAddress,
 	accAddr iotago.Address,
 	blockIssuerKeys iotago.BlockIssuerKeys,
-	privateKey ed25519.PrivateKey,
+	_ ed25519.PrivateKey,
 	params *CreateAccountParams,
 ) (iotago.AccountID, error) {
 	// transition from implicit to regular account
@@ -62,12 +67,10 @@ func (a *AccountWallet) transitionImplicitAccount(
 		BlockIssuer(blockIssuerKeys, iotago.MaxSlotIndex).MustBuild()
 
 	log.Infof("Created account %s with %d tokens\n", accountOutput.AccountID.ToHex(), params.Amount)
-	txBuilder, err := a.createTransactionBuilder(implicitAccountOutput, implicitAccAddr, accountOutput)
-	if err != nil {
-		return iotago.EmptyAccountID, ierrors.Wrap(err, "Failed to create account")
-	}
+	txBuilder := a.createTransactionBuilder(implicitAccountOutput, implicitAccAddr, accountOutput)
+
 	// TODO get congestionResponse from API
-	var rmc iotago.Mana = 0
+	var rmc iotago.Mana
 	var implicitAccountID iotago.AccountID
 	txBuilder.AllotRequiredManaAndStoreRemainingManaInOutput(txBuilder.CreationSlot(), rmc, implicitAccountID, 0)
 
@@ -79,7 +82,7 @@ func (a *AccountWallet) transitionImplicitAccount(
 	return iotago.EmptyAccountID, nil
 }
 
-func (a *AccountWallet) createAccountWithFaucet(params *CreateAccountParams) (iotago.AccountID, error) {
+func (a *AccountWallet) createAccountWithFaucet(_ *CreateAccountParams) (iotago.AccountID, error) {
 	log.Debug("Not implemented yet")
 	//faucetOutput := a.getFaucetOutput()
 	//
@@ -94,7 +97,7 @@ func (a *AccountWallet) createAccountWithFaucet(params *CreateAccountParams) (io
 	return iotago.EmptyAccountID, nil
 }
 
-func (a *AccountWallet) createTransactionBuilder(input *models.Output, address iotago.Address, accountOutput *iotago.AccountOutput) (*builder.TransactionBuilder, error) {
+func (a *AccountWallet) createTransactionBuilder(input *models.Output, address iotago.Address, accountOutput *iotago.AccountOutput) *builder.TransactionBuilder {
 	currentTime := time.Now()
 	currentSlot := a.client.LatestAPI().TimeProvider().SlotFromTime(currentTime)
 
@@ -109,7 +112,7 @@ func (a *AccountWallet) createTransactionBuilder(input *models.Output, address i
 	txBuilder.AddOutput(accountOutput)
 	txBuilder.SetCreationSlot(currentSlot)
 
-	return txBuilder, nil
+	return txBuilder
 }
 
 func (a *AccountWallet) getAddress(addressType iotago.AddressType) (iotago.DirectUnlockableAddress, ed25519.PrivateKey, uint64) {
@@ -139,6 +142,6 @@ func (a *AccountWallet) ListAccount() error {
 	return nil
 }
 
-func (a *AccountWallet) AllotToAccount(params *AllotAccountParams) error {
+func (a *AccountWallet) AllotToAccount(_ *AllotAccountParams) error {
 	return nil
 }

accountwallet/config.go

@@ -15,7 +15,7 @@ type AccountOperation int
 const (
 	OperationCreateAccount AccountOperation = iota
 	OperationConvertAccount
-	OperationDestroyAccound
+	OperationDestroyAccount
 	OperationAllotAccount
 	OperationDelegateAccount
 	OperationStakeAccount
@@ -58,6 +58,7 @@ func AvailableCommands(cmd string) bool {
 	}
 
 	_, ok := availableCommands[cmd]
+
 	return ok
 }
 
@@ -66,7 +67,7 @@ type Configuration struct {
 	AccountStatesFile     string `json:"accountStatesFile,omitempty"`
 	GenesisSeed           string `json:"genesisSeed,omitempty"`
 	BlockIssuerPrivateKey string `json:"blockIssuerPrivateKey,omitempty"`
-	AccountID             string `json:"accountID,omitempty"`
+	AccountID             string `json:"accountId,omitempty"`
 }
 
 var accountConfigFile = "config.json"
@@ -150,7 +151,7 @@ type DestroyAccountParams struct {
 }
 
 func (d *DestroyAccountParams) Type() AccountOperation {
-	return OperationDestroyAccound
+	return OperationDestroyAccount
 }
 
 type AllotAccountParams struct {

accountwallet/faucet.go

@@ -152,6 +152,7 @@ func newFaucet(clt models.Client, faucetParams *faucetParams) (*faucet, error) {
 		return nil, ierrors.Wrap(err, "failed to get faucet output from indexer")
 	}
 
+	//nolint:all,forcetypassert
 	f.unspentOutput = &models.Output{
 		Address:      faucetAddr.(*iotago.Ed25519Address),
 		AddressIndex: 0,
@@ -203,12 +204,12 @@ func (f *faucet) prepareFaucetRequest(receiveAddr iotago.Address, amount iotago.
 		return nil, err
 	}
 
-	rmcAllotedTxBuilder := txBuilder.Clone()
+	rmcAllottedTxBuilder := txBuilder.Clone()
 	// faucet will allot exact mana to be burnt, rest of the mana is alloted to faucet output remainder
-	rmcAllotedTxBuilder.AllotRequiredManaAndStoreRemainingManaInOutput(txBuilder.CreationSlot(), rmc, f.account.ID(), remainderIndex)
+	rmcAllottedTxBuilder.AllotRequiredManaAndStoreRemainingManaInOutput(txBuilder.CreationSlot(), rmc, f.account.ID(), remainderIndex)
 
 	var signedTx *iotago.SignedTransaction
-	signedTx, err = rmcAllotedTxBuilder.Build(f.genesisHdWallet.AddressSigner())
+	signedTx, err = rmcAllottedTxBuilder.Build(f.genesisHdWallet.AddressSigner())
 	if err != nil {
 		log.Infof("WARN: failed to build tx with min required mana allotted, genesis potential mana was not enough, fallback to faucet account")
 		txBuilder.AllotAllMana(txBuilder.CreationSlot(), f.account.ID())
@@ -218,6 +219,7 @@ func (f *faucet) prepareFaucetRequest(receiveAddr iotago.Address, amount iotago.
 	}
 
 	// set remainder output to be reused by the Faucet wallet
+	//nolint:all,forcetypassert
 	f.unspentOutput = &models.Output{
 		OutputID:     iotago.OutputIDFromTransactionIDAndIndex(lo.PanicOnErr(signedTx.Transaction.ID()), uint16(remainderIndex)),
 		Address:      f.genesisHdWallet.Address(iotago.AddressEd25519).(*iotago.Ed25519Address),
@@ -236,6 +238,7 @@ func (f *faucet) createFaucetTransactionNoManaHandling(receiveAddr iotago.Addres
 	apiForSlot := f.clt.APIForSlot(currentSlot)
 	txBuilder := builder.NewTransactionBuilder(apiForSlot)
 
+	//nolint:all,forcetypassert
 	txBuilder.AddInput(&builder.TxInput{
 		UnlockTarget: f.genesisHdWallet.Address(iotago.AddressEd25519).(*iotago.Ed25519Address),
 		InputID:      f.unspentOutput.OutputID,
@@ -244,7 +247,7 @@ func (f *faucet) createFaucetTransactionNoManaHandling(receiveAddr iotago.Addres
 
 	remainderAmount, err := safemath.SafeSub(f.unspentOutput.Balance, amount)
 	if err != nil {
-		panic(err)
+		return nil, 0, ierrors.Errorf("safeSub failed %d - %d: %s", f.unspentOutput.Balance, amount, err)
 	}
 
 	txBuilder.AddOutput(&iotago.BasicOutput{
@@ -257,6 +260,7 @@ func (f *faucet) createFaucetTransactionNoManaHandling(receiveAddr iotago.Addres
 
 	// remainder output
 	remainderIndex := 1
+	//nolint:all,forcetypassert
 	txBuilder.AddOutput(&iotago.BasicOutput{
 		Amount: remainderAmount,
 		Conditions: iotago.BasicOutputUnlockConditions{

accountwallet/wallet.go

@@ -144,6 +144,7 @@ func (a *AccountWallet) fromAccountStateFile() error {
 		if !os.IsNotExist(err) {
 			return ierrors.Wrap(err, "failed to read file")
 		}
+
 		return nil
 	}
 
@@ -174,6 +175,7 @@ func (a *AccountWallet) fromAccountStateFile() error {
 	return nil
 }
 
+//nolint:all,unused
 func (a *AccountWallet) registerAccount(alias string, outputID iotago.OutputID, index uint64, privKey ed25519.PrivateKey) iotago.AccountID {
 	a.accountAliasesMutex.Lock()
 	defer a.accountAliasesMutex.Unlock()
@@ -259,7 +261,7 @@ func (a *AccountWallet) isAccountReady(accData *models.AccountData) bool {
 		}
 
 		if resp.Commitment.Slot >= creationSlot {
-			log.Infof("Slot %d commited, account %s is ready to use", creationSlot, accData.Alias)
+			log.Infof("Slot %d committed, account %s is ready to use", creationSlot, accData.Alias)
 			return true, nil
 		}
 
@@ -311,6 +313,7 @@ func (a *AccountWallet) destroyAccount(alias string) error {
 	})
 
 	// send all tokens to faucet
+	//nolint:all,forcetypassert
 	txBuilder.AddOutput(&iotago.BasicOutput{
 		Amount: accountOutput.BaseTokenAmount(),
 		Conditions: iotago.BasicOutputUnlockConditions{
@@ -337,6 +340,7 @@ func (a *AccountWallet) destroyAccount(alias string) error {
 	delete(a.accountsAliases, alias)
 
 	log.Infof("Account %s has been destroyed", alias)
+
 	return nil
 }
 

config.go

@@ -9,16 +9,14 @@ import (
 	"github.com/iotaledger/evil-tools/spammer"
 )
 
-// Nodes used during the test, use at least two nodes to be able to doublespend.
+// Nodes used during the test, use at least two nodes to be able to double spend.
 var (
 	// urls = []string{"http://bootstrap-01.feature.shimmer.iota.cafe:8080", "http://vanilla-01.feature.shimmer.iota.cafe:8080", "http://drng-01.feature.shimmer.iota.cafe:8080"}
 	urls = []string{"http://localhost:8080", "http://localhost:8090"} //, "http://localhost:8070", "http://localhost:8040"}
-	//urls = []string{}
 )
 
 var (
-	Script     = "basic"
-	Subcommand = ""
+	Script = ScriptSpammer
 
 	customSpamParams = programs.CustomSpamParams{
 		ClientURLs:            urls,
@@ -35,26 +33,5 @@ var (
 		AccountAlias:          accountwallet.FaucetAccountAlias,
 	}
 
-	quickTestParams = programs.QuickTestParams{
-		ClientURLs:            urls,
-		Rate:                  100,
-		Duration:              time.Second * 30,
-		TimeUnit:              time.Second,
-		DelayBetweenConflicts: 0,
-		EnableRateSetter:      false,
-	}
-
 	accountsSubcommandsFlags []accountwallet.AccountSubcommands
-
-	//nolint:godot
-	// commitmentsSpamParams = CommitmentsSpamParams{
-	// 	Rate:           1,
-	// 	Duration:       time.Second * 20,
-	// 	TimeUnit:       time.Second,
-	// 	NetworkAlias:   "docker",
-	// 	SpammerAlias:   "validator-1",
-	// 	ValidAlias:     accountwallet.FaucetAccountAlias,
-	// 	CommitmentType: "latest",
-	// 	ForkAfter:      10,
-	// }
 )

evilwallet/evilscenario.go

@@ -69,12 +69,12 @@ func NewEvilScenario(options ...ScenarioOption) *EvilScenario {
 		option(scenario)
 	}
 	scenario.ID = base58.Encode([]byte(fmt.Sprintf("%v%v%v", scenario.ConflictBatch, scenario.Reuse, scenario.OutputWallet.ID)))[:11]
-	scenario.NumOfClientsNeeded = calculateNumofClientsNeeded(scenario)
+	scenario.NumOfClientsNeeded = calculateNumOfClientsNeeded(scenario)
 
 	return scenario
 }
 
-func calculateNumofClientsNeeded(scenario *EvilScenario) (counter int) {
+func calculateNumOfClientsNeeded(scenario *EvilScenario) (counter int) {
 	for _, conflictMap := range scenario.ConflictBatch {
 		if len(conflictMap) > counter {
 			counter = len(conflictMap)