package geth_test import ( "encoding/json" "math/big" "reflect" "testing" "time" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/les/status" "github.com/ethereum/go-ethereum/rpc" "github.com/status-im/status-go/geth" ) func TestQueuedTransactions(t *testing.T) { err := geth.PrepareTestNode() if err != nil { t.Error(err) return } // obtain reference to status backend lightEthereum, err := geth.NodeManagerInstance().LightEthereumService() if err != nil { t.Errorf("Test failed: LES service is not running: %v", err) return } backend := lightEthereum.StatusBackend // make sure you panic if transaction complete doesn't return completeQueuedTransaction := make(chan struct{}, 1) geth.PanicAfter(20*time.Second, completeQueuedTransaction, "TestQueuedTransactions") // replace transaction notification handler var txHash = common.Hash{} geth.SetDefaultNodeNotificationHandler(func(jsonEvent string) { var envelope geth.SignalEnvelope if err := json.Unmarshal([]byte(jsonEvent), &envelope); err != nil { t.Errorf("cannot unmarshal event's JSON: %s", jsonEvent) return } if envelope.Type == geth.EventTransactionQueued { event := envelope.Event.(map[string]interface{}) t.Logf("transaction queued (will be completed in 5 secs): {id: %s}\n", event["id"].(string)) time.Sleep(5 * time.Second) if txHash, err = geth.CompleteTransaction(event["id"].(string), testAddressPassword); err != nil { t.Errorf("cannot complete queued transation[%v]: %v", event["id"], err) return } t.Logf("transaction complete: https://testnet.etherscan.io/tx/%s", txHash.Hex()) completeQueuedTransaction <- struct{}{} // so that timeout is aborted } }) // this call blocks, up until Complete Transaction is called txHashCheck, err := backend.SendTransaction(nil, status.SendTxArgs{ From: geth.FromAddress(testAddress), To: geth.ToAddress(testAddress1), Value: rpc.NewHexNumber(big.NewInt(1000000000000)), }) if err != nil { t.Errorf("Test failed: cannot send transaction: %v", err) } if !reflect.DeepEqual(txHash, txHashCheck) { t.Errorf("Transaction hash returned from SendTransaction is invalid: expected %s, got %s", txHashCheck, txHash) return } time.Sleep(10 * time.Second) if reflect.DeepEqual(txHashCheck, common.Hash{}) { t.Error("Test failed: transaction was never queued or completed") return } if backend.TransactionQueue().Count() != 0 { t.Error("tx queue must be empty at this point") return } } func TestDoubleCompleteQueuedTransactions(t *testing.T) { err := geth.PrepareTestNode() if err != nil { t.Error(err) return } // obtain reference to status backend lightEthereum, err := geth.NodeManagerInstance().LightEthereumService() if err != nil { t.Errorf("Test failed: LES service is not running: %v", err) return } backend := lightEthereum.StatusBackend // make sure you panic if transaction complete doesn't return completeQueuedTransaction := make(chan struct{}, 1) geth.PanicAfter(20*time.Second, completeQueuedTransaction, "TestQueuedTransactions") // replace transaction notification handler var txId string txFailedEventCalled := false txHash := common.Hash{} geth.SetDefaultNodeNotificationHandler(func(jsonEvent string) { var envelope geth.SignalEnvelope if err := json.Unmarshal([]byte(jsonEvent), &envelope); err != nil { t.Errorf("cannot unmarshal event's JSON: %s", jsonEvent) return } if envelope.Type == geth.EventTransactionQueued { event := envelope.Event.(map[string]interface{}) txId = event["id"].(string) t.Logf("transaction queued (will be failed and completed on the second call): {id: %s}\n", txId) // try with wrong password // make sure that tx is NOT removed from the queue (by re-trying with the correct password) if _, err = geth.CompleteTransaction(txId, testAddressPassword+"wrong"); err == nil { t.Error("expects wrong password error, but call succeeded") return } time.Sleep(1 * time.Second) // make sure that tx complete signal propagates if txCount := backend.TransactionQueue().Count(); txCount != 1 { t.Errorf("txqueue cannot be empty, as tx has failed: expected = 1, got = %d", txCount) return } // now try to complete transaction, but with the correct password t.Log("allow 5 seconds before sedning the second CompleteTransaction") time.Sleep(5 * time.Second) if txHash, err = geth.CompleteTransaction(event["id"].(string), testAddressPassword); err != nil { t.Errorf("cannot complete queued transation[%v]: %v", event["id"], err) return } time.Sleep(1 * time.Second) // make sure that tx complete signal propagates if txCount := backend.TransactionQueue().Count(); txCount != 0 { t.Errorf("txqueue must be empty, as tx has completed: expected = 0, got = %d", txCount) return } t.Logf("transaction complete: https://testnet.etherscan.io/tx/%s", txHash.Hex()) completeQueuedTransaction <- struct{}{} // so that timeout is aborted } if envelope.Type == geth.EventTransactionFailed { event := envelope.Event.(map[string]interface{}) t.Logf("transaction return event received: {id: %s}\n", event["id"].(string)) receivedErrMessage := event["error_message"].(string) expectedErrMessage := "could not decrypt key with given passphrase" if receivedErrMessage != expectedErrMessage { t.Errorf("unexpected error message received: got %v", receivedErrMessage) return } receivedErrCode := event["error_code"].(string) if receivedErrCode != geth.SendTransactionPasswordErrorCode { t.Errorf("unexpected error code received: got %v", receivedErrCode) return } txFailedEventCalled = true } }) // this call blocks, and should return on *second* attempt to CompleteTransaction (w/ the correct password) txHashCheck, err := backend.SendTransaction(nil, status.SendTxArgs{ From: geth.FromAddress(testAddress), To: geth.ToAddress(testAddress1), Value: rpc.NewHexNumber(big.NewInt(1000000000000)), }) if err != nil { t.Errorf("cannot send transaction: %v", err) return } if !reflect.DeepEqual(txHash, txHashCheck) { t.Errorf("tx hash returned from SendTransaction is invalid: expected %s, got %s", txHashCheck, txHash) return } if reflect.DeepEqual(txHashCheck, common.Hash{}) { t.Error("transaction was never queued or completed") return } if backend.TransactionQueue().Count() != 0 { t.Error("tx queue must be empty at this point") return } if !txFailedEventCalled { t.Error("expected tx failure signal is not received") return } t.Log("sleep extra time, to allow sync") time.Sleep(5 * time.Second) } func TestDiscardQueuedTransactions(t *testing.T) { err := geth.PrepareTestNode() if err != nil { t.Error(err) return } // obtain reference to status backend lightEthereum, err := geth.NodeManagerInstance().LightEthereumService() if err != nil { t.Errorf("Test failed: LES service is not running: %v", err) return } backend := lightEthereum.StatusBackend // reset queue backend.TransactionQueue().Reset() // make sure you panic if transaction complete doesn't return completeQueuedTransaction := make(chan struct{}, 1) geth.PanicAfter(20*time.Second, completeQueuedTransaction, "TestDiscardQueuedTransactions") // replace transaction notification handler var txId string txFailedEventCalled := false geth.SetDefaultNodeNotificationHandler(func(jsonEvent string) { var envelope geth.SignalEnvelope if err := json.Unmarshal([]byte(jsonEvent), &envelope); err != nil { t.Errorf("cannot unmarshal event's JSON: %s", jsonEvent) return } if envelope.Type == geth.EventTransactionQueued { event := envelope.Event.(map[string]interface{}) txId = event["id"].(string) t.Logf("transaction queued (will be discarded soon): {id: %s}\n", txId) if !backend.TransactionQueue().Has(status.QueuedTxId(txId)) { t.Errorf("txqueue should still have test tx: %s", txId) return } // discard err := geth.DiscardTransaction(txId) if err != nil { t.Errorf("cannot discard tx: %v", err) return } // try completing discarded transaction _, err = geth.CompleteTransaction(txId, testAddressPassword) if err.Error() != "transaction hash not found" { t.Error("expects tx not found, but call to CompleteTransaction succeeded") return } time.Sleep(1 * time.Second) // make sure that tx complete signal propagates if backend.TransactionQueue().Has(status.QueuedTxId(txId)) { t.Errorf("txqueue should not have test tx at this point (it should be discarded): %s", txId) return } completeQueuedTransaction <- struct{}{} // so that timeout is aborted } if envelope.Type == geth.EventTransactionFailed { event := envelope.Event.(map[string]interface{}) t.Logf("transaction return event received: {id: %s}\n", event["id"].(string)) receivedErrMessage := event["error_message"].(string) expectedErrMessage := status.ErrQueuedTxDiscarded.Error() if receivedErrMessage != expectedErrMessage { t.Errorf("unexpected error message received: got %v", receivedErrMessage) return } receivedErrCode := event["error_code"].(string) if receivedErrCode != geth.SendTransactionDiscardedErrorCode { t.Errorf("unexpected error code received: got %v", receivedErrCode) return } txFailedEventCalled = true } }) // this call blocks, and should return when DiscardQueuedTransaction() is called txHashCheck, err := backend.SendTransaction(nil, status.SendTxArgs{ From: geth.FromAddress(testAddress), To: geth.ToAddress(testAddress1), Value: rpc.NewHexNumber(big.NewInt(1000000000000)), }) if err != status.ErrQueuedTxDiscarded { t.Errorf("expected error not thrown: %v", err) return } if !reflect.DeepEqual(txHashCheck, common.Hash{}) { t.Error("transaction returned hash, while it shouldn't") return } if backend.TransactionQueue().Count() != 0 { t.Error("tx queue must be empty at this point") return } if !txFailedEventCalled { t.Error("expected tx failure signal is not received") return } t.Log("sleep extra time, to allow sync") time.Sleep(5 * time.Second) } func TestCompleteMultipleQueuedTransactions(t *testing.T) { err := geth.PrepareTestNode() if err != nil { t.Error(err) return } // obtain reference to status backend lightEthereum, err := geth.NodeManagerInstance().LightEthereumService() if err != nil { t.Errorf("Test failed: LES service is not running: %v", err) return } backend := lightEthereum.StatusBackend // reset queue backend.TransactionQueue().Reset() // make sure you panic if transaction complete doesn't return testTxCount := 3 txIds := make(chan string, testTxCount) allTestTxCompleted := make(chan struct{}, 1) // replace transaction notification handler geth.SetDefaultNodeNotificationHandler(func(jsonEvent string) { var txId string var envelope geth.SignalEnvelope if err := json.Unmarshal([]byte(jsonEvent), &envelope); err != nil { t.Errorf("cannot unmarshal event's JSON: %s", jsonEvent) return } if envelope.Type == geth.EventTransactionQueued { event := envelope.Event.(map[string]interface{}) txId = event["id"].(string) t.Logf("transaction queued (will be completed in a single call, once aggregated): {id: %s}\n", txId) txIds <- txId } }) // this call blocks, and should return when DiscardQueuedTransaction() for a given tx id is called sendTx := func() { txHashCheck, err := backend.SendTransaction(nil, status.SendTxArgs{ From: geth.FromAddress(testAddress), To: geth.ToAddress(testAddress1), Value: rpc.NewHexNumber(big.NewInt(1000000000000)), }) if err != nil { t.Errorf("unexpected error thrown: %v", err) return } if reflect.DeepEqual(txHashCheck, common.Hash{}) { t.Error("transaction returned empty hash") return } } // wait for transactions, and complete them in a single call completeTxs := func(txIdStrings string) { var parsedIds []string json.Unmarshal([]byte(txIdStrings), &parsedIds) parsedIds = append(parsedIds, "invalid-tx-id") updatedTxIdStrings, _ := json.Marshal(parsedIds) // complete results := geth.CompleteTransactions(string(updatedTxIdStrings), testAddressPassword) if len(results) != (testTxCount+1) || results["invalid-tx-id"].Error.Error() != "transaction hash not found" { t.Errorf("cannot complete txs: %v", results) return } for txId, txResult := range results { if txResult.Error != nil && txId != "invalid-tx-id" { t.Errorf("invalid error for %s", txId) return } if txResult.Hash.Hex() == "0x0000000000000000000000000000000000000000000000000000000000000000" && txId != "invalid-tx-id" { t.Errorf("invalid hash (expected non empty hash): %s", txId) return } if txResult.Hash.Hex() != "0x0000000000000000000000000000000000000000000000000000000000000000" { t.Logf("transaction complete: https://testnet.etherscan.io/tx/%s", txResult.Hash.Hex()) } } time.Sleep(1 * time.Second) // make sure that tx complete signal propagates for _, txId := range parsedIds { if backend.TransactionQueue().Has(status.QueuedTxId(txId)) { t.Errorf("txqueue should not have test tx at this point (it should be completed): %s", txId) return } } } go func() { var txIdStrings []string for i := 0; i < testTxCount; i++ { txIdStrings = append(txIdStrings, <-txIds) } txIdJSON, _ := json.Marshal(txIdStrings) completeTxs(string(txIdJSON)) allTestTxCompleted <- struct{}{} }() // send multiple transactions for i := 0; i < testTxCount; i++ { go sendTx() } select { case <-allTestTxCompleted: // pass case <-time.After(20 * time.Second): t.Error("test timed out") return } if backend.TransactionQueue().Count() != 0 { t.Error("tx queue must be empty at this point") return } } func TestDiscardMultipleQueuedTransactions(t *testing.T) { err := geth.PrepareTestNode() if err != nil { t.Error(err) return } // obtain reference to status backend lightEthereum, err := geth.NodeManagerInstance().LightEthereumService() if err != nil { t.Errorf("Test failed: LES service is not running: %v", err) return } backend := lightEthereum.StatusBackend // reset queue backend.TransactionQueue().Reset() // make sure you panic if transaction complete doesn't return testTxCount := 3 txIds := make(chan string, testTxCount) allTestTxDiscarded := make(chan struct{}, 1) // replace transaction notification handler txFailedEventCallCount := 0 geth.SetDefaultNodeNotificationHandler(func(jsonEvent string) { var txId string var envelope geth.SignalEnvelope if err := json.Unmarshal([]byte(jsonEvent), &envelope); err != nil { t.Errorf("cannot unmarshal event's JSON: %s", jsonEvent) return } if envelope.Type == geth.EventTransactionQueued { event := envelope.Event.(map[string]interface{}) txId = event["id"].(string) t.Logf("transaction queued (will be discarded soon): {id: %s}\n", txId) if !backend.TransactionQueue().Has(status.QueuedTxId(txId)) { t.Errorf("txqueue should still have test tx: %s", txId) return } txIds <- txId } if envelope.Type == geth.EventTransactionFailed { event := envelope.Event.(map[string]interface{}) t.Logf("transaction return event received: {id: %s}\n", event["id"].(string)) receivedErrMessage := event["error_message"].(string) expectedErrMessage := status.ErrQueuedTxDiscarded.Error() if receivedErrMessage != expectedErrMessage { t.Errorf("unexpected error message received: got %v", receivedErrMessage) return } receivedErrCode := event["error_code"].(string) if receivedErrCode != geth.SendTransactionDiscardedErrorCode { t.Errorf("unexpected error code received: got %v", receivedErrCode) return } txFailedEventCallCount++ if txFailedEventCallCount == testTxCount { allTestTxDiscarded <- struct{}{} } } }) // this call blocks, and should return when DiscardQueuedTransaction() for a given tx id is called sendTx := func() { txHashCheck, err := backend.SendTransaction(nil, status.SendTxArgs{ From: geth.FromAddress(testAddress), To: geth.ToAddress(testAddress1), Value: rpc.NewHexNumber(big.NewInt(1000000000000)), }) if err != status.ErrQueuedTxDiscarded { t.Errorf("expected error not thrown: %v", err) return } if !reflect.DeepEqual(txHashCheck, common.Hash{}) { t.Error("transaction returned hash, while it shouldn't") return } } // wait for transactions, and discard immediately discardTxs := func(txIdStrings string) { var parsedIds []string json.Unmarshal([]byte(txIdStrings), &parsedIds) parsedIds = append(parsedIds, "invalid-tx-id") updatedTxIdStrings, _ := json.Marshal(parsedIds) // discard discardResults := geth.DiscardTransactions(string(updatedTxIdStrings)) if len(discardResults) != 1 || discardResults["invalid-tx-id"].Error.Error() != "transaction hash not found" { t.Errorf("cannot discard txs: %v", discardResults) return } // try completing discarded transaction completeResults := geth.CompleteTransactions(string(updatedTxIdStrings), testAddressPassword) if len(completeResults) != (testTxCount + 1) { t.Error("unexpected number of errors (call to CompleteTransaction should not succeed)") } for _, txResult := range completeResults { if txResult.Error.Error() != "transaction hash not found" { t.Errorf("invalid error for %s", txResult.Hash.Hex()) return } if txResult.Hash.Hex() != "0x0000000000000000000000000000000000000000000000000000000000000000" { t.Errorf("invalid hash (expected zero): %s", txResult.Hash.Hex()) return } } time.Sleep(1 * time.Second) // make sure that tx complete signal propagates for _, txId := range parsedIds { if backend.TransactionQueue().Has(status.QueuedTxId(txId)) { t.Errorf("txqueue should not have test tx at this point (it should be discarded): %s", txId) return } } } go func() { var txIdStrings []string for i := 0; i < testTxCount; i++ { txIdStrings = append(txIdStrings, <-txIds) } txIdJSON, _ := json.Marshal(txIdStrings) discardTxs(string(txIdJSON)) }() // send multiple transactions for i := 0; i < testTxCount; i++ { go sendTx() } select { case <-allTestTxDiscarded: // pass case <-time.After(20 * time.Second): t.Error("test timed out") return } if backend.TransactionQueue().Count() != 0 { t.Error("tx queue must be empty at this point") return } } func TestNonExistentQueuedTransactions(t *testing.T) { err := geth.PrepareTestNode() if err != nil { t.Error(err) return } // make sure you panic if transaction complete doesn't return completeQueuedTransaction := make(chan struct{}, 1) geth.PanicAfter(20*time.Second, completeQueuedTransaction, "TestQueuedTransactions") // replace transaction notification handler var txHash = common.Hash{} geth.SetDefaultNodeNotificationHandler(func(jsonEvent string) { var envelope geth.SignalEnvelope if err := json.Unmarshal([]byte(jsonEvent), &envelope); err != nil { t.Errorf("cannot unmarshal event's JSON: %s", jsonEvent) return } if envelope.Type == geth.EventTransactionQueued { event := envelope.Event.(map[string]interface{}) t.Logf("Transaction queued (will be completed in 5 secs): {id: %s}\n", event["id"].(string)) time.Sleep(5 * time.Second) // next call is the very same one, but with the correct password if txHash, err = geth.CompleteTransaction(event["id"].(string), testAddressPassword); err != nil { t.Errorf("cannot complete queued transation[%v]: %v", event["id"], err) return } t.Logf("Transaction complete: https://testnet.etherscan.io/tx/%s", txHash.Hex()) completeQueuedTransaction <- struct{}{} // so that timeout is aborted } }) // try completing non-existing transaction if _, err = geth.CompleteTransaction("some-bad-transaction-id", testAddressPassword); err == nil { t.Error("error expected and not recieved") return } if err != status.ErrQueuedTxIdNotFound { t.Errorf("unexpected error recieved: expected '%s', got: '%s'", status.ErrQueuedTxIdNotFound.Error(), err.Error()) return } } func TestEvictionOfQueuedTransactions(t *testing.T) { err := geth.PrepareTestNode() if err != nil { t.Error(err) return } // obtain reference to status backend lightEthereum, err := geth.NodeManagerInstance().LightEthereumService() if err != nil { t.Errorf("Test failed: LES service is not running: %v", err) return } backend := lightEthereum.StatusBackend // make sure you panic if transaction complete doesn't return completeQueuedTransaction := make(chan struct{}, 1) geth.PanicAfter(20*time.Second, completeQueuedTransaction, "TestQueuedTransactions") // replace transaction notification handler var txHash = common.Hash{} geth.SetDefaultNodeNotificationHandler(func(jsonEvent string) { var envelope geth.SignalEnvelope if err := json.Unmarshal([]byte(jsonEvent), &envelope); err != nil { t.Errorf("cannot unmarshal event's JSON: %s", jsonEvent) return } if envelope.Type == geth.EventTransactionQueued { event := envelope.Event.(map[string]interface{}) t.Logf("Transaction queued (will be completed in 5 secs): {id: %s}\n", event["id"].(string)) time.Sleep(5 * time.Second) // next call is the very same one, but with the correct password if txHash, err = geth.CompleteTransaction(event["id"].(string), testAddressPassword); err != nil { t.Errorf("cannot complete queued transation[%v]: %v", event["id"], err) return } t.Logf("Transaction complete: https://testnet.etherscan.io/tx/%s", txHash.Hex()) completeQueuedTransaction <- struct{}{} // so that timeout is aborted } }) txQueue := backend.TransactionQueue() var i = 0 txIds := [status.DefaultTxQueueCap + 5 + 10]status.QueuedTxId{} backend.SetTransactionQueueHandler(func(queuedTx status.QueuedTx) { t.Logf("%d. Transaction queued (queue size: %d): {id: %v}\n", i, txQueue.Count(), queuedTx.Id) txIds[i] = queuedTx.Id i++ }) if txQueue.Count() != 0 { t.Errorf("transaction count should be zero: %d", txQueue.Count()) return } for i := 0; i < 10; i++ { go backend.SendTransaction(nil, status.SendTxArgs{}) } time.Sleep(3 * time.Second) t.Logf("Number of transactions queued: %d. Queue size (shouldn't be more than %d): %d", i, status.DefaultTxQueueCap, txQueue.Count()) if txQueue.Count() != 10 { t.Errorf("transaction count should be 10: got %d", txQueue.Count()) return } for i := 0; i < status.DefaultTxQueueCap+5; i++ { // stress test by hitting with lots of goroutines go backend.SendTransaction(nil, status.SendTxArgs{}) } time.Sleep(5 * time.Second) if txQueue.Count() > status.DefaultTxQueueCap { t.Errorf("transaction count should be %d (or %d): got %d", status.DefaultTxQueueCap, status.DefaultTxQueueCap-1, txQueue.Count()) return } for _, txId := range txIds { txQueue.Remove(txId) } if txQueue.Count() != 0 { t.Errorf("transaction count should be zero: %d", txQueue.Count()) return } }