aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contracts/test/exchange/libs.ts
blob: 5f2c24ac0f5a00251725fb0295ff345b786eae52 (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
import { BlockchainLifecycle } from '@0xproject/dev-utils';
import { assetProxyUtils, orderHashUtils } from '@0xproject/order-utils';
import { SignedOrder } from '@0xproject/types';
import { BigNumber } from '@0xproject/utils';
import * as chai from 'chai';
import ethUtil = require('ethereumjs-util');

import { TestLibsContract } from '../../src/contract_wrappers/generated/test_libs';
import { addressUtils } from '../../src/utils/address_utils';
import { artifacts } from '../../src/utils/artifacts';
import { chaiSetup } from '../../src/utils/chai_setup';
import { constants } from '../../src/utils/constants';
import { OrderFactory } from '../../src/utils/order_factory';
import { provider, txDefaults, web3Wrapper } from '../../src/utils/web3_wrapper';

chaiSetup.configure();
const expect = chai.expect;

const blockchainLifecycle = new BlockchainLifecycle(web3Wrapper);

describe('Exchange libs', () => {
    let signedOrder: SignedOrder;
    let orderFactory: OrderFactory;
    let libs: TestLibsContract;

    before(async () => {
        await blockchainLifecycle.startAsync();
    });
    after(async () => {
        await blockchainLifecycle.revertAsync();
    });
    before(async () => {
        const accounts = await web3Wrapper.getAvailableAddressesAsync();
        const makerAddress = accounts[0];
        libs = await TestLibsContract.deployFrom0xArtifactAsync(artifacts.TestLibs, provider, txDefaults);

        const defaultOrderParams = {
            ...constants.STATIC_ORDER_PARAMS,
            exchangeAddress: libs.address,
            makerAddress,
            feeRecipientAddress: addressUtils.generatePseudoRandomAddress(),
            makerAssetData: assetProxyUtils.encodeERC20ProxyData(addressUtils.generatePseudoRandomAddress()),
            takerAssetData: assetProxyUtils.encodeERC20ProxyData(addressUtils.generatePseudoRandomAddress()),
        };
        const privateKey = constants.TESTRPC_PRIVATE_KEYS[accounts.indexOf(makerAddress)];
        orderFactory = new OrderFactory(privateKey, defaultOrderParams);
    });

    beforeEach(async () => {
        await blockchainLifecycle.startAsync();
        signedOrder = orderFactory.newSignedOrder();
    });
    afterEach(async () => {
        await blockchainLifecycle.revertAsync();
    });

    describe('LibOrder', () => {
        describe('getOrderSchema', () => {
            it('should output the correct order schema hash', async () => {
                const orderSchema = await libs.getOrderSchemaHash.callAsync();
                expect(orderHashUtils._getOrderSchemaHex()).to.be.equal(orderSchema);
            });
        });
        describe('getDomainSeparatorSchema', () => {
            it('should output the correct domain separator schema hash', async () => {
                const domainSeparatorSchema = await libs.getDomainSeparatorSchemaHash.callAsync();
                expect(orderHashUtils._getDomainSeparatorSchemaHex()).to.be.equal(domainSeparatorSchema);
            });
        });
        describe('getOrderHash', () => {
            it('should output the correct order hash', async () => {
                const orderHashHex = await libs.publicGetOrderHash.callAsync(signedOrder);
                expect(orderHashUtils.getOrderHashHex(signedOrder)).to.be.equal(orderHashHex);
            });
        });
    });

    describe('LibMath', () => {
        describe('isRoundingError', () => {
            it('should return false if there is a rounding error of 0.1%', async () => {
                const numerator = new BigNumber(20);
                const denominator = new BigNumber(999);
                const target = new BigNumber(50);
                // rounding error = ((20*50/999) - floor(20*50/999)) / (20*50/999) = 0.1%
                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
                expect(isRoundingError).to.be.false();
            });

            it('should return false if there is a rounding of 0.09%', async () => {
                const numerator = new BigNumber(20);
                const denominator = new BigNumber(9991);
                const target = new BigNumber(500);
                // rounding error = ((20*500/9991) - floor(20*500/9991)) / (20*500/9991) = 0.09%
                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
                expect(isRoundingError).to.be.false();
            });

            it('should return true if there is a rounding error of 0.11%', async () => {
                const numerator = new BigNumber(20);
                const denominator = new BigNumber(9989);
                const target = new BigNumber(500);
                // rounding error = ((20*500/9989) - floor(20*500/9989)) / (20*500/9989) = 0.011%
                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
                expect(isRoundingError).to.be.true();
            });

            it('should return true if there is a rounding error > 0.1%', async () => {
                const numerator = new BigNumber(3);
                const denominator = new BigNumber(7);
                const target = new BigNumber(10);
                // rounding error = ((3*10/7) - floor(3*10/7)) / (3*10/7) = 6.67%
                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
                expect(isRoundingError).to.be.true();
            });

            it('should return false when there is no rounding error', async () => {
                const numerator = new BigNumber(1);
                const denominator = new BigNumber(2);
                const target = new BigNumber(10);

                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
                expect(isRoundingError).to.be.false();
            });

            it('should return false when there is rounding error <= 0.1%', async () => {
                // randomly generated numbers
                const numerator = new BigNumber(76564);
                const denominator = new BigNumber(676373677);
                const target = new BigNumber(105762562);
                // rounding error = ((76564*105762562/676373677) - floor(76564*105762562/676373677)) /
                // (76564*105762562/676373677) = 0.0007%
                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
                expect(isRoundingError).to.be.false();
            });
        });

        describe('getPartialAmount', () => {
            it('should return the numerator/denominator*target', async () => {
                const numerator = new BigNumber(1);
                const denominator = new BigNumber(2);
                const target = new BigNumber(10);

                const partialAmount = await libs.publicGetPartialAmount.callAsync(numerator, denominator, target);
                const expectedPartialAmount = 5;
                expect(partialAmount).to.be.bignumber.equal(expectedPartialAmount);
            });

            it('should round down', async () => {
                const numerator = new BigNumber(2);
                const denominator = new BigNumber(3);
                const target = new BigNumber(10);

                const partialAmount = await libs.publicGetPartialAmount.callAsync(numerator, denominator, target);
                const expectedPartialAmount = 6;
                expect(partialAmount).to.be.bignumber.equal(expectedPartialAmount);
            });

            it('should round .5 down', async () => {
                const numerator = new BigNumber(1);
                const denominator = new BigNumber(20);
                const target = new BigNumber(10);

                const partialAmount = await libs.publicGetPartialAmount.callAsync(numerator, denominator, target);
                const expectedPartialAmount = 0;
                expect(partialAmount).to.be.bignumber.equal(expectedPartialAmount);
            });
        });
    });
});