e051743a3d
* v2-prototype: (21 commits) Don't use variables for revert reasons Add comments to dispatchTransferFrom Document IAssetData Compute bytes4 proxyid constants Return inplace bytes in LibBytes.readBytesWithLength Add Greg's documentation to MixinErc721Transfer Add Greg's documentation to MixinErc20Transfer Gas golf the transfer success logic Optimize like in PR #767 Run prettier and fix linting errors Fix tests Update tests Fix AssetProxyUtils Update tests Fix ERC721Proxy TokenId Update AssetProxyUtils Add IAssetData WIP ABI encoded asset data Remove proxyId argument from dispatchTransferFrom ... # Conflicts: # packages/contracts/test/asset_proxy/proxies.ts
324 lines
14 KiB
TypeScript
324 lines
14 KiB
TypeScript
import { BlockchainLifecycle } from '@0xproject/dev-utils';
|
|
import { assetProxyUtils } from '@0xproject/order-utils';
|
|
import { AssetProxyId, RevertReasons } from '@0xproject/types';
|
|
import { BigNumber } from '@0xproject/utils';
|
|
import * as chai from 'chai';
|
|
|
|
import { DummyERC20TokenContract } from '../../src/generated_contract_wrappers/dummy_e_r_c20_token';
|
|
import { ERC20ProxyContract } from '../../src/generated_contract_wrappers/e_r_c20_proxy';
|
|
import { ERC721ProxyContract } from '../../src/generated_contract_wrappers/e_r_c721_proxy';
|
|
import { TestAssetProxyDispatcherContract } from '../../src/generated_contract_wrappers/test_asset_proxy_dispatcher';
|
|
import { artifacts } from '../../src/utils/artifacts';
|
|
import { expectRevertReasonOrAlwaysFailingTransactionAsync } from '../../src/utils/assertions';
|
|
import { chaiSetup } from '../../src/utils/chai_setup';
|
|
import { constants } from '../../src/utils/constants';
|
|
import { ERC20Wrapper } from '../../src/utils/erc20_wrapper';
|
|
import { ERC721Wrapper } from '../../src/utils/erc721_wrapper';
|
|
import { provider, txDefaults, web3Wrapper } from '../../src/utils/web3_wrapper';
|
|
|
|
chaiSetup.configure();
|
|
const expect = chai.expect;
|
|
const blockchainLifecycle = new BlockchainLifecycle(web3Wrapper);
|
|
|
|
describe('AssetProxyDispatcher', () => {
|
|
let owner: string;
|
|
let notOwner: string;
|
|
let makerAddress: string;
|
|
let takerAddress: string;
|
|
|
|
let zrxToken: DummyERC20TokenContract;
|
|
let erc20Proxy: ERC20ProxyContract;
|
|
let erc721Proxy: ERC721ProxyContract;
|
|
let assetProxyDispatcher: TestAssetProxyDispatcherContract;
|
|
|
|
let erc20Wrapper: ERC20Wrapper;
|
|
let erc721Wrapper: ERC721Wrapper;
|
|
|
|
before(async () => {
|
|
await blockchainLifecycle.startAsync();
|
|
});
|
|
after(async () => {
|
|
await blockchainLifecycle.revertAsync();
|
|
});
|
|
before(async () => {
|
|
// Setup accounts & addresses
|
|
const accounts = await web3Wrapper.getAvailableAddressesAsync();
|
|
const usedAddresses = ([owner, notOwner, makerAddress, takerAddress] = accounts);
|
|
|
|
erc20Wrapper = new ERC20Wrapper(provider, usedAddresses, owner);
|
|
erc721Wrapper = new ERC721Wrapper(provider, usedAddresses, owner);
|
|
|
|
[zrxToken] = await erc20Wrapper.deployDummyTokensAsync();
|
|
erc20Proxy = await erc20Wrapper.deployProxyAsync();
|
|
await erc20Wrapper.setBalancesAndAllowancesAsync();
|
|
|
|
erc721Proxy = await erc721Wrapper.deployProxyAsync();
|
|
|
|
assetProxyDispatcher = await TestAssetProxyDispatcherContract.deployFrom0xArtifactAsync(
|
|
artifacts.TestAssetProxyDispatcher,
|
|
provider,
|
|
txDefaults,
|
|
);
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await erc20Proxy.addAuthorizedAddress.sendTransactionAsync(assetProxyDispatcher.address, {
|
|
from: owner,
|
|
}),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await erc721Proxy.addAuthorizedAddress.sendTransactionAsync(assetProxyDispatcher.address, {
|
|
from: owner,
|
|
}),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
});
|
|
beforeEach(async () => {
|
|
await blockchainLifecycle.startAsync();
|
|
});
|
|
afterEach(async () => {
|
|
await blockchainLifecycle.revertAsync();
|
|
});
|
|
describe('registerAssetProxy', () => {
|
|
it('should record proxy upon registration', async () => {
|
|
const prevProxyAddress = constants.NULL_ADDRESS;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
erc20Proxy.address,
|
|
prevProxyAddress,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
const proxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC20);
|
|
expect(proxyAddress).to.be.equal(erc20Proxy.address);
|
|
});
|
|
|
|
it('should be able to record multiple proxies', async () => {
|
|
// Record first proxy
|
|
const prevERC20ProxyAddress = constants.NULL_ADDRESS;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
erc20Proxy.address,
|
|
prevERC20ProxyAddress,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
let proxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC20);
|
|
expect(proxyAddress).to.be.equal(erc20Proxy.address);
|
|
// Record another proxy
|
|
const prevERC721ProxyAddress = constants.NULL_ADDRESS;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC721,
|
|
erc721Proxy.address,
|
|
prevERC721ProxyAddress,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
proxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC721);
|
|
expect(proxyAddress).to.be.equal(erc721Proxy.address);
|
|
});
|
|
|
|
it('should replace proxy address upon re-registration', async () => {
|
|
// Initial registration
|
|
const prevProxyAddress = constants.NULL_ADDRESS;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
erc20Proxy.address,
|
|
prevProxyAddress,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
let proxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC20);
|
|
expect(proxyAddress).to.be.equal(erc20Proxy.address);
|
|
// Deploy a new version of the ERC20 Transfer Proxy contract
|
|
const newErc20TransferProxy = await ERC20ProxyContract.deployFrom0xArtifactAsync(
|
|
artifacts.ERC20Proxy,
|
|
provider,
|
|
txDefaults,
|
|
);
|
|
// Register new ERC20 Transfer Proxy contract
|
|
const newAddress = newErc20TransferProxy.address;
|
|
const currentAddress = erc20Proxy.address;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
newAddress,
|
|
currentAddress,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
// Verify new asset proxy has replaced initial version
|
|
proxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC20);
|
|
expect(proxyAddress).to.be.equal(newAddress);
|
|
});
|
|
|
|
it('should throw if registering with incorrect "currentAssetProxyAddress" field', async () => {
|
|
// Initial registration
|
|
const prevProxyAddress = constants.NULL_ADDRESS;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
erc20Proxy.address,
|
|
prevProxyAddress,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
const proxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC20);
|
|
expect(proxyAddress).to.be.equal(erc20Proxy.address);
|
|
// The following transaction will throw because the currentAddress is no longer constants.NULL_ADDRESS
|
|
return expectRevertReasonOrAlwaysFailingTransactionAsync(
|
|
assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
erc20Proxy.address,
|
|
constants.NULL_ADDRESS,
|
|
{ from: owner },
|
|
),
|
|
RevertReasons.AssetProxyMismatch,
|
|
);
|
|
});
|
|
|
|
it('should be able to reset proxy address to NULL', async () => {
|
|
// Initial registration
|
|
const prevProxyAddress = constants.NULL_ADDRESS;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
erc20Proxy.address,
|
|
prevProxyAddress,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
const proxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC20);
|
|
expect(proxyAddress).to.be.equal(erc20Proxy.address);
|
|
// The following transaction will reset the proxy address
|
|
const newProxyAddress = constants.NULL_ADDRESS;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
newProxyAddress,
|
|
erc20Proxy.address,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
const finalProxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC20);
|
|
expect(finalProxyAddress).to.be.equal(newProxyAddress);
|
|
});
|
|
|
|
it('should throw if requesting address is not owner', async () => {
|
|
const prevProxyAddress = constants.NULL_ADDRESS;
|
|
return expectRevertReasonOrAlwaysFailingTransactionAsync(
|
|
assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
erc20Proxy.address,
|
|
prevProxyAddress,
|
|
{ from: notOwner },
|
|
),
|
|
RevertReasons.OnlyContractOwner,
|
|
);
|
|
});
|
|
|
|
it('should throw if attempting to register a proxy to the incorrect id', async () => {
|
|
const prevProxyAddress = constants.NULL_ADDRESS;
|
|
return expectRevertReasonOrAlwaysFailingTransactionAsync(
|
|
assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC721,
|
|
erc20Proxy.address,
|
|
prevProxyAddress,
|
|
{ from: owner },
|
|
),
|
|
RevertReasons.AssetProxyIdMismatch,
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('getAssetProxy', () => {
|
|
it('should return correct address of registered proxy', async () => {
|
|
const prevProxyAddress = constants.NULL_ADDRESS;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
erc20Proxy.address,
|
|
prevProxyAddress,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
const proxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC20);
|
|
expect(proxyAddress).to.be.equal(erc20Proxy.address);
|
|
});
|
|
|
|
it('should return NULL address if requesting non-existent proxy', async () => {
|
|
const proxyAddress = await assetProxyDispatcher.getAssetProxy.callAsync(AssetProxyId.ERC20);
|
|
expect(proxyAddress).to.be.equal(constants.NULL_ADDRESS);
|
|
});
|
|
});
|
|
|
|
describe('dispatchTransferFrom', () => {
|
|
it('should dispatch transfer to registered proxy', async () => {
|
|
// Register ERC20 proxy
|
|
const prevProxyAddress = constants.NULL_ADDRESS;
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.registerAssetProxy.sendTransactionAsync(
|
|
AssetProxyId.ERC20,
|
|
erc20Proxy.address,
|
|
prevProxyAddress,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
// Construct metadata for ERC20 proxy
|
|
const encodedAssetData = assetProxyUtils.encodeERC20AssetData(zrxToken.address);
|
|
|
|
// Perform a transfer from makerAddress to takerAddress
|
|
const erc20Balances = await erc20Wrapper.getBalancesAsync();
|
|
const amount = new BigNumber(10);
|
|
await web3Wrapper.awaitTransactionSuccessAsync(
|
|
await assetProxyDispatcher.publicDispatchTransferFrom.sendTransactionAsync(
|
|
encodedAssetData,
|
|
makerAddress,
|
|
takerAddress,
|
|
amount,
|
|
{ from: owner },
|
|
),
|
|
constants.AWAIT_TRANSACTION_MINED_MS,
|
|
);
|
|
// Verify transfer was successful
|
|
const newBalances = await erc20Wrapper.getBalancesAsync();
|
|
expect(newBalances[makerAddress][zrxToken.address]).to.be.bignumber.equal(
|
|
erc20Balances[makerAddress][zrxToken.address].minus(amount),
|
|
);
|
|
expect(newBalances[takerAddress][zrxToken.address]).to.be.bignumber.equal(
|
|
erc20Balances[takerAddress][zrxToken.address].add(amount),
|
|
);
|
|
});
|
|
|
|
it('should throw if dispatching to unregistered proxy', async () => {
|
|
// Construct metadata for ERC20 proxy
|
|
const encodedAssetData = assetProxyUtils.encodeERC20AssetData(zrxToken.address);
|
|
// Perform a transfer from makerAddress to takerAddress
|
|
const amount = new BigNumber(10);
|
|
return expectRevertReasonOrAlwaysFailingTransactionAsync(
|
|
assetProxyDispatcher.publicDispatchTransferFrom.sendTransactionAsync(
|
|
encodedAssetData,
|
|
makerAddress,
|
|
takerAddress,
|
|
amount,
|
|
{ from: owner },
|
|
),
|
|
RevertReasons.AssetProxyDoesNotExist,
|
|
);
|
|
});
|
|
});
|
|
});
|