322 lines
15 KiB
TypeScript
322 lines
15 KiB
TypeScript
import { Erc1155Wrapper } from '@0x/contracts-erc1155';
|
|
import {
|
|
constants,
|
|
ERC1155FungibleHoldingsByOwner,
|
|
ERC1155HoldingsByOwner,
|
|
ERC1155NonFungibleHoldingsByOwner,
|
|
LogDecoder,
|
|
txDefaults,
|
|
} from '@0x/contracts-test-utils';
|
|
import { assetDataUtils } from '@0x/order-utils';
|
|
import { BigNumber } from '@0x/utils';
|
|
import { Web3Wrapper } from '@0x/web3-wrapper';
|
|
import { Provider, TransactionReceiptWithDecodedLogs } from 'ethereum-types';
|
|
import * as _ from 'lodash';
|
|
|
|
import {
|
|
artifacts,
|
|
ERC1155MintableContract,
|
|
ERC1155ProxyContract,
|
|
IAssetProxyContract,
|
|
} from '../../src';
|
|
|
|
export class ERC1155ProxyWrapper {
|
|
private readonly _tokenOwnerAddresses: string[];
|
|
private readonly _fungibleTokenIds: string[];
|
|
private readonly _nonFungibleTokenIds: string[];
|
|
private readonly _nfts: Array<{ id: BigNumber; tokenId: BigNumber }>;
|
|
private readonly _contractOwnerAddress: string;
|
|
private readonly _web3Wrapper: Web3Wrapper;
|
|
private readonly _provider: Provider;
|
|
private readonly _logDecoder: LogDecoder;
|
|
private readonly _dummyTokenWrappers: Erc1155Wrapper[];
|
|
private readonly _assetProxyInterface: IAssetProxyContract;
|
|
private _proxyContract?: ERC1155ProxyContract;
|
|
private _proxyIdIfExists?: string;
|
|
private _initialTokenIdsByOwner: ERC1155HoldingsByOwner = { fungible: {}, nonFungible: {} };
|
|
|
|
constructor(provider: Provider, tokenOwnerAddresses: string[], contractOwnerAddress: string) {
|
|
this._web3Wrapper = new Web3Wrapper(provider);
|
|
this._provider = provider;
|
|
this._logDecoder = new LogDecoder(this._web3Wrapper, artifacts);
|
|
this._dummyTokenWrappers = [];
|
|
this._assetProxyInterface = new IAssetProxyContract(
|
|
artifacts.IAssetProxy.compilerOutput.abi,
|
|
constants.NULL_ADDRESS,
|
|
provider,
|
|
);
|
|
this._tokenOwnerAddresses = tokenOwnerAddresses;
|
|
this._contractOwnerAddress = contractOwnerAddress;
|
|
this._fungibleTokenIds = [];
|
|
this._nonFungibleTokenIds = [];
|
|
this._nfts = [];
|
|
}
|
|
public async deployDummyTokensAsync(): Promise<Erc1155Wrapper[]> {
|
|
// tslint:disable-next-line:no-unused-variable
|
|
for (const i of _.times(constants.NUM_DUMMY_ERC1155_TO_DEPLOY)) {
|
|
const erc1155Contract = await ERC1155MintableContract.deployFrom0xArtifactAsync(
|
|
artifacts.ERC1155Mintable,
|
|
this._provider,
|
|
txDefaults,
|
|
);
|
|
const erc1155Wrapper = new Erc1155Wrapper(erc1155Contract, this._provider, this._contractOwnerAddress);
|
|
this._dummyTokenWrappers.push(erc1155Wrapper);
|
|
}
|
|
return this._dummyTokenWrappers;
|
|
}
|
|
public async deployProxyAsync(): Promise<ERC1155ProxyContract> {
|
|
this._proxyContract = await ERC1155ProxyContract.deployFrom0xArtifactAsync(
|
|
artifacts.ERC1155Proxy,
|
|
this._provider,
|
|
txDefaults,
|
|
);
|
|
this._proxyIdIfExists = await this._proxyContract.getProxyId.callAsync();
|
|
return this._proxyContract;
|
|
}
|
|
public getProxyId(): string {
|
|
this._validateProxyContractExistsOrThrow();
|
|
return this._proxyIdIfExists as string;
|
|
}
|
|
public async transferFromAsync(
|
|
from: string,
|
|
to: string,
|
|
contractAddress: string,
|
|
tokensToTransfer: BigNumber[],
|
|
valuesToTransfer: BigNumber[],
|
|
valueMultiplier: BigNumber,
|
|
receiverCallbackData: string,
|
|
authorizedSender: string
|
|
): Promise<TransactionReceiptWithDecodedLogs> {
|
|
this._validateProxyContractExistsOrThrow();
|
|
const encodedAssetData = assetDataUtils.encodeERC1155AssetData(
|
|
contractAddress,
|
|
tokensToTransfer,
|
|
valuesToTransfer,
|
|
receiverCallbackData,
|
|
);
|
|
const data = this._assetProxyInterface.transferFrom.getABIEncodedTransactionData(
|
|
encodedAssetData,
|
|
from,
|
|
to,
|
|
valueMultiplier,
|
|
);
|
|
const txReceipt = await this._logDecoder.getTxWithDecodedLogsAsync(
|
|
await this._web3Wrapper.sendTransactionAsync({
|
|
to: (this._proxyContract as ERC1155ProxyContract).address,
|
|
data,
|
|
from: authorizedSender,
|
|
}),
|
|
);
|
|
return txReceipt;
|
|
}
|
|
public async setBalancesAndAllowancesAsync(): Promise<ERC1155HoldingsByOwner> {
|
|
this._validateDummyTokenContractsExistOrThrow();
|
|
this._validateProxyContractExistsOrThrow();
|
|
this._initialTokenIdsByOwner = {
|
|
fungible: {},
|
|
nonFungible: {},
|
|
};
|
|
const fungibleHoldingsByOwner: ERC1155FungibleHoldingsByOwner = {};
|
|
const nonFungibleHoldingsByOwner: ERC1155NonFungibleHoldingsByOwner = {};
|
|
// Set balances accordingly
|
|
for (const dummyWrapper of this._dummyTokenWrappers) {
|
|
const dummyAddress = dummyWrapper.getContract().address;
|
|
// tslint:disable-next-line:no-unused-variable
|
|
for (const i of _.times(constants.NUM_ERC1155_FUNGIBLE_TOKENS_MINT)) {
|
|
// Create a fungible token
|
|
const tokenId = await dummyWrapper.mintFungibleTokensAsync(
|
|
this._tokenOwnerAddresses,
|
|
constants.INITIAL_ERC1155_FUNGIBLE_BALANCE,
|
|
);
|
|
const tokenIdAsString = tokenId.toString();
|
|
this._fungibleTokenIds.push(tokenIdAsString);
|
|
// Mint tokens for each owner for this token
|
|
for (const tokenOwnerAddress of this._tokenOwnerAddresses) {
|
|
// tslint:disable-next-line:no-unused-variable
|
|
if (_.isUndefined(fungibleHoldingsByOwner[tokenOwnerAddress])) {
|
|
fungibleHoldingsByOwner[tokenOwnerAddress] = {};
|
|
}
|
|
if (_.isUndefined(fungibleHoldingsByOwner[tokenOwnerAddress][dummyAddress])) {
|
|
fungibleHoldingsByOwner[tokenOwnerAddress][dummyAddress] = {};
|
|
}
|
|
fungibleHoldingsByOwner[tokenOwnerAddress][dummyAddress][tokenIdAsString] =
|
|
constants.INITIAL_ERC1155_FUNGIBLE_BALANCE;
|
|
await dummyWrapper.setApprovalForAllAsync(
|
|
tokenOwnerAddress,
|
|
(this._proxyContract as ERC1155ProxyContract).address,
|
|
true,
|
|
);
|
|
}
|
|
}
|
|
// Non-fungible tokens
|
|
// tslint:disable-next-line:no-unused-variable
|
|
for (const i of _.times(constants.NUM_ERC1155_NONFUNGIBLE_TOKENS_MINT)) {
|
|
const [tokenId, nftIds] = await dummyWrapper.mintNonFungibleTokensAsync(this._tokenOwnerAddresses);
|
|
const tokenIdAsString = tokenId.toString();
|
|
this._nonFungibleTokenIds.push(tokenIdAsString);
|
|
_.each(this._tokenOwnerAddresses, async (tokenOwnerAddress: string, i: number) => {
|
|
if (_.isUndefined(nonFungibleHoldingsByOwner[tokenOwnerAddress])) {
|
|
nonFungibleHoldingsByOwner[tokenOwnerAddress] = {};
|
|
}
|
|
if (_.isUndefined(nonFungibleHoldingsByOwner[tokenOwnerAddress][dummyAddress])) {
|
|
nonFungibleHoldingsByOwner[tokenOwnerAddress][dummyAddress] = {};
|
|
}
|
|
if (_.isUndefined(nonFungibleHoldingsByOwner[tokenOwnerAddress][dummyAddress][tokenIdAsString])) {
|
|
nonFungibleHoldingsByOwner[tokenOwnerAddress][dummyAddress][tokenIdAsString] = [];
|
|
}
|
|
this._nfts.push({ id: nftIds[i], tokenId });
|
|
nonFungibleHoldingsByOwner[tokenOwnerAddress][dummyAddress][tokenIdAsString].push(nftIds[i]);
|
|
await dummyWrapper.setApprovalForAllAsync(
|
|
tokenOwnerAddress,
|
|
(this._proxyContract as ERC1155ProxyContract).address,
|
|
true,
|
|
);
|
|
});
|
|
}
|
|
}
|
|
this._initialTokenIdsByOwner = {
|
|
fungible: fungibleHoldingsByOwner,
|
|
nonFungible: nonFungibleHoldingsByOwner,
|
|
};
|
|
return this._initialTokenIdsByOwner;
|
|
}
|
|
public async ownerOfNonFungibleAsync(tokenAddress: string, tokenId: BigNumber): Promise<string> {
|
|
const tokenContract = this._getContractFromTokenAddress(tokenAddress);
|
|
const owner = await tokenContract.ownerOf.callAsync(tokenId);
|
|
return owner;
|
|
}
|
|
public async isNonFungibleOwnerAsync(
|
|
userAddress: string,
|
|
tokenAddress: string,
|
|
tokenId: BigNumber,
|
|
): Promise<boolean> {
|
|
const tokenContract = this._getContractFromTokenAddress(tokenAddress);
|
|
const tokenOwner = await tokenContract.ownerOf.callAsync(tokenId);
|
|
const isOwner = tokenOwner === userAddress;
|
|
return isOwner;
|
|
}
|
|
public async isProxyApprovedForAllAsync(userAddress: string, tokenAddress: string): Promise<boolean> {
|
|
this._validateProxyContractExistsOrThrow();
|
|
const tokenContract = this._getContractFromTokenAddress(tokenAddress);
|
|
const operator = (this._proxyContract as ERC1155ProxyContract).address;
|
|
const didApproveAll = await tokenContract.isApprovedForAll.callAsync(userAddress, operator);
|
|
return didApproveAll;
|
|
}
|
|
public async getBalancesAsync(): Promise<ERC1155HoldingsByOwner> {
|
|
this._validateDummyTokenContractsExistOrThrow();
|
|
this._validateBalancesAndAllowancesSetOrThrow();
|
|
const tokenHoldingsByOwner: ERC1155FungibleHoldingsByOwner = {};
|
|
const nonFungibleHoldingsByOwner: ERC1155NonFungibleHoldingsByOwner = {};
|
|
for (const dummyTokenWrapper of this._dummyTokenWrappers) {
|
|
const tokenContract = dummyTokenWrapper.getContract();
|
|
const tokenAddress = tokenContract.address;
|
|
// Construct batch balance call
|
|
const tokenOwners: string[] = [];
|
|
const tokenIds: BigNumber[] = [];
|
|
for (const tokenOwnerAddress of this._tokenOwnerAddresses) {
|
|
for (const tokenId of this._fungibleTokenIds) {
|
|
tokenOwners.push(tokenOwnerAddress);
|
|
tokenIds.push(new BigNumber(tokenId));
|
|
}
|
|
for (const nft of this._nfts) {
|
|
tokenOwners.push(tokenOwnerAddress);
|
|
tokenIds.push(nft.id);
|
|
}
|
|
}
|
|
const balances = await dummyTokenWrapper.getBalancesAsync(tokenOwners, tokenIds);
|
|
// Parse out balances into fungible / non-fungible token holdings
|
|
let i = 0;
|
|
for (const tokenOwnerAddress of this._tokenOwnerAddresses) {
|
|
// Fungible tokens
|
|
for (const tokenId of this._fungibleTokenIds) {
|
|
if (_.isUndefined(tokenHoldingsByOwner[tokenOwnerAddress])) {
|
|
tokenHoldingsByOwner[tokenOwnerAddress] = {};
|
|
}
|
|
if (_.isUndefined(tokenHoldingsByOwner[tokenOwnerAddress][tokenAddress])) {
|
|
tokenHoldingsByOwner[tokenOwnerAddress][tokenAddress] = {};
|
|
}
|
|
tokenHoldingsByOwner[tokenOwnerAddress][tokenAddress][tokenId] = balances[i++];
|
|
}
|
|
// Non-fungible tokens
|
|
for (const nft of this._nfts) {
|
|
if (_.isUndefined(nonFungibleHoldingsByOwner[tokenOwnerAddress])) {
|
|
nonFungibleHoldingsByOwner[tokenOwnerAddress] = {};
|
|
}
|
|
if (_.isUndefined(nonFungibleHoldingsByOwner[tokenOwnerAddress][tokenAddress])) {
|
|
nonFungibleHoldingsByOwner[tokenOwnerAddress][tokenAddress] = {};
|
|
}
|
|
if (
|
|
_.isUndefined(
|
|
nonFungibleHoldingsByOwner[tokenOwnerAddress][tokenAddress][nft.tokenId.toString()],
|
|
)
|
|
) {
|
|
nonFungibleHoldingsByOwner[tokenOwnerAddress][tokenAddress][nft.tokenId.toString()] = [];
|
|
}
|
|
const isOwner = balances[i++];
|
|
if (isOwner.isEqualTo(1)) {
|
|
nonFungibleHoldingsByOwner[tokenOwnerAddress][tokenAddress][nft.tokenId.toString()].push(
|
|
nft.id,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
const holdingsByOwner = {
|
|
fungible: tokenHoldingsByOwner,
|
|
nonFungible: nonFungibleHoldingsByOwner,
|
|
};
|
|
return holdingsByOwner;
|
|
}
|
|
public getFungibleTokenIds(): BigNumber[] {
|
|
const fungibleTokenIds = _.map(this._fungibleTokenIds, (tokenIdAsString: string) => {
|
|
return new BigNumber(tokenIdAsString);
|
|
});
|
|
return fungibleTokenIds;
|
|
}
|
|
public getNonFungibleTokenIds(): BigNumber[] {
|
|
const nonFungibleTokenIds = _.map(this._nonFungibleTokenIds, (tokenIdAsString: string) => {
|
|
return new BigNumber(tokenIdAsString);
|
|
});
|
|
return nonFungibleTokenIds;
|
|
}
|
|
public getTokenOwnerAddresses(): string[] {
|
|
return this._tokenOwnerAddresses;
|
|
}
|
|
public getTokenWrapper(tokenAddress: string): Erc1155Wrapper {
|
|
const tokenWrapper = _.find(this._dummyTokenWrappers, (wrapper: Erc1155Wrapper) => {
|
|
return wrapper.getContract().address === tokenAddress;
|
|
});
|
|
if (_.isUndefined(tokenWrapper)) {
|
|
throw new Error(`Token: ${tokenAddress} was not deployed through ERC1155Wrapper`);
|
|
}
|
|
return tokenWrapper;
|
|
}
|
|
private _getContractFromTokenAddress(tokenAddress: string): ERC1155MintableContract {
|
|
const tokenContractIfExists = _.find(this._dummyTokenWrappers, c => c.getContract().address === tokenAddress);
|
|
if (_.isUndefined(tokenContractIfExists)) {
|
|
throw new Error(`Token: ${tokenAddress} was not deployed through ERC1155Wrapper`);
|
|
}
|
|
return tokenContractIfExists.getContract();
|
|
}
|
|
private _validateDummyTokenContractsExistOrThrow(): void {
|
|
if (_.isUndefined(this._dummyTokenWrappers)) {
|
|
throw new Error('Dummy ERC1155 tokens not yet deployed, please call "deployDummyTokensAsync"');
|
|
}
|
|
}
|
|
private _validateProxyContractExistsOrThrow(): void {
|
|
if (_.isUndefined(this._proxyContract)) {
|
|
throw new Error('ERC1155 proxy contract not yet deployed, please call "deployProxyAsync"');
|
|
}
|
|
}
|
|
private _validateBalancesAndAllowancesSetOrThrow(): void {
|
|
if (
|
|
_.keys(this._initialTokenIdsByOwner.fungible).length === 0 ||
|
|
_.keys(this._initialTokenIdsByOwner.nonFungible).length === 0
|
|
) {
|
|
throw new Error(
|
|
'Dummy ERC1155 balances and allowances not yet set, please call "setBalancesAndAllowancesAsync"',
|
|
);
|
|
}
|
|
}
|
|
}
|