safe-wallet/apps/web/cypress/e2e/regression/spending_limits.cy.js

import * as constants from '../../support/constants'
import * as main from '../pages/main.page'
import * as spendinglimit from '../pages/spending_limits.pages'
import * as navigation from '../pages/navigation.page'
import * as tx from '../pages/create_tx.pages'
import * as ls from '../../support/localstorage_data.js'
import { getSafes, CATEGORIES } from '../../support/safes/safesHandler.js'
import * as wallet from '../../support/utils/wallet.js'
import { getMockAddress } from '../../support/utils/ethers.js'

let staticSafes = []
const walletCredentials = JSON.parse(Cypress.env('CYPRESS_WALLET_CREDENTIALS'))
const signer = walletCredentials.OWNER_4_PRIVATE_KEY
const signerAddress = walletCredentials.OWNER_4_WALLET_ADDRESS

const tokenAmount = 0.1
const newTokenAmount = 0.001
const spendingLimitBalance = '(0.15 ETH)'

describe('Spending limits tests', () => {
  before(async () => {
    staticSafes = await getSafes(CATEGORIES.static)
  })

  beforeEach(() => {
    cy.visit(constants.setupUrl + staticSafes.SEP_STATIC_SAFE_8)
    cy.get(spendinglimit.spendingLimitsSection).should('be.visible')
  })

  it('Verify resetAllowance and setAllowance actions are shown if a part of allowance was used', () => {
    wallet.connectSigner(signer)
    spendinglimit.clickOnNewSpendingLimitBtn()
    spendinglimit.enterBeneficiaryAddress(signerAddress)
    spendinglimit.enterSpendingLimitAmount(0.1)
    spendinglimit.clickOnNextBtn()
    spendinglimit.verifyActionCount(2)
    spendinglimit.verifyActionNames([spendinglimit.actionNames.resetAllowance, spendinglimit.actionNames.setAllowance])
  })

  it('Verify only setAllowance action is shown if allowance was not used', () => {
    cy.visit(constants.setupUrl + staticSafes.SEP_STATIC_SAFE_23)
    wallet.connectSigner(signer)
    spendinglimit.clickOnNewSpendingLimitBtn()
    spendinglimit.enterBeneficiaryAddress(signerAddress)
    spendinglimit.enterSpendingLimitAmount(0.1)
    spendinglimit.clickOnNextBtn()
    spendinglimit.verifyActionCount(0)
    spendinglimit.verifyDecodedTxSummary([spendinglimit.actionNames.setAllowance])
  })

  // Added to prod
  it('Verify that the Review step shows beneficiary, amount allowed, reset time', () => {
    //Assume that default reset time is set to One time
    wallet.connectSigner(signer)
    spendinglimit.clickOnNewSpendingLimitBtn()
    spendinglimit.enterBeneficiaryAddress(getMockAddress())
    spendinglimit.enterSpendingLimitAmount(0.1)
    spendinglimit.clickOnNextBtn()
    spendinglimit.checkReviewData(
      tokenAmount,
      getMockAddress(),
      spendinglimit.timePeriodOptions.oneTime.split(' ').join('-'),
    )
  })

  // Added to prod
  it('Verify values and trash icons are displayed in Beneficiary table', () => {
    spendinglimit.verifyBeneficiaryTable()
  })

  // Added to prod
  it('Verify Spending limit option is available when selecting the corresponding token', () => {
    wallet.connectSigner(signer)
    navigation.clickOnNewTxBtn()
    tx.clickOnSendTokensBtn()
    spendinglimit.verifyTxOptionExist([spendinglimit.spendingLimitTxOption])
  })

  it('Verify spending limit option shows available amount', () => {
    wallet.connectSigner(signer)
    navigation.clickOnNewTxBtn()
    tx.clickOnSendTokensBtn()
    spendinglimit.verifySpendingOptionShowsBalance([spendingLimitBalance])
  })

  it('Verify when owner is a delegate, standard tx and spending limit tx are present', () => {
    wallet.connectSigner(signer)
    navigation.clickOnNewTxBtn()
    tx.clickOnSendTokensBtn()
    spendinglimit.verifyTxOptionExist([spendinglimit.spendingLimitTxOption, spendinglimit.standardTx])
  })

  it('Verify when spending limit is selected the nonce field is removed', () => {
    wallet.connectSigner(signer)
    navigation.clickOnNewTxBtn()
    tx.clickOnSendTokensBtn()
    spendinglimit.selectSpendingLimitOption()
    spendinglimit.verifyNonceState(constants.elementExistanceStates.not_exist)
  })

  it('Verify "Max" button value set to be no more than the allowed amount', () => {
    wallet.connectSigner(signer)
    navigation.clickOnNewTxBtn()
    tx.clickOnSendTokensBtn()
    spendinglimit.clickOnMaxBtn()
    spendinglimit.checkMaxValue()
  })

  it('Verify selecting a native token from the dropdown in new tx', () => {
    wallet.connectSigner(signer)
    navigation.clickOnNewTxBtn()
    tx.clickOnSendTokensBtn()
    spendinglimit.selectToken(constants.tokenNames.sepoliaEther)
  })

  it('Verify that when replacing spending limit for the same owner, previous values are displayed in red', () => {
    wallet.connectSigner(signer)
    spendinglimit.clickOnNewSpendingLimitBtn()
    spendinglimit.enterBeneficiaryAddress(constants.DEFAULT_OWNER_ADDRESS)
    spendinglimit.enterSpendingLimitAmount(newTokenAmount)
    spendinglimit.clickOnTimePeriodDropdown()
    spendinglimit.selectTimePeriod(spendinglimit.timePeriodOptions.fiveMin)
    tx.clickOnNextBtn()
    spendinglimit.verifyOldValuesAreDisplayed()
  })

  it('Verify that when editing spending limit for owner who used some of it, relevant actions are displayed', () => {
    wallet.connectSigner(signer)
    spendinglimit.clickOnNewSpendingLimitBtn()
    spendinglimit.enterBeneficiaryAddress(constants.SPENDING_LIMIT_ADDRESS_2)
    spendinglimit.enterSpendingLimitAmount(newTokenAmount)
    spendinglimit.clickOnTimePeriodDropdown()
    spendinglimit.selectTimePeriod(spendinglimit.timePeriodOptions.oneTime)
    tx.clickOnNextBtn()
    spendinglimit.verifyActionNamesAreDisplayed([
      constants.TXActionNames.resetAllowance,
      constants.TXActionNames.setAllowance,
    ])
  })

  it('Verify that when multiple assets are available, they are displayed in token dropdown', () => {
    main.setupSafeSettingsWithAllTokens().then(() => {
      cy.reload()
      wallet.connectSigner(signer)
      navigation.clickOnNewTxBtn()
      tx.clickOnSendTokensBtn()
      spendinglimit.clickOnTokenDropdown()
      spendinglimit.verifyMandatoryTokensExist()
    })
  })

  it('Verify that beneficiary can be retried from address book', () => {
    cy.wrap(null)
      .then(() =>
        main.addToLocalStorage(constants.localStorageKeys.SAFE_v2__addressBook, ls.addressBookData.sepoliaAddress2),
      )
      .then(() =>
        main.isItemInLocalstorage(constants.localStorageKeys.SAFE_v2__addressBook, ls.addressBookData.sepoliaAddress2),
      )
      .then(() => {
        cy.reload()
        wallet.connectSigner(signer)
        spendinglimit.clickOnNewSpendingLimitBtn()
        spendinglimit.enterBeneficiaryAddress(constants.DEFAULT_OWNER_ADDRESS.substring(30))
        spendinglimit.selectRecipient(constants.DEFAULT_OWNER_ADDRESS)
      })
  })

  it('Verify explorer links contain Sepolia link', () => {
    tx.verifyNumberOfExternalLinks(3)
  })

  it('Verify that the enableModule action shows the correct AllowanceModule address for Sepolia', () => {
    spendinglimit.visitSpendingLimitsPage(staticSafes.SEP_STATIC_SAFE_47)
    wallet.connectSigner(signer)
    spendinglimit.clickOnNewSpendingLimitBtn()
    spendinglimit.enterBeneficiaryAddress(signerAddress)
    spendinglimit.enterSpendingLimitAmount(1)
    spendinglimit.clickOnNextBtn()

    spendinglimit.verifyActionNames([spendinglimit.actionNames.enableModule])
    spendinglimit.verifyEnableModuleAddress(constants.ALLOWANCE_MODULE_V0_1_0)
  })

  it('Verify that the enableModule action shows the correct AllowanceModule address for Polygon', () => {
    // setupSafeSettingsWithAllTokens is required: the Polygon safe has near-zero MATIC balance
    // which triggers the "hide small tokens" filter, leaving the token selector empty
    spendinglimit.visitSpendingLimitsPage(staticSafes.MATIC_STATIC_SAFE_34)
    main.setupSafeSettingsWithAllTokens().then(() => {
      spendinglimit.visitSpendingLimitsPage(staticSafes.MATIC_STATIC_SAFE_34)
      wallet.connectSigner(signer)
      spendinglimit.clickOnNewSpendingLimitBtn()
      spendinglimit.enterBeneficiaryAddress(signerAddress)
      spendinglimit.enterSpendingLimitAmount(1)
      spendinglimit.clickOnNextBtn()

      spendinglimit.verifyActionNames([spendinglimit.actionNames.enableModule])
      spendinglimit.verifyEnableModuleAddress(constants.ALLOWANCE_MODULE_V0_1_1)
    })
  })
})