web3gbit-cli 1.0.0

package/lib/openzeppelin-contracts/test/token/ERC20/extensions/ERC20Capped.test.js

@@ -0,0 +1,55 @@
+const { ethers } = require('hardhat');
+const { expect } = require('chai');
+const { loadFixture } = require('@nomicfoundation/hardhat-network-helpers');
+
+const name = 'My Token';
+const symbol = 'MTKN';
+const cap = 1000n;
+
+async function fixture() {
+  const [user] = await ethers.getSigners();
+
+  const token = await ethers.deployContract('$ERC20Capped', [name, symbol, cap]);
+
+  return { user, token, cap };
+}
+
+describe('ERC20Capped', function () {
+  beforeEach(async function () {
+    Object.assign(this, await loadFixture(fixture));
+  });
+
+  it('requires a non-zero cap', async function () {
+    const ERC20Capped = await ethers.getContractFactory('$ERC20Capped');
+
+    await expect(ERC20Capped.deploy(name, symbol, 0))
+      .to.be.revertedWithCustomError(ERC20Capped, 'ERC20InvalidCap')
+      .withArgs(0);
+  });
+
+  describe('capped token', function () {
+    it('starts with the correct cap', async function () {
+      expect(await this.token.cap()).to.equal(this.cap);
+    });
+
+    it('mints when value is less than cap', async function () {
+      const value = this.cap - 1n;
+      await this.token.$_mint(this.user, value);
+      expect(await this.token.totalSupply()).to.equal(value);
+    });
+
+    it('fails to mint if the value exceeds the cap', async function () {
+      await this.token.$_mint(this.user, this.cap - 1n);
+      await expect(this.token.$_mint(this.user, 2))
+        .to.be.revertedWithCustomError(this.token, 'ERC20ExceededCap')
+        .withArgs(this.cap + 1n, this.cap);
+    });
+
+    it('fails to mint after cap is reached', async function () {
+      await this.token.$_mint(this.user, this.cap);
+      await expect(this.token.$_mint(this.user, 1))
+        .to.be.revertedWithCustomError(this.token, 'ERC20ExceededCap')
+        .withArgs(this.cap + 1n, this.cap);
+    });
+  });
+});

package/lib/openzeppelin-contracts/test/token/ERC20/extensions/ERC20Crosschain.test.js

@@ -0,0 +1,83 @@
+const { ethers } = require('hardhat');
+const { expect } = require('chai');
+const { anyValue } = require('@nomicfoundation/hardhat-chai-matchers/withArgs');
+const { loadFixture } = require('@nomicfoundation/hardhat-network-helpers');
+
+const { impersonate } = require('../../../helpers/account');
+const { getLocalChain } = require('../../../helpers/chains');
+
+const { shouldBehaveLikeBridgeERC20 } = require('../../../crosschain/BridgeERC20.behavior');
+
+async function fixture() {
+  const chain = await getLocalChain();
+  const accounts = await ethers.getSigners();
+
+  // Mock gateway
+  const gateway = await ethers.deployContract('$ERC7786GatewayMock');
+  const gatewayAsEOA = await impersonate(gateway);
+
+  // Chain A: legacy ERC20 with bridge
+  const tokenA = await ethers.deployContract('$ERC20Crosschain', ['Token1', 'T1', []]);
+  const bridgeA = tokenA; // self bridge
+
+  // Chain B: ERC7802 with bridge
+  const tokenB = await ethers.deployContract('$ERC20BridgeableMock', ['Token2', 'T2', ethers.ZeroAddress]);
+  const bridgeB = await ethers.deployContract('$BridgeERC7802', [[[gateway, chain.toErc7930(bridgeA)]], tokenB]);
+
+  // deployment check + counterpart setup
+  await expect(bridgeA.$_setLink(gateway, chain.toErc7930(bridgeB), false))
+    .to.emit(bridgeA, 'LinkRegistered')
+    .withArgs(gateway, chain.toErc7930(bridgeB));
+  await tokenB.$_setBridge(bridgeB);
+
+  return { chain, accounts, gateway, gatewayAsEOA, tokenA, tokenB, bridgeA, bridgeB };
+}
+
+describe('ERC20Crosschain', function () {
+  beforeEach(async function () {
+    Object.assign(this, await loadFixture(fixture));
+  });
+
+  shouldBehaveLikeBridgeERC20();
+
+  describe('crosschainTransferFrom', function () {
+    it('with allowance: success', async function () {
+      const [alice, bruce, chris] = this.accounts;
+      const amount = 100n;
+
+      await this.tokenA.$_mint(alice, amount);
+      await this.tokenA.connect(alice).approve(chris, ethers.MaxUint256);
+
+      // Alice sends tokens from chain A to Bruce on chain B.
+      await expect(this.tokenA.connect(chris).crosschainTransferFrom(alice, this.chain.toErc7930(bruce), amount))
+        // bridge on chain A takes custody of the funds
+        .to.emit(this.tokenA, 'Transfer')
+        .withArgs(alice, ethers.ZeroAddress, amount)
+        // crosschain transfer sent
+        .to.emit(this.tokenA, 'CrosschainERC20TransferSent')
+        .withArgs(anyValue, alice, this.chain.toErc7930(bruce), amount)
+        // ERC-7786 event
+        .to.emit(this.gateway, 'MessageSent')
+        // crosschain transfer received
+        .to.emit(this.bridgeB, 'CrosschainERC20TransferReceived')
+        .withArgs(anyValue, this.chain.toErc7930(alice), bruce, amount)
+        // crosschain mint event
+        .to.emit(this.tokenB, 'CrosschainMint')
+        .withArgs(bruce, amount, this.bridgeB)
+        // tokens are minted on chain B
+        .to.emit(this.tokenB, 'Transfer')
+        .withArgs(ethers.ZeroAddress, bruce, amount);
+    });
+
+    it('without allowance: revert', async function () {
+      const [alice, bruce, chris] = this.accounts;
+      const amount = 100n;
+
+      await this.tokenA.$_mint(alice, amount);
+
+      await expect(this.tokenA.connect(chris).crosschainTransferFrom(alice, this.chain.toErc7930(bruce), amount))
+        .to.be.revertedWithCustomError(this.tokenA, 'ERC20InsufficientAllowance')
+        .withArgs(chris, 0n, amount);
+    });
+  });
+});

package/lib/openzeppelin-contracts/test/token/ERC20/extensions/ERC20FlashMint.test.js

@@ -0,0 +1,164 @@
+const { ethers } = require('hardhat');
+const { expect } = require('chai');
+const { loadFixture } = require('@nomicfoundation/hardhat-network-helpers');
+
+const name = 'My Token';
+const symbol = 'MTKN';
+const initialSupply = 100n;
+const loanValue = 10_000_000_000_000n;
+
+async function fixture() {
+  const [holder, other] = await ethers.getSigners();
+
+  const token = await ethers.deployContract('$ERC20FlashMintMock', [name, symbol]);
+  await token.$_mint(holder, initialSupply);
+
+  return { holder, other, token };
+}
+
+describe('ERC20FlashMint', function () {
+  beforeEach(async function () {
+    Object.assign(this, await loadFixture(fixture));
+  });
+
+  describe('maxFlashLoan', function () {
+    it('token match', async function () {
+      expect(await this.token.maxFlashLoan(this.token)).to.equal(ethers.MaxUint256 - initialSupply);
+    });
+
+    it('token mismatch', async function () {
+      expect(await this.token.maxFlashLoan(ethers.ZeroAddress)).to.equal(0n);
+    });
+  });
+
+  describe('flashFee', function () {
+    it('token match', async function () {
+      expect(await this.token.flashFee(this.token, loanValue)).to.equal(0n);
+    });
+
+    it('token mismatch', async function () {
+      await expect(this.token.flashFee(ethers.ZeroAddress, loanValue))
+        .to.be.revertedWithCustomError(this.token, 'ERC3156UnsupportedToken')
+        .withArgs(ethers.ZeroAddress);
+    });
+  });
+
+  describe('flashFeeReceiver', function () {
+    it('default receiver', async function () {
+      expect(await this.token.$_flashFeeReceiver()).to.equal(ethers.ZeroAddress);
+    });
+  });
+
+  describe('flashLoan', function () {
+    it('success', async function () {
+      const receiver = await ethers.deployContract('ERC3156FlashBorrowerMock', [true, true]);
+
+      const tx = await this.token.flashLoan(receiver, this.token, loanValue, '0x');
+      await expect(tx)
+        .to.emit(this.token, 'Transfer')
+        .withArgs(ethers.ZeroAddress, receiver, loanValue)
+        .to.emit(this.token, 'Transfer')
+        .withArgs(receiver, ethers.ZeroAddress, loanValue)
+        .to.emit(receiver, 'BalanceOf')
+        .withArgs(this.token, receiver, loanValue)
+        .to.emit(receiver, 'TotalSupply')
+        .withArgs(this.token, initialSupply + loanValue);
+      await expect(tx).to.changeTokenBalance(this.token, receiver, 0);
+
+      expect(await this.token.totalSupply()).to.equal(initialSupply);
+      expect(await this.token.allowance(receiver, this.token)).to.equal(0n);
+    });
+
+    it('missing return value', async function () {
+      const receiver = await ethers.deployContract('ERC3156FlashBorrowerMock', [false, true]);
+      await expect(this.token.flashLoan(receiver, this.token, loanValue, '0x'))
+        .to.be.revertedWithCustomError(this.token, 'ERC3156InvalidReceiver')
+        .withArgs(receiver);
+    });
+
+    it('missing approval', async function () {
+      const receiver = await ethers.deployContract('ERC3156FlashBorrowerMock', [true, false]);
+      await expect(this.token.flashLoan(receiver, this.token, loanValue, '0x'))
+        .to.be.revertedWithCustomError(this.token, 'ERC20InsufficientAllowance')
+        .withArgs(this.token, 0, loanValue);
+    });
+
+    it('unavailable funds', async function () {
+      const receiver = await ethers.deployContract('ERC3156FlashBorrowerMock', [true, true]);
+      const data = this.token.interface.encodeFunctionData('transfer', [this.other.address, 10]);
+      await expect(this.token.flashLoan(receiver, this.token, loanValue, data))
+        .to.be.revertedWithCustomError(this.token, 'ERC20InsufficientBalance')
+        .withArgs(receiver, loanValue - 10n, loanValue);
+    });
+
+    it('more than maxFlashLoan', async function () {
+      const receiver = await ethers.deployContract('ERC3156FlashBorrowerMock', [true, true]);
+      const data = this.token.interface.encodeFunctionData('transfer', [this.other.address, 10]);
+      await expect(this.token.flashLoan(receiver, this.token, ethers.MaxUint256, data))
+        .to.be.revertedWithCustomError(this.token, 'ERC3156ExceededMaxLoan')
+        .withArgs(ethers.MaxUint256 - initialSupply);
+    });
+
+    describe('custom flash fee & custom fee receiver', function () {
+      const receiverInitialBalance = 200_000n;
+      const flashFee = 5_000n;
+
+      beforeEach('init receiver balance & set flash fee', async function () {
+        this.receiver = await ethers.deployContract('ERC3156FlashBorrowerMock', [true, true]);
+
+        const tx = await this.token.$_mint(this.receiver, receiverInitialBalance);
+        await expect(tx)
+          .to.emit(this.token, 'Transfer')
+          .withArgs(ethers.ZeroAddress, this.receiver, receiverInitialBalance);
+        await expect(tx).to.changeTokenBalance(this.token, this.receiver, receiverInitialBalance);
+
+        await this.token.setFlashFee(flashFee);
+        expect(await this.token.flashFee(this.token, loanValue)).to.equal(flashFee);
+      });
+
+      it('default flash fee receiver', async function () {
+        const tx = await this.token.flashLoan(this.receiver, this.token, loanValue, '0x');
+        await expect(tx)
+          .to.emit(this.token, 'Transfer')
+          .withArgs(ethers.ZeroAddress, this.receiver, loanValue)
+          .to.emit(this.token, 'Transfer')
+          .withArgs(this.receiver, ethers.ZeroAddress, loanValue + flashFee)
+          .to.emit(this.receiver, 'BalanceOf')
+          .withArgs(this.token, this.receiver, receiverInitialBalance + loanValue)
+          .to.emit(this.receiver, 'TotalSupply')
+          .withArgs(this.token, initialSupply + receiverInitialBalance + loanValue);
+        await expect(tx).to.changeTokenBalances(this.token, [this.receiver, ethers.ZeroAddress], [-flashFee, 0]);
+
+        expect(await this.token.totalSupply()).to.equal(initialSupply + receiverInitialBalance - flashFee);
+        expect(await this.token.allowance(this.receiver, this.token)).to.equal(0n);
+      });
+
+      it('custom flash fee receiver', async function () {
+        const flashFeeReceiverAddress = this.other;
+        await this.token.setFlashFeeReceiver(flashFeeReceiverAddress);
+        expect(await this.token.$_flashFeeReceiver()).to.equal(flashFeeReceiverAddress);
+
+        const tx = await this.token.flashLoan(this.receiver, this.token, loanValue, '0x');
+        await expect(tx)
+          .to.emit(this.token, 'Transfer')
+          .withArgs(ethers.ZeroAddress, this.receiver, loanValue)
+          .to.emit(this.token, 'Transfer')
+          .withArgs(this.receiver, ethers.ZeroAddress, loanValue)
+          .to.emit(this.token, 'Transfer')
+          .withArgs(this.receiver, flashFeeReceiverAddress, flashFee)
+          .to.emit(this.receiver, 'BalanceOf')
+          .withArgs(this.token, this.receiver, receiverInitialBalance + loanValue)
+          .to.emit(this.receiver, 'TotalSupply')
+          .withArgs(this.token, initialSupply + receiverInitialBalance + loanValue);
+        await expect(tx).to.changeTokenBalances(
+          this.token,
+          [this.receiver, flashFeeReceiverAddress],
+          [-flashFee, flashFee],
+        );
+
+        expect(await this.token.totalSupply()).to.equal(initialSupply + receiverInitialBalance);
+        expect(await this.token.allowance(this.receiver, flashFeeReceiverAddress)).to.equal(0n);
+      });
+    });
+  });
+});

package/lib/openzeppelin-contracts/test/token/ERC20/extensions/ERC20Pausable.test.js

@@ -0,0 +1,129 @@
+const { ethers } = require('hardhat');
+const { expect } = require('chai');
+const { loadFixture } = require('@nomicfoundation/hardhat-network-helpers');
+
+const name = 'My Token';
+const symbol = 'MTKN';
+const initialSupply = 100n;
+
+async function fixture() {
+  const [holder, recipient, approved] = await ethers.getSigners();
+
+  const token = await ethers.deployContract('$ERC20Pausable', [name, symbol]);
+  await token.$_mint(holder, initialSupply);
+
+  return { holder, recipient, approved, token };
+}
+
+describe('ERC20Pausable', function () {
+  beforeEach(async function () {
+    Object.assign(this, await loadFixture(fixture));
+  });
+
+  describe('pausable token', function () {
+    describe('transfer', function () {
+      it('allows to transfer when unpaused', async function () {
+        await expect(this.token.connect(this.holder).transfer(this.recipient, initialSupply)).to.changeTokenBalances(
+          this.token,
+          [this.holder, this.recipient],
+          [-initialSupply, initialSupply],
+        );
+      });
+
+      it('allows to transfer when paused and then unpaused', async function () {
+        await this.token.$_pause();
+        await this.token.$_unpause();
+
+        await expect(this.token.connect(this.holder).transfer(this.recipient, initialSupply)).to.changeTokenBalances(
+          this.token,
+          [this.holder, this.recipient],
+          [-initialSupply, initialSupply],
+        );
+      });
+
+      it('reverts when trying to transfer when paused', async function () {
+        await this.token.$_pause();
+
+        await expect(
+          this.token.connect(this.holder).transfer(this.recipient, initialSupply),
+        ).to.be.revertedWithCustomError(this.token, 'EnforcedPause');
+      });
+    });
+
+    describe('transfer from', function () {
+      const allowance = 40n;
+
+      beforeEach(async function () {
+        await this.token.connect(this.holder).approve(this.approved, allowance);
+      });
+
+      it('allows to transfer from when unpaused', async function () {
+        await expect(
+          this.token.connect(this.approved).transferFrom(this.holder, this.recipient, allowance),
+        ).to.changeTokenBalances(this.token, [this.holder, this.recipient], [-allowance, allowance]);
+      });
+
+      it('allows to transfer when paused and then unpaused', async function () {
+        await this.token.$_pause();
+        await this.token.$_unpause();
+
+        await expect(
+          this.token.connect(this.approved).transferFrom(this.holder, this.recipient, allowance),
+        ).to.changeTokenBalances(this.token, [this.holder, this.recipient], [-allowance, allowance]);
+      });
+
+      it('reverts when trying to transfer from when paused', async function () {
+        await this.token.$_pause();
+
+        await expect(
+          this.token.connect(this.approved).transferFrom(this.holder, this.recipient, allowance),
+        ).to.be.revertedWithCustomError(this.token, 'EnforcedPause');
+      });
+    });
+
+    describe('mint', function () {
+      const value = 42n;
+
+      it('allows to mint when unpaused', async function () {
+        await expect(this.token.$_mint(this.recipient, value)).to.changeTokenBalance(this.token, this.recipient, value);
+      });
+
+      it('allows to mint when paused and then unpaused', async function () {
+        await this.token.$_pause();
+        await this.token.$_unpause();
+
+        await expect(this.token.$_mint(this.recipient, value)).to.changeTokenBalance(this.token, this.recipient, value);
+      });
+
+      it('reverts when trying to mint when paused', async function () {
+        await this.token.$_pause();
+
+        await expect(this.token.$_mint(this.recipient, value)).to.be.revertedWithCustomError(
+          this.token,
+          'EnforcedPause',
+        );
+      });
+    });
+
+    describe('burn', function () {
+      const value = 42n;
+
+      it('allows to burn when unpaused', async function () {
+        await expect(this.token.$_burn(this.holder, value)).to.changeTokenBalance(this.token, this.holder, -value);
+      });
+
+      it('allows to burn when paused and then unpaused', async function () {
+        await this.token.$_pause();
+        await this.token.$_unpause();
+
+        await expect(this.token.$_burn(this.holder, value)).to.changeTokenBalance(this.token, this.holder, -value);
+      });
+
+      it('reverts when trying to burn when paused', async function () {
+        await this.token.$_pause();
+
+        await expect(this.token.$_burn(this.holder, value)).to.be.revertedWithCustomError(this.token, 'EnforcedPause');
+      });
+    });
+  });
+});

package/lib/openzeppelin-contracts/test/token/ERC20/extensions/ERC20Permit.test.js

@@ -0,0 +1,109 @@
+const { ethers } = require('hardhat');
+const { expect } = require('chai');
+const { loadFixture } = require('@nomicfoundation/hardhat-network-helpers');
+
+const { getDomain, domainSeparator, Permit } = require('../../../helpers/eip712');
+const time = require('../../../helpers/time');
+
+const name = 'My Token';
+const symbol = 'MTKN';
+const initialSupply = 100n;
+
+async function fixture() {
+  const [holder, spender, owner, other] = await ethers.getSigners();
+
+  const token = await ethers.deployContract('$ERC20Permit', [name, symbol, name]);
+  await token.$_mint(holder, initialSupply);
+
+  return {
+    holder,
+    spender,
+    owner,
+    other,
+    token,
+  };
+}
+
+describe('ERC20Permit', function () {
+  beforeEach(async function () {
+    Object.assign(this, await loadFixture(fixture));
+  });
+
+  it('initial nonce is 0', async function () {
+    expect(await this.token.nonces(this.holder)).to.equal(0n);
+  });
+
+  it('domain separator', async function () {
+    expect(await this.token.DOMAIN_SEPARATOR()).to.equal(await getDomain(this.token).then(domainSeparator));
+  });
+
+  describe('permit', function () {
+    const value = 42n;
+    const nonce = 0n;
+    const maxDeadline = ethers.MaxUint256;
+
+    beforeEach(function () {
+      this.buildData = (contract, deadline = maxDeadline) =>
+        getDomain(contract).then(domain => ({
+          domain,
+          types: { Permit },
+          message: {
+            owner: this.owner.address,
+            spender: this.spender.address,
+            value,
+            nonce,
+            deadline,
+          },
+        }));
+    });
+
+    it('accepts owner signature', async function () {
+      const { v, r, s } = await this.buildData(this.token)
+        .then(({ domain, types, message }) => this.owner.signTypedData(domain, types, message))
+        .then(ethers.Signature.from);
+
+      await this.token.permit(this.owner, this.spender, value, maxDeadline, v, r, s);
+
+      expect(await this.token.nonces(this.owner)).to.equal(1n);
+      expect(await this.token.allowance(this.owner, this.spender)).to.equal(value);
+    });
+
+    it('rejects reused signature', async function () {
+      const { v, r, s, serialized } = await this.buildData(this.token)
+        .then(({ domain, types, message }) => this.owner.signTypedData(domain, types, message))
+        .then(ethers.Signature.from);
+
+      await this.token.permit(this.owner, this.spender, value, maxDeadline, v, r, s);
+
+      const recovered = await this.buildData(this.token).then(({ domain, types, message }) =>
+        ethers.verifyTypedData(domain, types, { ...message, nonce: nonce + 1n, deadline: maxDeadline }, serialized),
+      );
+
+      await expect(this.token.permit(this.owner, this.spender, value, maxDeadline, v, r, s))
+        .to.be.revertedWithCustomError(this.token, 'ERC2612InvalidSigner')
+        .withArgs(recovered, this.owner);
+    });
+
+    it('rejects other signature', async function () {
+      const { v, r, s } = await this.buildData(this.token)
+        .then(({ domain, types, message }) => this.other.signTypedData(domain, types, message))
+        .then(ethers.Signature.from);
+
+      await expect(this.token.permit(this.owner, this.spender, value, maxDeadline, v, r, s))
+        .to.be.revertedWithCustomError(this.token, 'ERC2612InvalidSigner')
+        .withArgs(this.other, this.owner);
+    });
+
+    it('rejects expired permit', async function () {
+      const deadline = (await time.clock.timestamp()) - time.duration.weeks(1);
+
+      const { v, r, s } = await this.buildData(this.token, deadline)
+        .then(({ domain, types, message }) => this.owner.signTypedData(domain, types, message))
+        .then(ethers.Signature.from);
+
+      await expect(this.token.permit(this.owner, this.spender, value, deadline, v, r, s))
+        .to.be.revertedWithCustomError(this.token, 'ERC2612ExpiredSignature')
+        .withArgs(deadline);
+    });
+  });
+});