eth-typed-data
Version:
A library to simplifiy interacting with and signing EIP712 typed data
765 lines (761 loc) • 23.5 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for Domain.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> Domain.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Statements</span>
<span class='fraction'>68/68</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">97.22% </span>
<span class="quiet">Branches</span>
<span class='fraction'>35/36</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>16/16</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Lines</span>
<span class='fraction'>63/63</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</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-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-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">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-yes">90x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">79x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">79x</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-yes">1x</span>
<span class="cline-any cline-yes">17x</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-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">16x</span>
<span class="cline-any cline-yes">16x</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">16x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">16x</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">16x</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">59x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-yes">57x</span>
<span class="cline-any cline-yes">39x</span>
<span class="cline-any cline-yes">18x</span>
<span class="cline-any cline-yes">17x</span>
<span class="cline-any cline-yes">17x</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-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">50x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">14x</span>
<span class="cline-any cline-yes">36x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-yes">34x</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-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">4x</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-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">4x</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">17x</span>
<span class="cline-any cline-yes">79x</span>
<span class="cline-any cline-yes">17x</span>
<span class="cline-any cline-yes">79x</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-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-yes">16x</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">5x</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-yes">5x</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-yes">5x</span>
<span class="cline-any cline-yes">12x</span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-yes">5x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</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-yes">14x</span>
<span class="cline-any cline-yes">8x</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">4x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</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">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </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 Type from './Type'
import { validate as validatePrimitive, isArrayType, isPrimitiveType, getElementaryType, isNotStructureType } from './primitives'
// The set of properties that a EIP712Domain MAY implement
export const EIP712DomainProperties = [
{ name: "name", type: "string" },
{ name: "version", type: "string" },
{ name: "chainId", type: "uint256" },
{ name: "verifyingContract", type: "address" },
{ name: "salt", type: "bytes32" },
]
/**
* A constructor/factory function which constructs EIP712 Domains as types,
* then returns a new instance of the domain. Since an instantiated EIP712
* Domain needs to share many static methods with the types it contains
* (e.g. encodeType, typeHash), but does not require that all properties
* are present in a given instance, we define a new prototype for each Domain
* which specifies the provided properties as its type definition, and then
* instantiates that prototype with the provided values.
* @param {Object} def The definition of the EIP712 domain
* @returns {Object} An instantiated EIP712Domain type with the specified properties
*/
export default function EIP712Domain(def) {
const vals = {}
// Extract the EIP712 domain properties that were provided
const properties = EIP712DomainProperties.reduce((props, {name, type}) => {
// Skip unused EIP712 types
if (!(name in def)) return props
// Validate primitive types
vals[name] = validatePrimitive[type](def[name])
// Include property in type definition
return [...props, {name, type}]
}, [])
// Throw an error if extra properties were provided
if (Object.keys(vals).length !== Object.keys(def).length) {
throw new Error('Extra key in EIP712Domain definition')
} else if (Object.keys(def).length === 0) {
throw new Error('Must supply at least one EIP712Domain property')
}
/**
* @classdesc
* A domain is a scope in which we can define multiple Types which can
* reference each other. A domain behaves similarly to a Type, with the
* primary difference that it also includes a set of types that can
* reference each other within it. The primary method of a
* domain is `createType()` which will return a new constructor
* for a type that lives within this domain.
*/
class Domain extends AbstractType {
static name = 'EIP712Domain'
static properties = properties
static dependencies = []
constructor(vals) {
super()
this.vals = { ...vals }
// The types object maps String names to the type prototypes that exist
// within this domain. Prototypes are appendended to this.types for every
// call to this.createType()
this.types = {}
// Precompute the domainSeparator for use with signing types in this domain
this.domainSeparator = this.hashStruct()
/**
* Construct a new type that will be associated with this domain
* @returns {Function} the constructor for the new type class
*/
this.createType = Type.bind(this)
}
/**
* Validate that a particular object conforms to a valid type definition in this domain,
* and return a standardized version of input value. In particular, structure types will
* be coerced to an instance of the corresponding structure class, array types will validate
* each item according to the base type of the array, and primitive types will be validated
* by the appropriate validator in `validatePrimitive`
*
* @param {String} type the string name of the type of the value being validated
* @param {Any} val the candidate value of the type to be validated/standardized
* @returns {Any} the standardized/validated representation of this
*
* @throws {Error} if the input is an invalid instance of the given type
*/
validate(type, val) {
if (isArrayType(type)) {
// Apply the validator to each item in an array, using the base type
return val.map(item => this.validate(getElementaryType(type), item))
} else if (isPrimitiveType(type)) {
return validatePrimitive[type](val)
} else if (type in this.types) {
const StructType = this.types[type]
return (val instanceof StructType) ? val : new StructType(val)
} else {
throw new Error(`Type ${type} not recognized in this domain`)
}
}
/**
* Recursively expand an object containing instances of structure type classes,
* and return a bare javascript object with the same hierarchical structure
* Conceptually the opposite of @see this.validate
* @param {String} type the string name of the type of value being serialized
* @param {Any} val the type instance or primitive literal being serialized
* @returns {Object}
* @throws {Error}
*/
serialize(type, val) {
if (type in this.types) {
// Recursively expand nested structure types
return val.toObject()
} else if (isArrayType(type)) {
// Map serializer to array types
return val.map(item => this.serialize(getElementaryType(type), item))
} else if (isPrimitiveType(type)) {
return val
} else {
throw new Error(`Type ${type} is not a valid type in this domain`)
}
}
/**
* Return an object mapping the names of types contained by this domain
* to their list-style type definitions
* @returns {Object} Mapping from type name -> type definition
*/
listTypes() {
return Object.keys(this.types)
.reduce((obj, t) => ({...obj, [t]: this.types[t].typeDef()}), {})
}
/**
* Concatenate the type definition for this domain, with
* the definition of all the types that it contains
* @returns {Object}
*/
toDomainDef() {
return {
[this.constructor.name]: this.constructor.typeDef(),
...this.listTypes()
}
}
/**
* @override
* A simplified encodeData function that only needs to handle string
* and atomic types. Still defers to abi.rawEncode.
* @returns {String} encoding of the definition of this Domain
*/
encodeData() {
const types = this.constructor.properties.map(({type}) =>
type === 'string' ? 'bytes32' : type)
const values = this.constructor.properties.map(({name, type}) =>
type === 'string' ? Buffer.from(keccak256(this.vals[name]), 'hex') : this.vals[name])
return abi.rawEncode(
['bytes32', ...types],
[Buffer.from(this.constructor.typeHash(), 'hex'), ...values]
)
}
/**
* @override
*/
toObject() {
return {...this.vals}
}
}
return new Domain(vals)
}
/**
* Create a message object and domain from a raw signature request object.
* @param {Object} request An object representing a signature request
* @returns {Object} the constructed {domain} and {message} instances
* @throws {Error} if signature request contains cyclic dependencies
*/
EIP712Domain.fromSignatureRequest = function fromSignatureRequest(request) {
const { types, message: rawMessage, primaryType, domain: rawDomain } = request
// Create the domain instance
const domain = new EIP712Domain(rawDomain)
// Perform a (reverse) topological sort for dependency resolution, keeping track of depth first search postorder
const postorder = []
// Keep track of already visited types, as well as potential cycles
const marked = new Set(), cyclecheck = new Set()
// Define recursive depth-first search with cycle detection
const dfs = type => {
for (const {type: subtype} of types[type]) {
if (marked.has(subtype) || isNotStructureType(subtype)) continue
if (cyclecheck.has(subtype)) {
throw new Error('Cannot construct domain from signature request with cyclic dependencies')
}
cyclecheck.add(subtype)
dfs(subtype)
}
postorder.push(type)
marked.add(type)
}
// Perform the search
for (const type of Object.keys(types)) {
if (type !== 'EIP712Domain' && !marked.has(type)) {
dfs(type)
}
}
// Create all necessary structure types in this domain
// Iterate in postorder to guarantee dependencies are satisfied
for (const name of postorder) {
<span class="missing-if-branch" title="else path not taken" >E</span>if (name !== 'EIP712Domain') {
domain.createType(name, types[name])
}
}
// Create the message instance
const MessageType = domain.types[primaryType]
const message = new MessageType(rawMessage)
return { domain, message }
}
</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>