aboutsummaryrefslogtreecommitdiffstats
path: root/packages/utils/test/abi_encoder/signature_test.ts
blob: cee6fa5e57cddeda0cdb496c1bfccf053839fab6 (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
import * as chai from 'chai';
import 'mocha';

import { AbiEncoder } from '../../src';
import { chaiSetup } from '../utils/chai_setup';

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

describe('ABI Encoder: Signatures', () => {
    describe('Single type', () => {
        it('Elementary', async () => {
            const signature = 'uint256';
            const dataType = AbiEncoder.create(signature);
            const dataTypeId = dataType.getDataItem().type;
            expect(dataTypeId).to.be.equal('uint256');
            expect(dataType.getSignature()).to.be.equal(signature);
        });
        it('Array', async () => {
            const signature = 'string[]';
            const dataType = AbiEncoder.create(signature);
            const dataItem = dataType.getDataItem();
            const expectedDataItem = {
                name: '',
                type: 'string[]',
            };
            expect(dataItem).to.be.deep.equal(expectedDataItem);
            expect(dataType.getSignature()).to.be.equal(signature);
        });
        it('Multidimensional Array', async () => {
            // Decode return value
            const signature = 'uint256[4][][5]';
            const dataType = AbiEncoder.create(signature);
            const dataTypeId = dataType.getDataItem().type;
            expect(dataTypeId).to.be.equal(signature);
            expect(dataType.getSignature()).to.be.equal(signature);
        });
        it('Tuple with single element', async () => {
            const signature = '(uint256)';
            const dataType = AbiEncoder.create(signature);
            const dataItem = dataType.getDataItem();
            const expectedDataItem = {
                name: '',
                type: 'tuple',
                components: [
                    {
                        name: '',
                        type: 'uint256',
                    },
                ],
            };
            expect(dataItem).to.be.deep.equal(expectedDataItem);
            expect(dataType.getSignature()).to.be.equal(signature);
        });
        it('Tuple with multiple elements', async () => {
            const signature = '(uint256,string,bytes4)';
            const dataType = AbiEncoder.create(signature);
            const dataItem = dataType.getDataItem();
            const expectedDataItem = {
                name: '',
                type: 'tuple',
                components: [
                    {
                        name: '',
                        type: 'uint256',
                    },
                    {
                        name: '',
                        type: 'string',
                    },
                    {
                        name: '',
                        type: 'bytes4',
                    },
                ],
            };
            expect(dataItem).to.be.deep.equal(expectedDataItem);
            expect(dataType.getSignature()).to.be.equal(signature);
        });
        it('Tuple with nested array and nested tuple', async () => {
            const signature = '(uint256[],(bytes),string[4],bytes4)';
            const dataType = AbiEncoder.create(signature);
            const dataItem = dataType.getDataItem();
            const expectedDataItem = {
                name: '',
                type: 'tuple',
                components: [
                    {
                        name: '',
                        type: 'uint256[]',
                    },
                    {
                        name: '',
                        type: 'tuple',
                        components: [
                            {
                                name: '',
                                type: 'bytes',
                            },
                        ],
                    },
                    {
                        name: '',
                        type: 'string[4]',
                    },
                    {
                        name: '',
                        type: 'bytes4',
                    },
                ],
            };
            expect(dataItem).to.be.deep.equal(expectedDataItem);
            expect(dataType.getSignature()).to.be.equal(signature);
        });
        it('Array of complex tuples', async () => {
            const signature = '(uint256[],(bytes),string[4],bytes4)[5][4][]';
            const dataType = AbiEncoder.create(signature);
            const dataItem = dataType.getDataItem();
            const expectedDataItem = {
                name: '',
                type: 'tuple[5][4][]',
                components: [
                    {
                        name: '',
                        type: 'uint256[]',
                    },
                    {
                        name: '',
                        type: 'tuple',
                        components: [
                            {
                                name: '',
                                type: 'bytes',
                            },
                        ],
                    },
                    {
                        name: '',
                        type: 'string[4]',
                    },
                    {
                        name: '',
                        type: 'bytes4',
                    },
                ],
            };
            expect(dataItem).to.be.deep.equal(expectedDataItem);
            expect(dataType.getSignature()).to.be.equal(signature);
        });
    });

    describe('Function', () => {
        it('No inputs and no outputs', async () => {
            // create encoder
            const functionName = 'foo';
            const dataType = AbiEncoder.createMethod(functionName);
            // create expected values
            const expectedSignature = 'foo()';
            const expectedInputDataItem = {
                name: 'foo',
                type: 'method',
                components: [],
            };
            const expectedOutputDataItem = {
                name: 'foo',
                type: 'tuple',
                components: [],
            };
            // check expected values
            expect(dataType.getSignature()).to.be.equal(expectedSignature);
            expect(dataType.getDataItem()).to.be.deep.equal(expectedInputDataItem);
            expect(dataType.getReturnValueDataItem()).to.be.deep.equal(expectedOutputDataItem);
        });
        it('No inputs and no outputs (empty arrays as input)', async () => {
            // create encoder
            const functionName = 'foo';
            const dataType = AbiEncoder.createMethod(functionName, [], []);
            // create expected values
            const expectedSignature = 'foo()';
            const expectedInputDataItem = {
                name: 'foo',
                type: 'method',
                components: [],
            };
            const expectedOutputDataItem = {
                name: 'foo',
                type: 'tuple',
                components: [],
            };
            // check expected values
            expect(dataType.getSignature()).to.be.equal(expectedSignature);
            expect(dataType.getDataItem()).to.be.deep.equal(expectedInputDataItem);
            expect(dataType.getReturnValueDataItem()).to.be.deep.equal(expectedOutputDataItem);
        });
        it('Single DataItem input and single DataItem output', async () => {
            // create encoder
            const functionName = 'foo';
            const inputDataItem = {
                name: 'input',
                type: 'uint256',
            };
            const outputDataItem = {
                name: 'output',
                type: 'string',
            };
            const dataType = AbiEncoder.createMethod(functionName, inputDataItem, outputDataItem);
            // create expected values
            const expectedSignature = 'foo(uint256)';
            const expectedInputDataItem = {
                name: 'foo',
                type: 'method',
                components: [inputDataItem],
            };
            const expectedOutputDataItem = {
                name: 'foo',
                type: 'tuple',
                components: [outputDataItem],
            };
            // check expected values
            expect(dataType.getSignature()).to.be.equal(expectedSignature);
            expect(dataType.getDataItem()).to.be.deep.equal(expectedInputDataItem);
            expect(dataType.getReturnValueDataItem()).to.be.deep.equal(expectedOutputDataItem);
        });
        it('Single signature input and single signature output', async () => {
            // create encoder
            const functionName = 'foo';
            const inputSignature = 'uint256';
            const outputSignature = 'string';
            const dataType = AbiEncoder.createMethod(functionName, inputSignature, outputSignature);
            // create expected values
            const expectedSignature = 'foo(uint256)';
            const expectedInputDataItem = {
                name: 'foo',
                type: 'method',
                components: [
                    {
                        name: '',
                        type: 'uint256',
                    },
                ],
            };
            const expectedOutputDataItem = {
                name: 'foo',
                type: 'tuple',
                components: [
                    {
                        name: '',
                        type: 'string',
                    },
                ],
            };
            // check expected values
            expect(dataType.getSignature()).to.be.equal(expectedSignature);
            expect(dataType.getDataItem()).to.be.deep.equal(expectedInputDataItem);
            expect(dataType.getReturnValueDataItem()).to.be.deep.equal(expectedOutputDataItem);
        });
        it('Single signature tuple input and single signature tuple output', async () => {
            // create encoder
            const functionName = 'foo';
            const inputSignature = '(uint256,bytes[][4])';
            const outputSignature = '(string,uint32)';
            const dataType = AbiEncoder.createMethod(functionName, inputSignature, outputSignature);
            // create expected values
            const expectedSignature = 'foo((uint256,bytes[][4]))';
            const expectedInputDataItem = {
                name: 'foo',
                type: 'method',
                components: [
                    {
                        name: '',
                        type: 'tuple',
                        components: [
                            {
                                name: '',
                                type: 'uint256',
                            },
                            {
                                name: '',
                                type: 'bytes[][4]',
                            },
                        ],
                    },
                ],
            };
            const expectedOutputDataItem = {
                name: 'foo',
                type: 'tuple',
                components: [
                    {
                        name: '',
                        type: 'tuple',
                        components: [
                            {
                                name: '',
                                type: 'string',
                            },
                            {
                                name: '',
                                type: 'uint32',
                            },
                        ],
                    },
                ],
            };
            // check expected values
            expect(dataType.getSignature()).to.be.equal(expectedSignature);
            expect(dataType.getDataItem()).to.be.deep.equal(expectedInputDataItem);
            expect(dataType.getReturnValueDataItem()).to.be.deep.equal(expectedOutputDataItem);
        });
        it('Mutiple DataItem input and multiple DataItem output', async () => {
            // create encoder
            const functionName = 'foo';
            const inputDataItems = [
                {
                    name: '',
                    type: 'uint256',
                },
                {
                    name: '',
                    type: 'bytes[][4]',
                },
            ];
            const outputDataItems = [
                {
                    name: '',
                    type: 'string',
                },
                {
                    name: '',
                    type: 'uint32',
                },
            ];
            const dataType = AbiEncoder.createMethod(functionName, inputDataItems, outputDataItems);
            // create expected values
            const expectedSignature = 'foo(uint256,bytes[][4])';
            const expectedInputDataItem = {
                name: 'foo',
                type: 'method',
                components: inputDataItems,
            };
            const expectedOutputDataItem = {
                name: 'foo',
                type: 'tuple',
                components: outputDataItems,
            };
            // check expected values
            expect(dataType.getSignature()).to.be.equal(expectedSignature);
            expect(dataType.getDataItem()).to.be.deep.equal(expectedInputDataItem);
            expect(dataType.getReturnValueDataItem()).to.be.deep.equal(expectedOutputDataItem);
        });
        it('Multiple signature input and multiple signature output', async () => {
            // create encoder
            const functionName = 'foo';
            const inputSignatures = ['uint256', 'bytes[][4]'];
            const outputSignatures = ['string', 'uint32'];
            const dataType = AbiEncoder.createMethod(functionName, inputSignatures, outputSignatures);
            // create expected values
            const expectedSignature = 'foo(uint256,bytes[][4])';
            const expectedInputDataItem = {
                name: 'foo',
                type: 'method',
                components: [
                    {
                        name: '',
                        type: 'uint256',
                    },
                    {
                        name: '',
                        type: 'bytes[][4]',
                    },
                ],
            };
            const expectedOutputDataItem = {
                name: 'foo',
                type: 'tuple',
                components: [
                    {
                        name: '',
                        type: 'string',
                    },
                    {
                        name: '',
                        type: 'uint32',
                    },
                ],
            };
            // check expected values
            expect(dataType.getSignature()).to.be.equal(expectedSignature);
            expect(dataType.getDataItem()).to.be.deep.equal(expectedInputDataItem);
            expect(dataType.getReturnValueDataItem()).to.be.deep.equal(expectedOutputDataItem);
        });
    });
});