aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contract-wrappers/test/erc721_wrapper_test.ts
blob: c57370b7ba6d11c75f48a216419d1076ddcfdbf0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
import { BlockchainLifecycle, callbackErrorReporter } from '@0xproject/dev-utils';
import { EmptyWalletSubprovider, Web3ProviderEngine } from '@0xproject/subproviders';
import { DoneCallback } from '@0xproject/types';
import { BigNumber } from '@0xproject/utils';
import * as chai from 'chai';
import { Provider } from 'ethereum-types';
import 'mocha';

import {
    BlockParamLiteral,
    BlockRange,
    ContractWrappers,
    ContractWrappersConfig,
    ContractWrappersError,
    DecodedLogEvent,
    ERC721TokenApprovalEventArgs,
    ERC721TokenApprovalForAllEventArgs,
    ERC721TokenEvents,
    ERC721TokenTransferEventArgs,
} from '../src';

import { chaiSetup } from './utils/chai_setup';
import { constants } from './utils/constants';
import { migrateOnceAsync } from './utils/migrate';
import { tokenUtils } from './utils/token_utils';
import { provider, web3Wrapper } from './utils/web3_wrapper';

chaiSetup.configure();
const expect = chai.expect;
const blockchainLifecycle = new BlockchainLifecycle(web3Wrapper);

describe('ERC721Wrapper', () => {
    let contractWrappers: ContractWrappers;
    let userAddresses: string[];
    let tokens: string[];
    let ownerAddress: string;
    let tokenAddress: string;
    let anotherOwnerAddress: string;
    let operatorAddress: string;
    let approvedAddress: string;
    let receiverAddress: string;
    let config: ContractWrappersConfig;

    before(async () => {
        const contractAddresses = await migrateOnceAsync();
        config = {
            networkId: constants.TESTRPC_NETWORK_ID,
            contractAddresses,
            blockPollingIntervalMs: 10,
        };
        contractWrappers = new ContractWrappers(provider, config);
        userAddresses = await web3Wrapper.getAvailableAddressesAsync();
        tokens = tokenUtils.getDummyERC721TokenAddresses();
        tokenAddress = tokens[0];
        [ownerAddress, operatorAddress, anotherOwnerAddress, approvedAddress, receiverAddress] = userAddresses;
    });
    beforeEach(async () => {
        await blockchainLifecycle.startAsync();
    });
    afterEach(async () => {
        await blockchainLifecycle.revertAsync();
    });
    describe('#transferFromAsync', () => {
        it('should fail to transfer NFT if fromAddress has no approvals set', async () => {
            const tokenId = await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);
            return expect(
                contractWrappers.erc721Token.transferFromAsync(tokenAddress, receiverAddress, approvedAddress, tokenId),
            ).to.be.rejectedWith(ContractWrappersError.ERC721NoApproval);
        });
        it('should successfully transfer tokens when sender is an approved address', async () => {
            const tokenId = await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);
            let txHash = await contractWrappers.erc721Token.setApprovalAsync(tokenAddress, approvedAddress, tokenId);
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            const owner = await contractWrappers.erc721Token.getOwnerOfAsync(tokenAddress, tokenId);
            expect(owner).to.be.equal(ownerAddress);
            txHash = await contractWrappers.erc721Token.transferFromAsync(
                tokenAddress,
                receiverAddress,
                approvedAddress,
                tokenId,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            const newOwner = await contractWrappers.erc721Token.getOwnerOfAsync(tokenAddress, tokenId);
            expect(newOwner).to.be.equal(receiverAddress);
        });
        it('should successfully transfer tokens when sender is an approved operator', async () => {
            const tokenId = await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);
            const isApprovedForAll = true;
            let txHash = await contractWrappers.erc721Token.setApprovalForAllAsync(
                tokenAddress,
                ownerAddress,
                operatorAddress,
                isApprovedForAll,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            const owner = await contractWrappers.erc721Token.getOwnerOfAsync(tokenAddress, tokenId);
            expect(owner).to.be.equal(ownerAddress);
            txHash = await contractWrappers.erc721Token.transferFromAsync(
                tokenAddress,
                receiverAddress,
                operatorAddress,
                tokenId,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            const newOwner = await contractWrappers.erc721Token.getOwnerOfAsync(tokenAddress, tokenId);
            expect(newOwner).to.be.equal(receiverAddress);
        });
    });
    describe('#getTokenCountAsync', () => {
        describe('With provider with accounts', () => {
            it('should return the count for an existing ERC721 token', async () => {
                let tokenCount = await contractWrappers.erc721Token.getTokenCountAsync(tokenAddress, ownerAddress);
                expect(tokenCount).to.be.bignumber.equal(0);
                await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);
                tokenCount = await contractWrappers.erc721Token.getTokenCountAsync(tokenAddress, ownerAddress);
                expect(tokenCount).to.be.bignumber.equal(1);
            });
            it('should throw a CONTRACT_DOES_NOT_EXIST error for a non-existent token contract', async () => {
                const nonExistentTokenAddress = '0x9dd402f14d67e001d8efbe6583e51bf9706aa065';
                return expect(
                    contractWrappers.erc721Token.getTokenCountAsync(nonExistentTokenAddress, ownerAddress),
                ).to.be.rejectedWith(ContractWrappersError.ERC721TokenContractDoesNotExist);
            });
            it('should return a balance of 0 for a non-existent owner address', async () => {
                const nonExistentOwner = '0x198c6ad858f213fb31b6fe809e25040e6b964593';
                const balance = await contractWrappers.erc721Token.getTokenCountAsync(tokenAddress, nonExistentOwner);
                const expectedBalance = new BigNumber(0);
                return expect(balance).to.be.bignumber.equal(expectedBalance);
            });
        });
        describe('With provider without accounts', () => {
            let zeroExContractWithoutAccounts: ContractWrappers;
            before(async () => {
                const emptyWalletProvider = addEmptyWalletSubprovider(provider);
                zeroExContractWithoutAccounts = new ContractWrappers(emptyWalletProvider, config);
            });
            it('should return balance even when called with provider instance without addresses', async () => {
                const balance = await zeroExContractWithoutAccounts.erc721Token.getTokenCountAsync(
                    tokenAddress,
                    ownerAddress,
                );
                return expect(balance).to.be.bignumber.equal(0);
            });
        });
    });
    describe('#getOwnerOfAsync', () => {
        it('should return the owner for an existing ERC721 token', async () => {
            const tokenId = await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);
            const tokenOwner = await contractWrappers.erc721Token.getOwnerOfAsync(tokenAddress, tokenId);
            expect(tokenOwner).to.be.bignumber.equal(ownerAddress);
        });
        it('should throw a CONTRACT_DOES_NOT_EXIST error for a non-existent token contract', async () => {
            const nonExistentTokenAddress = '0x9dd402f14d67e001d8efbe6583e51bf9706aa065';
            const fakeTokenId = new BigNumber(42);
            return expect(
                contractWrappers.erc721Token.getOwnerOfAsync(nonExistentTokenAddress, fakeTokenId),
            ).to.be.rejectedWith(ContractWrappersError.ERC721TokenContractDoesNotExist);
        });
        it('should return undefined not 0 for a non-existent ERC721', async () => {
            const fakeTokenId = new BigNumber(42);
            return expect(contractWrappers.erc721Token.getOwnerOfAsync(tokenAddress, fakeTokenId)).to.be.rejectedWith(
                ContractWrappersError.ERC721OwnerNotFound,
            );
        });
    });
    describe('#setApprovalForAllAsync/isApprovedForAllAsync', () => {
        it('should check if operator address is approved', async () => {
            let isApprovedForAll = await contractWrappers.erc721Token.isApprovedForAllAsync(
                tokenAddress,
                ownerAddress,
                operatorAddress,
            );
            expect(isApprovedForAll).to.be.false();
            // set
            isApprovedForAll = true;
            let txHash = await contractWrappers.erc721Token.setApprovalForAllAsync(
                tokenAddress,
                ownerAddress,
                operatorAddress,
                isApprovedForAll,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            isApprovedForAll = await contractWrappers.erc721Token.isApprovedForAllAsync(
                tokenAddress,
                ownerAddress,
                operatorAddress,
            );
            expect(isApprovedForAll).to.be.true();
            // unset
            txHash = await contractWrappers.erc721Token.setApprovalForAllAsync(
                tokenAddress,
                ownerAddress,
                operatorAddress,
                false,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            isApprovedForAll = await contractWrappers.erc721Token.isApprovedForAllAsync(
                tokenAddress,
                ownerAddress,
                operatorAddress,
            );
            expect(isApprovedForAll).to.be.false();
        });
    });
    describe('#setProxyApprovalForAllAsync/isProxyApprovedForAllAsync', () => {
        it('should check if proxy address is approved', async () => {
            let isApprovedForAll = true;
            const txHash = await contractWrappers.erc721Token.setProxyApprovalForAllAsync(
                tokenAddress,
                ownerAddress,
                isApprovedForAll,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            isApprovedForAll = await contractWrappers.erc721Token.isProxyApprovedForAllAsync(
                tokenAddress,
                ownerAddress,
            );
            expect(isApprovedForAll).to.be.true();
        });
    });
    describe('#setApprovalAsync/getApprovedIfExistsAsync', () => {
        it("should set the spender's approval", async () => {
            const tokenId = await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);

            const approvalBeforeSet = await contractWrappers.erc721Token.getApprovedIfExistsAsync(
                tokenAddress,
                tokenId,
            );
            expect(approvalBeforeSet).to.be.undefined();
            await contractWrappers.erc721Token.setApprovalAsync(tokenAddress, approvedAddress, tokenId);
            const approvalAfterSet = await contractWrappers.erc721Token.getApprovedIfExistsAsync(tokenAddress, tokenId);
            expect(approvalAfterSet).to.be.equal(approvedAddress);
        });
    });
    describe('#setProxyApprovalAsync/isProxyApprovedAsync', () => {
        it('should set the proxy approval', async () => {
            const tokenId = await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);

            const isProxyApprovedBeforeSet = await contractWrappers.erc721Token.isProxyApprovedAsync(
                tokenAddress,
                tokenId,
            );
            expect(isProxyApprovedBeforeSet).to.be.false();
            await contractWrappers.erc721Token.setProxyApprovalAsync(tokenAddress, tokenId);
            const isProxyApprovedAfterSet = await contractWrappers.erc721Token.isProxyApprovedAsync(
                tokenAddress,
                tokenId,
            );
            expect(isProxyApprovedAfterSet).to.be.true();
        });
    });
    describe('#subscribe', () => {
        const indexFilterValues = {};
        afterEach(() => {
            contractWrappers.erc721Token.unsubscribeAll();
        });
        // Hack: Mocha does not allow a test to be both async and have a `done` callback
        // Since we need to await the receipt of the event in the `subscribe` callback,
        // we do need both. A hack is to make the top-level a sync fn w/ a done callback and then
        // wrap the rest of the test in an async block
        // Source: https://github.com/mochajs/mocha/issues/2407
        it('Should receive the Transfer event when tokens are transfered', (done: DoneCallback) => {
            (async () => {
                const callback = callbackErrorReporter.reportNodeCallbackErrors(done)(
                    (logEvent: DecodedLogEvent<ERC721TokenTransferEventArgs>) => {
                        expect(logEvent.isRemoved).to.be.false();
                        expect(logEvent.log.logIndex).to.be.equal(0);
                        expect(logEvent.log.transactionIndex).to.be.equal(0);
                        expect(logEvent.log.blockNumber).to.be.a('number');
                        const args = logEvent.log.args;
                        expect(args._from).to.be.equal(ownerAddress);
                        expect(args._to).to.be.equal(receiverAddress);
                        expect(args._tokenId).to.be.bignumber.equal(tokenId);
                    },
                );
                const tokenId = await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);
                const isApprovedForAll = true;
                await web3Wrapper.awaitTransactionSuccessAsync(
                    await contractWrappers.erc721Token.setApprovalForAllAsync(
                        tokenAddress,
                        ownerAddress,
                        operatorAddress,
                        isApprovedForAll,
                    ),
                    constants.AWAIT_TRANSACTION_MINED_MS,
                );
                contractWrappers.erc721Token.subscribe(
                    tokenAddress,
                    ERC721TokenEvents.Transfer,
                    indexFilterValues,
                    callback,
                );
                await web3Wrapper.awaitTransactionSuccessAsync(
                    await contractWrappers.erc721Token.transferFromAsync(
                        tokenAddress,
                        receiverAddress,
                        operatorAddress,
                        tokenId,
                    ),
                    constants.AWAIT_TRANSACTION_MINED_MS,
                );
            })().catch(done);
        });
        it('Should receive the Approval event when allowance is being set', (done: DoneCallback) => {
            (async () => {
                const callback = callbackErrorReporter.reportNodeCallbackErrors(done)(
                    (logEvent: DecodedLogEvent<ERC721TokenApprovalEventArgs>) => {
                        expect(logEvent).to.not.be.undefined();
                        expect(logEvent.isRemoved).to.be.false();
                        const args = logEvent.log.args;
                        expect(args._owner).to.be.equal(ownerAddress);
                        expect(args._approved).to.be.equal(approvedAddress);
                        expect(args._tokenId).to.be.bignumber.equal(tokenId);
                    },
                );
                contractWrappers.erc721Token.subscribe(
                    tokenAddress,
                    ERC721TokenEvents.Approval,
                    indexFilterValues,
                    callback,
                );
                const tokenId = await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);
                await web3Wrapper.awaitTransactionSuccessAsync(
                    await contractWrappers.erc721Token.setApprovalAsync(tokenAddress, approvedAddress, tokenId),
                    constants.AWAIT_TRANSACTION_MINED_MS,
                );
            })().catch(done);
        });
        it('Outstanding subscriptions are cancelled when contractWrappers.unsubscribeAll called', (done: DoneCallback) => {
            (async () => {
                const callbackNeverToBeCalled = callbackErrorReporter.reportNodeCallbackErrors(done)(
                    (logEvent: DecodedLogEvent<ERC721TokenApprovalEventArgs>) => {
                        done(new Error('Expected this subscription to have been cancelled'));
                    },
                );
                contractWrappers.erc721Token.subscribe(
                    tokenAddress,
                    ERC721TokenEvents.Transfer,
                    indexFilterValues,
                    callbackNeverToBeCalled,
                );
                const callbackToBeCalled = callbackErrorReporter.reportNodeCallbackErrors(done)();
                contractWrappers.unsubscribeAll();
                contractWrappers.erc721Token.subscribe(
                    tokenAddress,
                    ERC721TokenEvents.Approval,
                    indexFilterValues,
                    callbackToBeCalled,
                );
                const tokenId = await tokenUtils.mintDummyERC721Async(tokenAddress, ownerAddress);
                await web3Wrapper.awaitTransactionSuccessAsync(
                    await contractWrappers.erc721Token.setApprovalAsync(tokenAddress, approvedAddress, tokenId),
                    constants.AWAIT_TRANSACTION_MINED_MS,
                );
                done();
            })().catch(done);
        });
        it('Should cancel subscription when unsubscribe called', (done: DoneCallback) => {
            (async () => {
                const callbackNeverToBeCalled = callbackErrorReporter.reportNodeCallbackErrors(done)(
                    (logEvent: DecodedLogEvent<ERC721TokenApprovalForAllEventArgs>) => {
                        done(new Error('Expected this subscription to have been cancelled'));
                    },
                );
                const subscriptionToken = contractWrappers.erc721Token.subscribe(
                    tokenAddress,
                    ERC721TokenEvents.ApprovalForAll,
                    indexFilterValues,
                    callbackNeverToBeCalled,
                );
                contractWrappers.erc721Token.unsubscribe(subscriptionToken);

                const isApproved = true;
                await web3Wrapper.awaitTransactionSuccessAsync(
                    await contractWrappers.erc721Token.setApprovalForAllAsync(
                        tokenAddress,
                        ownerAddress,
                        operatorAddress,
                        isApproved,
                    ),
                    constants.AWAIT_TRANSACTION_MINED_MS,
                );
                done();
            })().catch(done);
        });
    });
    describe('#getLogsAsync', () => {
        const blockRange: BlockRange = {
            fromBlock: 0,
            toBlock: BlockParamLiteral.Latest,
        };
        let txHash: string;
        it('should get logs with decoded args emitted by ApprovalForAll', async () => {
            const isApprovedForAll = true;
            txHash = await contractWrappers.erc721Token.setApprovalForAllAsync(
                tokenAddress,
                ownerAddress,
                operatorAddress,
                isApprovedForAll,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            const eventName = ERC721TokenEvents.ApprovalForAll;
            const indexFilterValues = {};
            const logs = await contractWrappers.erc721Token.getLogsAsync<ERC721TokenApprovalForAllEventArgs>(
                tokenAddress,
                eventName,
                blockRange,
                indexFilterValues,
            );
            expect(logs).to.have.length(1);
            const args = logs[0].args;
            expect(logs[0].event).to.be.equal(eventName);
            expect(args._owner).to.be.equal(ownerAddress);
            expect(args._operator).to.be.equal(operatorAddress);
            expect(args._approved).to.be.equal(isApprovedForAll);
        });
        it('should only get the logs with the correct event name', async () => {
            const isApprovedForAll = true;
            txHash = await contractWrappers.erc721Token.setApprovalForAllAsync(
                tokenAddress,
                ownerAddress,
                operatorAddress,
                isApprovedForAll,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            const differentEventName = ERC721TokenEvents.Transfer;
            const indexFilterValues = {};
            const logs = await contractWrappers.erc721Token.getLogsAsync(
                tokenAddress,
                differentEventName,
                blockRange,
                indexFilterValues,
            );
            expect(logs).to.have.length(0);
        });
        it('should only get the logs with the correct indexed fields', async () => {
            const isApprovedForAll = true;
            txHash = await contractWrappers.erc721Token.setApprovalForAllAsync(
                tokenAddress,
                ownerAddress,
                operatorAddress,
                isApprovedForAll,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            txHash = await contractWrappers.erc721Token.setApprovalForAllAsync(
                tokenAddress,
                anotherOwnerAddress,
                operatorAddress,
                isApprovedForAll,
            );
            await web3Wrapper.awaitTransactionSuccessAsync(txHash, constants.AWAIT_TRANSACTION_MINED_MS);
            const eventName = ERC721TokenEvents.ApprovalForAll;
            const indexFilterValues = {
                _owner: anotherOwnerAddress,
            };
            const logs = await contractWrappers.erc721Token.getLogsAsync<ERC721TokenApprovalForAllEventArgs>(
                tokenAddress,
                eventName,
                blockRange,
                indexFilterValues,
            );
            expect(logs).to.have.length(1);
            const args = logs[0].args;
            expect(args._owner).to.be.equal(anotherOwnerAddress);
        });
    });
});
// tslint:disable:max-file-line-count

function addEmptyWalletSubprovider(p: Provider): Provider {
    const providerEngine = new Web3ProviderEngine();
    providerEngine.addProvider(new EmptyWalletSubprovider());
    const currentSubproviders = (p as any)._providers;
    for (const subprovider of currentSubproviders) {
        providerEngine.addProvider(subprovider);
    }
    providerEngine.start();
    return providerEngine;
}