Skip to content

Commit

Permalink
apply reviews
Browse files Browse the repository at this point in the history
  • Loading branch information
fbac committed Oct 28, 2024
1 parent 95c9237 commit 53be220
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 24 deletions.
3 changes: 3 additions & 0 deletions cmd/zetacored/config/prefixes.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ const (
// Bech32Prefix defines the Bech32 prefix used for Cronos Accounts
Bech32Prefix = "zeta"

// ZRC20DenomPrefix defines the prefix for ZRC20 tokens when converted to sdk.Coin.
ZRC20DenomPrefix = "zrc20/"

// Bech32PrefixAccAddr defines the Bech32 prefix of an account's address
Bech32PrefixAccAddr = Bech32Prefix
// Bech32PrefixAccPub defines the Bech32 prefix of an account's public key
Expand Down
14 changes: 6 additions & 8 deletions e2e/e2etests/test_precompiles_distribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"math/big"

"github.com/cosmos/cosmos-sdk/types"
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
"github.com/ethereum/go-ethereum/common"
"github.com/stretchr/testify/require"
Expand All @@ -22,7 +21,6 @@ func TestPrecompilesDistribute(r *runner.E2ERunner, args []string) {
var (
spenderAddress = r.EVMAddress()
distributeContractAddress = staking.ContractAddress
feeCollectorAddress = authtypes.NewModuleAddress("fee_collector")
lockerAddress = bank.ContractAddress

zrc20Address = r.ERC20ZRC20Addr
Expand Down Expand Up @@ -57,7 +55,7 @@ func TestPrecompilesDistribute(r *runner.E2ERunner, args []string) {
// Check initial balances.
balanceShouldBe(r, 1000, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 0, checkZRC20Balance(r, lockerAddress))
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

tx, err := dstrContract.Distribute(r.ZEVMAuth, zrc20Address, oneThousand)
require.NoError(r, err)
Expand All @@ -67,7 +65,7 @@ func TestPrecompilesDistribute(r *runner.E2ERunner, args []string) {
// Balances shouldn't change after a failed attempt.
balanceShouldBe(r, 1000, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 0, checkZRC20Balance(r, lockerAddress))
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

// Allow 500.
approveAllowance(r, distributeContractAddress, fiveHundred)
Expand All @@ -81,7 +79,7 @@ func TestPrecompilesDistribute(r *runner.E2ERunner, args []string) {
// Balances shouldn't change after a failed attempt.
balanceShouldBe(r, 1000, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 0, checkZRC20Balance(r, lockerAddress))
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

// Raise the allowance to 1000.
approveAllowance(r, distributeContractAddress, oneThousand)
Expand All @@ -95,7 +93,7 @@ func TestPrecompilesDistribute(r *runner.E2ERunner, args []string) {
// Balances shouldn't change after a failed attempt.
balanceShouldBe(r, 1000, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 0, checkZRC20Balance(r, lockerAddress))
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

// Should be able to distribute 500, which is within balance and allowance.
tx, err = dstrContract.Distribute(r.ZEVMAuth, zrc20Address, fiveHundred)
Expand All @@ -105,7 +103,7 @@ func TestPrecompilesDistribute(r *runner.E2ERunner, args []string) {

balanceShouldBe(r, 500, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 500, checkZRC20Balance(r, lockerAddress))
balanceShouldBe(r, 500, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 500, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

eventDitributed, err := dstrContract.ParseDistributed(*receipt.Logs[0])
require.NoError(r, err)
Expand All @@ -115,7 +113,7 @@ func TestPrecompilesDistribute(r *runner.E2ERunner, args []string) {

// After one block the rewards should have been distributed and fee collector should have 0 ZRC20 balance.
r.WaitForBlocks(1)
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

// DO NOT REMOVE THE FOLLOWING CODE
// This section is commented until a following PR introduces the ability to withdraw delegator rewards.
Expand Down
14 changes: 6 additions & 8 deletions e2e/e2etests/test_precompiles_distribute_through_contract.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package e2etests
import (
"math/big"

authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/types"
"github.com/stretchr/testify/require"
Expand All @@ -22,7 +21,6 @@ func TestPrecompilesDistributeThroughContract(r *runner.E2ERunner, args []string
var (
spenderAddress = r.EVMAddress()
distributeContractAddress = staking.ContractAddress
feeCollectorAddress = authtypes.NewModuleAddress("fee_collector")
lockerAddress = bank.ContractAddress

zrc20Address = r.ERC20ZRC20Addr
Expand Down Expand Up @@ -57,15 +55,15 @@ func TestPrecompilesDistributeThroughContract(r *runner.E2ERunner, args []string
// Check initial balances.
balanceShouldBe(r, 1000, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 500, checkZRC20Balance(r, lockerAddress)) // Carries 500 from distribute e2e.
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

receipt = distributeThroughContract(r, testDstrContract, zrc20Address, oneThousand)
utils.RequiredTxFailed(r, receipt, "distribute should fail when there's no allowance")

// Balances shouldn't change after a failed attempt.
balanceShouldBe(r, 1000, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 500, checkZRC20Balance(r, lockerAddress)) // Carries 500 from distribute e2e.
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

// Allow 500.
approveAllowance(r, distributeContractAddress, fiveHundred)
Expand All @@ -76,7 +74,7 @@ func TestPrecompilesDistributeThroughContract(r *runner.E2ERunner, args []string
// Balances shouldn't change after a failed attempt.
balanceShouldBe(r, 1000, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 500, checkZRC20Balance(r, lockerAddress)) // Carries 500 from distribute e2e.
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

// Raise the allowance to 1000.
approveAllowance(r, distributeContractAddress, oneThousand)
Expand All @@ -88,15 +86,15 @@ func TestPrecompilesDistributeThroughContract(r *runner.E2ERunner, args []string
// Balances shouldn't change after a failed attempt.
balanceShouldBe(r, 1000, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 500, checkZRC20Balance(r, lockerAddress)) // Carries 500 from distribute e2e.
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

// Should be able to distribute 500, which is within balance and allowance.
receipt = distributeThroughContract(r, testDstrContract, zrc20Address, fiveHundred)
utils.RequireTxSuccessful(r, receipt, "distribute should succeed when distributing within balance and allowance")

balanceShouldBe(r, 500, checkZRC20Balance(r, spenderAddress))
balanceShouldBe(r, 1000, checkZRC20Balance(r, lockerAddress)) // Carries 500 from distribute e2e.
balanceShouldBe(r, 500, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 500, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))

eventDitributed, err := dstrContract.ParseDistributed(*receipt.Logs[0])
require.NoError(r, err)
Expand All @@ -106,7 +104,7 @@ func TestPrecompilesDistributeThroughContract(r *runner.E2ERunner, args []string

// After one block the rewards should have been distributed and fee collector should have 0 ZRC20 balance.
r.WaitForBlocks(1)
balanceShouldBe(r, 0, checkCosmosBalance(r, feeCollectorAddress, zrc20Denom))
balanceShouldBe(r, 0, checkCosmosBalance(r, r.FeeCollectorAddress, zrc20Denom))
}

func distributeThroughContract(
Expand Down
4 changes: 4 additions & 0 deletions e2e/runner/runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"github.com/btcsuite/btcd/btcutil"
"github.com/btcsuite/btcd/chaincfg"
"github.com/btcsuite/btcd/rpcclient"
"github.com/cosmos/cosmos-sdk/types"
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
distributiontypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
Expand Down Expand Up @@ -75,6 +76,7 @@ type E2ERunner struct {
SolanaDeployerAddress solana.PublicKey
TONDeployer *tonrunner.Deployer
TONGateway *toncontracts.Gateway
FeeCollectorAddress types.AccAddress

// all clients.
// a reference to this type is required to enable creating a new E2ERunner.
Expand Down Expand Up @@ -189,6 +191,8 @@ func NewE2ERunner(

Account: account,

FeeCollectorAddress: authtypes.NewModuleAddress(authtypes.FeeCollectorName),

Clients: clients,

ZEVMClient: clients.Zevm,
Expand Down
1 change: 1 addition & 0 deletions precompiles/bank/bank.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ func NewIBankContract(
// This avoids instantiating it every time deposit or withdraw are called.
zrc20ABI, err := zrc20.ZRC20MetaData.GetAbi()
if err != nil {
ctx.Logger().Error("bank contract failed to get ZRC20 ABI", "error", err)
return nil
}

Expand Down
7 changes: 2 additions & 5 deletions precompiles/staking/method_distribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,11 @@ import (
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/vm"

"github.com/zeta-chain/node/precompiles/bank"
ptypes "github.com/zeta-chain/node/precompiles/types"
fungibletypes "github.com/zeta-chain/node/x/fungible/types"
)

var (
zrc20lockerAddress = common.HexToAddress("0x0000000000000000000000000000000000000067")
)

// function distribute(address zrc20, uint256 amount) external returns (bool success)
func (c *Contract) distribute(
ctx sdk.Context,
Expand Down Expand Up @@ -56,7 +53,7 @@ func (c *Contract) distribute(
// - spender is the staking contract address (c.Address()).
// - owner is the caller address.
// - locker is the bank address. Assets are locked under this address to prevent liquidity fragmentation.
if err := c.fungibleKeeper.LockZRC20(ctx, c.zrc20ABI, zrc20Addr, c.Address(), caller, zrc20lockerAddress, amount); err != nil {
if err := c.fungibleKeeper.LockZRC20(ctx, c.zrc20ABI, zrc20Addr, c.Address(), caller, bank.ContractAddress, amount); err != nil {
return nil, &ptypes.ErrUnexpected{
When: "LockZRC20InBank",
Got: err.Error(),
Expand Down
1 change: 1 addition & 0 deletions precompiles/staking/staking.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ func NewIStakingContract(
// This avoids instantiating it every time deposit or withdraw are called.
zrc20ABI, err := zrc20.ZRC20MetaData.GetAbi()
if err != nil {
ctx.Logger().Error("staking contract failed to get ZRC20 ABI", "error", err)
return nil
}

Expand Down
6 changes: 3 additions & 3 deletions precompiles/types/coin.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ import (
"cosmossdk.io/math"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/ethereum/go-ethereum/common"
)

const ZRC20DenomPrefix = "zrc20/"
"github.com/zeta-chain/node/cmd/zetacored/config"
)

// ZRC20ToCosmosDenom returns the cosmos coin address for a given ZRC20 address.
// This is converted to "zrc20/{ZRC20Address}".
func ZRC20ToCosmosDenom(ZRC20Address common.Address) string {
return ZRC20DenomPrefix + ZRC20Address.String()
return config.ZRC20DenomPrefix + ZRC20Address.String()
}

func CreateCoinSet(tokenDenom string, amount *big.Int) (sdk.Coins, error) {
Expand Down
1 change: 1 addition & 0 deletions x/fungible/keeper/zrc20_cosmos_coins_mapping.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ func (k Keeper) LockZRC20(
amount *big.Int,
) error {
// owner is the EOA owner of the ZRC20 tokens.
// spender is the EOA allowed to spend ZRC20 on owner's behalf.
// locker is the address that will lock the ZRC20 tokens, i.e: bank precompile.
if err := k.CheckZRC20Allowance(ctx, zrc20ABI, owner, spender, zrc20Address, amount); err != nil {
return errors.Wrap(err, "failed allowance check")
Expand Down

0 comments on commit 53be220

Please sign in to comment.