-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CalculateGas integration-tests & improve deterministicgas docs (#706
- Loading branch information
Showing
8 changed files
with
316 additions
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,18 +3,25 @@ | |
| package modules | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "testing" | ||
|
|
||
| sdkmath "cosmossdk.io/math" | ||
| wasmtypes "github.com/CosmWasm/wasmd/x/wasm/types" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| cosmoserrors "github.com/cosmos/cosmos-sdk/types/errors" | ||
| authtypes "github.com/cosmos/cosmos-sdk/x/auth/types" | ||
| authztypes "github.com/cosmos/cosmos-sdk/x/authz" | ||
| banktypes "github.com/cosmos/cosmos-sdk/x/bank/types" | ||
| "github.com/samber/lo" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| integrationtests "github.com/CoreumFoundation/coreum/v3/integration-tests" | ||
| moduleswasm "github.com/CoreumFoundation/coreum/v3/integration-tests/contracts/modules" | ||
| "github.com/CoreumFoundation/coreum/v3/pkg/client" | ||
| "github.com/CoreumFoundation/coreum/v3/testutil/integration" | ||
| assetfttypes "github.com/CoreumFoundation/coreum/v3/x/asset/ft/types" | ||
| "github.com/CoreumFoundation/coreum/v3/x/deterministicgas" | ||
| ) | ||
|
|
||
| // TestAuthFeeLimits verifies that invalid message gas won't be accepted. | ||
|
|
@@ -126,22 +133,20 @@ func TestAuthMultisig(t *testing.T) { | |
| ctx, chain := integrationtests.NewCoreumTestingContext(t) | ||
| requireT := require.New(t) | ||
| recipient := chain.GenAccount() | ||
| amountToSendFromMultisigAccount := int64(1000) | ||
| amountToSendFromMultisigAccount := int64(1_000_000) | ||
|
|
||
| multisigPublicKey, keyNamesSet, err := chain.GenMultisigAccount(3, 2) | ||
| signersCount := 7 | ||
| multisigTreshold := 6 | ||
| multisigPublicKey, keyNamesSet, err := chain.GenMultisigAccount(signersCount, multisigTreshold) | ||
| requireT.NoError(err) | ||
| multisigAddress := sdk.AccAddress(multisigPublicKey.Address()) | ||
| signer1KeyName := keyNamesSet[0] | ||
| signer2KeyName := keyNamesSet[1] | ||
|
|
||
| bankClient := banktypes.NewQueryClient(chain.ClientContext) | ||
|
|
||
| // fund the multisig account | ||
| chain.FundAccountWithOptions(ctx, t, multisigAddress, integration.BalancesOptions{ | ||
| Messages: []sdk.Msg{&banktypes.MsgSend{}}, | ||
| Amount: sdkmath.NewInt(amountToSendFromMultisigAccount), | ||
| Amount: sdkmath.NewInt(amountToSendFromMultisigAccount), // for gas estimation to work wee need account to exist on chain so we fund it with to be sent amount. | ||
| }) | ||
|
|
||
| bankClient := banktypes.NewQueryClient(chain.ClientContext) | ||
|
|
||
| // prepare account to be funded from the multisig | ||
| recipientAddr := recipient.String() | ||
| coinsToSendToRecipient := sdk.NewCoins(chain.NewCoin(sdkmath.NewInt(amountToSendFromMultisigAccount))) | ||
|
|
@@ -151,26 +156,45 @@ func TestAuthMultisig(t *testing.T) { | |
| ToAddress: recipientAddr, | ||
| Amount: coinsToSendToRecipient, | ||
| } | ||
|
|
||
| _, gasEstimation, err := client.CalculateGas( | ||
| ctx, | ||
| chain.ClientContext.WithFromAddress(multisigAddress), | ||
| chain.TxFactory(), | ||
| bankSendMsg, | ||
| ) | ||
| requireT.NoError(err) | ||
|
|
||
| // fund the multisig account | ||
| chain.FundAccountWithOptions(ctx, t, multisigAddress, integration.BalancesOptions{ | ||
| Amount: sdkmath.NewInt(int64(gasEstimation)), // because of 6/7 multisig gas exceeds FixedGas, and we need to fund it to pay fees. | ||
| }) | ||
|
|
||
| _, err = chain.SignAndBroadcastMultisigTx( | ||
| ctx, | ||
| chain.ClientContext.WithFromAddress(multisigAddress), | ||
| // We intentionally use simulation instead of using `WithGas(chain.GasLimitByMsgs(bankSendMsg))`. | ||
| // We do it to test simulation for multisig account. | ||
| chain.TxFactory().WithSimulateAndExecute(true), | ||
| bankSendMsg, | ||
| signer1KeyName) | ||
| keyNamesSet[0]) | ||
| requireT.ErrorIs(err, cosmoserrors.ErrUnauthorized) | ||
| t.Log("Partially signed tx executed with expected error") | ||
|
|
||
| // sign and submit with the min threshold | ||
| txRes, err := chain.SignAndBroadcastMultisigTx( | ||
| ctx, | ||
| chain.ClientContext.WithFromAddress(multisigAddress), | ||
| chain.TxFactory().WithGas(chain.GasLimitByMsgs(bankSendMsg)), | ||
| chain.TxFactory().WithSimulateAndExecute(true), | ||
| bankSendMsg, | ||
| signer1KeyName, signer2KeyName) | ||
| keyNamesSet[:multisigTreshold]...) | ||
| requireT.NoError(err) | ||
| t.Logf("Fully signed tx executed, txHash:%s", txRes.TxHash) | ||
| t.Logf("Fully signed tx executed, txHash:%s, gasUsed:%d, gasWanted:%d", txRes.TxHash, txRes.GasUsed, txRes.GasWanted) | ||
|
|
||
| // Real gas used might be less that estimation for multisig account (especially when there are many signers) | ||
| // because in ConsumeTxSizeGasDecorator ([email protected]/x/auth/ante/basic.go:99) amount of bytes is estimated | ||
| // for the worst case. | ||
| requireT.LessOrEqual(txRes.GasUsed, int64(gasEstimation)) | ||
|
|
||
| recipientBalances, err := bankClient.AllBalances(ctx, &banktypes.QueryAllBalancesRequest{ | ||
| Address: recipientAddr, | ||
|
|
@@ -212,3 +236,182 @@ func TestAuthUnexpectedSequenceNumber(t *testing.T) { | |
| msg) | ||
| require.True(t, cosmoserrors.ErrWrongSequence.Is(err)) | ||
| } | ||
|
|
||
| func TestGasEstimation(t *testing.T) { | ||
| t.Parallel() | ||
| ctx, chain := integrationtests.NewCoreumTestingContext(t) | ||
|
|
||
| singlesigAddress := chain.GenAccount() | ||
|
|
||
| multisigPublicKey1, _, err := chain.GenMultisigAccount(3, 2) | ||
| require.NoError(t, err) | ||
| multisigAddress1 := sdk.AccAddress(multisigPublicKey1.Address()) | ||
|
|
||
| multisigPublicKey2, _, err := chain.GenMultisigAccount(7, 6) | ||
| require.NoError(t, err) | ||
| multisigAddress2 := sdk.AccAddress(multisigPublicKey2.Address()) | ||
|
|
||
| dgc := deterministicgas.DefaultConfig() | ||
| authParams, err := authtypes.NewQueryClient(chain.ClientContext).Params(ctx, &authtypes.QueryParamsRequest{}) | ||
| require.NoError(t, err) | ||
|
|
||
| // For accounts to exist on chain we need to fund them at least with min amount (1ucore). | ||
| chain.FundAccountWithOptions(ctx, t, singlesigAddress, integration.BalancesOptions{Amount: sdkmath.NewInt(1)}) | ||
| chain.FundAccountWithOptions(ctx, t, multisigAddress1, integration.BalancesOptions{Amount: sdkmath.NewInt(1)}) | ||
| chain.FundAccountWithOptions(ctx, t, multisigAddress2, integration.BalancesOptions{Amount: sdkmath.NewInt(1)}) | ||
|
|
||
| // For deterministic messages we are able to assert that gas estimation is equal to exact number. | ||
| testsDeterm := []struct { | ||
| name string | ||
| fromAddress sdk.AccAddress | ||
| msgs []sdk.Msg | ||
| expectedGas uint64 | ||
| }{ | ||
| { | ||
| name: "singlesig_bank_send", | ||
| fromAddress: singlesigAddress, | ||
| msgs: []sdk.Msg{ | ||
| &banktypes.MsgSend{ | ||
| FromAddress: singlesigAddress.String(), | ||
| ToAddress: singlesigAddress.String(), | ||
| Amount: sdk.NewCoins(chain.NewCoin(sdkmath.NewInt(1))), | ||
| }, | ||
| }, | ||
| // single signature no extra bytes. | ||
| expectedGas: dgc.FixedGas + 1*deterministicgas.BankSendPerCoinGas, | ||
| }, | ||
| { | ||
| name: "multisig_2_3_bank_send", | ||
| fromAddress: multisigAddress1, | ||
| msgs: []sdk.Msg{ | ||
| &banktypes.MsgSend{ | ||
| FromAddress: multisigAddress1.String(), | ||
| ToAddress: multisigAddress1.String(), | ||
| Amount: sdk.NewCoins(chain.NewCoin(sdkmath.NewInt(1))), | ||
| }, | ||
| }, | ||
| // single signature no extra bytes. | ||
| expectedGas: dgc.FixedGas + 1*deterministicgas.BankSendPerCoinGas, | ||
| }, | ||
| { | ||
| name: "multisig_6_7_bank_send", | ||
| fromAddress: multisigAddress2, | ||
| msgs: []sdk.Msg{ | ||
| &banktypes.MsgSend{ | ||
| FromAddress: multisigAddress2.String(), | ||
| ToAddress: multisigAddress2.String(), | ||
| Amount: sdk.NewCoins(chain.NewCoin(sdkmath.NewInt(1))), | ||
| }, | ||
| }, | ||
| // estimation uses worst case to estimate number of bytes in tx which causes possible overflow of free bytes. | ||
| // 10 is price for each extra byte over FreeBytes. | ||
| expectedGas: dgc.FixedGas + 1*deterministicgas.BankSendPerCoinGas + 1133*authParams.Params.TxSizeCostPerByte, | ||
| }, | ||
| { | ||
| name: "singlesig_auth_exec_and_bank_send", | ||
| fromAddress: singlesigAddress, | ||
| msgs: []sdk.Msg{ | ||
| lo.ToPtr( | ||
| authztypes.NewMsgExec(singlesigAddress, []sdk.Msg{ | ||
| &banktypes.MsgSend{ | ||
| FromAddress: singlesigAddress.String(), | ||
| ToAddress: singlesigAddress.String(), | ||
| Amount: sdk.NewCoins(chain.NewCoin(sdkmath.NewInt(1))), | ||
| }, | ||
| })), | ||
| &banktypes.MsgSend{ | ||
| FromAddress: singlesigAddress.String(), | ||
| ToAddress: singlesigAddress.String(), | ||
| Amount: sdk.NewCoins(chain.NewCoin(sdkmath.NewInt(1))), | ||
| }, | ||
| }, | ||
| // single signature no extra bytes. | ||
| expectedGas: dgc.FixedGas + 1*deterministicgas.BankSendPerCoinGas + (1*deterministicgas.AuthzExecOverhead + 1*deterministicgas.BankSendPerCoinGas), | ||
| }, | ||
| } | ||
| for _, tt := range testsDeterm { | ||
| tt := tt | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| _, estimatedGas, err := client.CalculateGas( | ||
| ctx, | ||
| chain.ClientContext.WithFromAddress(tt.fromAddress), | ||
| chain.TxFactory(), | ||
| tt.msgs..., | ||
| ) | ||
| require.NoError(t, err) | ||
| require.Equal(t, int(tt.expectedGas), int(estimatedGas)) | ||
| }) | ||
| } | ||
|
|
||
| // For non-deterministic messages we need to deploy a contract. | ||
| // Any address could be admin since we are not going to execute it but just estimate. | ||
| admin := chain.GenAccount() | ||
| chain.FundAccountWithOptions(ctx, t, admin, integration.BalancesOptions{Amount: sdkmath.NewInt(1_000_000)}) | ||
|
|
||
| initialPayload, err := json.Marshal(moduleswasm.SimpleState{ | ||
| Count: 1337, | ||
| }) | ||
| require.NoError(t, err) | ||
| contractAddr, _, err := chain.Wasm.DeployAndInstantiateWASMContract( | ||
| ctx, | ||
| chain.TxFactory().WithSimulateAndExecute(true), | ||
| admin, | ||
| moduleswasm.SimpleStateWASM, | ||
| integration.InstantiateConfig{ | ||
| AccessType: wasmtypes.AccessTypeUnspecified, | ||
| Payload: initialPayload, | ||
| Label: "simple_state", | ||
| }, | ||
| ) | ||
| require.NoError(t, err) | ||
|
|
||
| wasmPayload, err := moduleswasm.MethodToEmptyBodyPayload(moduleswasm.SimpleIncrement) | ||
| require.NoError(t, err) | ||
|
|
||
| // For non-deterministic messages we are unable to know exact number, so we do just basic assertion. | ||
| testsNonDeterm := []struct { | ||
| name string | ||
| fromAddress sdk.AccAddress | ||
| msgs []sdk.Msg | ||
| }{ | ||
| { | ||
| name: "singlesig_wasm_execute_contract", | ||
| fromAddress: singlesigAddress, | ||
| msgs: []sdk.Msg{ | ||
| &wasmtypes.MsgExecuteContract{ | ||
| Sender: singlesigAddress.String(), | ||
| Contract: contractAddr, | ||
| Msg: wasmtypes.RawContractMessage(wasmPayload), | ||
| Funds: sdk.Coins{}, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "multisig_2_3_wasm_execute_contract", | ||
| fromAddress: multisigAddress1, | ||
| msgs: []sdk.Msg{ | ||
| &wasmtypes.MsgExecuteContract{ | ||
| Sender: multisigAddress1.String(), | ||
| Contract: contractAddr, | ||
| Msg: wasmtypes.RawContractMessage(wasmPayload), | ||
| Funds: sdk.Coins{}, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| for _, tt := range testsNonDeterm { | ||
| tt := tt | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| _, estimatedGas, err := client.CalculateGas( | ||
| ctx, | ||
| chain.ClientContext.WithFromAddress(tt.fromAddress), | ||
| chain.TxFactory(), | ||
| tt.msgs..., | ||
| ) | ||
| require.NoError(t, err) | ||
| require.Greater(t, int(estimatedGas), 0) | ||
| }) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.