eth-typed-data
Version:
A library to simplifiy interacting with and signing EIP712 typed data
834 lines (832 loc) • 25.7 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for Type.js</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="prettify.css" />
<link rel="stylesheet" href="base.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>
<a href="index.html">All files</a> Type.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">96.72% </span>
<span class="quiet">Statements</span>
<span class='fraction'>59/61</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">87.1% </span>
<span class="quiet">Branches</span>
<span class='fraction'>27/31</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>19/19</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">98.28% </span>
<span class="quiet">Lines</span>
<span class='fraction'>57/58</span>
</div>
</div>
</div>
<div class='status-line high'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet">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</td><td class="line-coverage quiet"><span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-yes">28x</span>
<span class="cline-any cline-yes">6x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">18x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">48x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">45x</span>
<span class="cline-any cline-yes">49x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">45x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">25x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">24x</span>
<span class="cline-any cline-yes">38x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">22x</span>
<span class="cline-any cline-yes">22x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">22x</span>
<span class="cline-any cline-yes">50x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-yes">29x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">14x</span>
<span class="cline-any cline-yes">14x</span>
<span class="cline-any cline-yes">15x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-yes">15x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">14x</span>
<span class="cline-any cline-yes">14x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">5x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">5x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">18x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">18x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">34x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">33x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">31x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">30x</span>
<span class="cline-any cline-yes">50x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">12x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">17x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">30x</span>
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">import abi from 'ethereumjs-abi'
import { keccak256 } from 'js-sha3'
import AbstractType from './AbstractType'
import { verifyRawSignatureFromAddress } from './verify'
import {
isArrayType, isPrimitiveType,
isDynamicType, isAtomicType,
} from './primitives'
/**
* A factory function which returns a class representing an EIP712 Type
* The returned Type can be instantiated and validated as an instance
* of a particular type
*
* There are two acceptable formats for the type definitions, a list of
* {
* name1: 'string',
* name2: 'string',
* }
*
* or
*
* [{
* name: 'name1',
* type: 'string'
* }, {
* name: 'name2',
* type: 'string'
* }]
*
* @this {Domain} The domain object to which the returned type should be associated *
* @param {String} name A String to define the type
* @param {Object|Object[]} defs The definition of the type's members and their types
* @returns {Function} the constructor for the new StructureType
*/
export default function Type (primaryType, defs) {
// Ensure that domain is defined
const domain = this || <span class="branch-1 cbranch-no" title="branch not covered" >{ types: {} }</span>
<span class="missing-if-branch" title="if path not taken" >I</span>if (!domain.types) <span class="cstat-no" title="statement not covered" >domain.types = {}</span>
// Process the type definition into an array of {name, type} pairs,
// keeping track of all dependent types
const properties = Array.isArray(defs)
? defs.map(({name, type}) => validateTypeDefinition({name, type}, domain))
: Object.keys(defs).map((name) => validateTypeDefinition({name, type: defs[name]}, domain))
// Descend through the properties list to come up with a list of
// structure types that this type includes, sorted alphabetically
const dependencies = findDependencies(properties, domain, []).sort()
/**
* @classdesc
* This is the dynamically created class that represents a particular Struct type in
* the EIP712 scheme. This can be instantiated with particular values that match the
* type's definition, and provides methods to encode the type in various formats, and
* sign it with a provided signer.
*/
class StructureType extends AbstractType {
static name = primaryType
static properties = properties
static dependencies = dependencies
constructor (vals) {
super()
this.name = primaryType
this.properties = properties
// Save values for a type instance privately
this._object = {}
for (const prop of properties) {
if (!(prop.name in vals)) {
throw new Error(`Type ${this.name} missing required property ${prop.name}`)
}
// Expose getters and setters for this.prop, validating on set
Object.defineProperty(this, prop.name, {
get: () => this._object[prop.name],
set: (val) => this._object[prop.name] = domain.validate(prop.type, val)
})
this._object[prop.name] = domain.validate(prop.type, vals[prop.name])
}
}
/**
* @override @static
* Return the part of the type encoding that consists of the dependent types
* i.e. the nested Structure types contained by this type.
* @returns {String} A string encoding all types upon which this type depends
*/
static encodeDependentTypes() {
return this.dependencies.map(t => domain.types[t].encodeTypeFragment())
}
/**
* @override
* Return a bare object representation of this instance (as a new object)
*
* @returns {Object} new object containing same key-value pairs of this instance
*/
toObject() {
// Generate a new bare object, with each complex item decomposed into regular javascript objects and arrays
return properties.reduce((obj, {name, type}) =>
({...obj, [name]: domain.serialize(type, this._object[name])}), {})
}
/**
* Encode this object along with its type and domain as a full EIP712
* signature request, defining the types, domain, primaryType, and message
* to be signed. The output is suitable for use with web3.eth.signTypedData
* @returns {Object} the signature request encoding of this instance
*/
toSignatureRequest() {
return {
types: domain.toDomainDef(),
domain: domain.toObject(),
primaryType: this.name,
message: this.toObject()
}
}
/**
* @override
* Return the EIP712 data encoding of this instance, padding each member
* to 32 bytes and hashing the result. The ethereumjs-abi module provides
* an encode() function which does most of the heavy lifting here, and the
* structure of this function significantly inspired by the sample code
* provided in the original EIP712 proposal.
* @returns {String} the encoded data of this instance, ready for use with hashStruct
*/
encodeData() {
// Build parallel lists of types and values, to be passed to abi.encode
let types = ['bytes32']
let values = [Buffer.from(this.constructor.typeHash(), 'hex')]
for (const {type, name} of this.constructor.properties) {
if (isDynamicType(type)) {
// Dynamic types are hashed
types.push('bytes32')
values.push(Buffer.from(keccak256(this[name]), 'hex'))
} else if (type in domain.types) {
// Structure Types are recursively encoded and hashed
types.push('bytes32')
values.push(Buffer.from(keccak256(this[name].encodeData()), 'hex'))
} else <span class="missing-if-branch" title="if path not taken" >I</span>if (isArrayType(type)) {
// TODO: Figure out the spec for encoding array types
<span class="cstat-no" title="statement not covered" > throw new Error('[DEV] Array types not yet supported')</span>
} else if (isAtomicType(type)) {
// Atomic types have their encoding defined by the solidity ABI
types.push(type)
values.push(this[name])
} else {
throw new Error(`Unknown type: ${type}`)
}
}
return abi.rawEncode(types, values)
}
/**
* ABI encode this type according to the EIP712 spec. The encoding returned
* is compatible with solidity, and ready to be hashed and signed.
* @returns {String} The abi encoding of this instance, in an appropriate format to be hashed and signed
*/
encode() {
// \x19\x01 is the specified prefix for a typedData message
return Buffer.concat([
Buffer.from([0x19, 0x01]),
domain.domainSeparator,
this.hashStruct()
])
}
/**
* Return the hash to be signed, simply the Keccak256 of the encoding
* @returns {String} The hash, ready to be signed
*/
signHash() {
return Buffer.from(keccak256(this.encode()), 'hex')
}
/**
* Sign the fully encoded version of the current instance with a provided
* signer. This is equivalent to the `web3.eth.signTypedData` function.
* @param {Object} signer The signer function, which takes a buffer and return a signature
* @returns {String} the signed, encoded piece of data
*/
sign(signer) {
if (typeof signer !== 'function') {
throw new Error('Must provide a signer function')
}
return signer(this.signHash())
}
/**
* Verify a signature made by an address over this object
* @param {Object} signature
* @param {String} address
* @returns {Boolean} whether the given signature is valid over this object
*/
verifySignature(signature, address) {
const hash = this.signHash()
return verifyRawSignatureFromAddress(hash, signature, address)
}
}
// Save the new StructureType to the domain
domain.types[primaryType] = StructureType
return StructureType
}
/**
* Check the validity of a particular name/type pair within a given domain,
* and return an object containing the name and type.
*
* @param {Object} item the item being validated, must contain `name` and `type` keys
* @param {Object} domain the domain in which the item should be validated
*/
function validateTypeDefinition({name, type}, domain) {
if (!name || !type) {
throw new Error('Invalid type definition: all entries must specify name and type')
}
if (typeof type === 'object') {
// TODO: Allow recursive type defintions?
throw new Error('Nested type definitions not supported')
} else if (!isPrimitiveType(type) && !(type in domain.types)) {
// Refuse undefined, non-primitive types
throw new Error(`Type ${type} is undefined in this domain`)
}
return {name, type}
}
/**
* Recursively search a list of properties to uncover a list of all dependent types
* Each non-primitive type delegates to the dependencies of that type
*
* @param {Object[]} props The properties of a particular
* @param {Object|Domain} domain The domain object in which the dependencies are being resolved
* @param {String[]} found A list of structure type names found so far
*/
function findDependencies(props, domain, found=<span class="branch-0 cbranch-no" title="branch not covered" >[])</span> {
for (let {type} of props) {
if (isPrimitiveType(type)) continue
// Merge the found array with new dependencies of
found = found.concat(
[type, ...findDependencies(domain.types[type].properties, domain, found)]
.filter(t => !found.includes(t))
)
}
return found
}</pre></td></tr>
</table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Mon Feb 04 2019 15:22:58 GMT-0500 (EST)
</div>
</div>
<script src="prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="sorter.js"></script>
</body>
</html>