openzeppelin-contracts/test/utils/escrow/Escrow.behavior.js

const { balance, ether, expectEvent, expectRevert } = require('@openzeppelin/test-helpers');

const { expect } = require('chai');

function shouldBehaveLikeEscrow(owner, [payee1, payee2]) {
  const amount = ether('42');

  describe('as an escrow', function () {
    describe('deposits', function () {
      it('can accept a single deposit', async function () {
        await this.escrow.deposit(payee1, { from: owner, value: amount });

        expect(await balance.current(this.escrow.address)).to.be.bignumber.equal(amount);

        expect(await this.escrow.depositsOf(payee1)).to.be.bignumber.equal(amount);
      });

      it('can accept an empty deposit', async function () {
        await this.escrow.deposit(payee1, { from: owner, value: 0 });
      });

      it('only the owner can deposit', async function () {
        await expectRevert(this.escrow.deposit(payee1, { from: payee2 }), 'Ownable: caller is not the owner');
      });

      it('emits a deposited event', async function () {
        const receipt = await this.escrow.deposit(payee1, { from: owner, value: amount });
        expectEvent(receipt, 'Deposited', {
          payee: payee1,
          weiAmount: amount,
        });
      });

      it('can add multiple deposits on a single account', async function () {
        await this.escrow.deposit(payee1, { from: owner, value: amount });
        await this.escrow.deposit(payee1, { from: owner, value: amount.muln(2) });

        expect(await balance.current(this.escrow.address)).to.be.bignumber.equal(amount.muln(3));

        expect(await this.escrow.depositsOf(payee1)).to.be.bignumber.equal(amount.muln(3));
      });

      it('can track deposits to multiple accounts', async function () {
        await this.escrow.deposit(payee1, { from: owner, value: amount });
        await this.escrow.deposit(payee2, { from: owner, value: amount.muln(2) });

        expect(await balance.current(this.escrow.address)).to.be.bignumber.equal(amount.muln(3));

        expect(await this.escrow.depositsOf(payee1)).to.be.bignumber.equal(amount);

        expect(await this.escrow.depositsOf(payee2)).to.be.bignumber.equal(amount.muln(2));
      });
    });

    describe('withdrawals', async function () {
      it('can withdraw payments', async function () {
        const balanceTracker = await balance.tracker(payee1);

        await this.escrow.deposit(payee1, { from: owner, value: amount });
        await this.escrow.withdraw(payee1, { from: owner });

        expect(await balanceTracker.delta()).to.be.bignumber.equal(amount);

        expect(await balance.current(this.escrow.address)).to.be.bignumber.equal('0');
        expect(await this.escrow.depositsOf(payee1)).to.be.bignumber.equal('0');
      });

      it('can do an empty withdrawal', async function () {
        await this.escrow.withdraw(payee1, { from: owner });
      });

      it('only the owner can withdraw', async function () {
        await expectRevert(this.escrow.withdraw(payee1, { from: payee1 }), 'Ownable: caller is not the owner');
      });

      it('emits a withdrawn event', async function () {
        await this.escrow.deposit(payee1, { from: owner, value: amount });
        const receipt = await this.escrow.withdraw(payee1, { from: owner });
        expectEvent(receipt, 'Withdrawn', {
          payee: payee1,
          weiAmount: amount,
        });
      });
    });
  });
}

module.exports = {
  shouldBehaveLikeEscrow,
};