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
|
import { addressUtils } from '@0x/utils';
import {
BlockParam,
BlockParamLiteral,
BlockWithoutTransactionData,
BlockWithTransactionData,
CallData,
CallTxDataBase,
LogEntry,
RawLogEntry,
Transaction,
TransactionReceipt,
TxData,
} from 'ethereum-types';
import ethUtil = require('ethereumjs-util');
import * as _ from 'lodash';
import { utils } from './utils';
import {
BlockWithoutTransactionDataRPC,
BlockWithTransactionDataRPC,
CallDataRPC,
CallTxDataBaseRPC,
TransactionReceiptRPC,
TransactionRPC,
TxDataRPC,
} from './types';
/**
* Utils to convert ethereum structures from user-space format to RPC format. (marshall/unmarshall)
*/
export const marshaller = {
/**
* Unmarshall block without transaction data
* @param blockWithHexValues block to unmarshall
* @return unmarshalled block without transaction data
*/
unmarshalIntoBlockWithoutTransactionData(
blockWithHexValues: BlockWithoutTransactionDataRPC,
): BlockWithoutTransactionData {
const block = {
...blockWithHexValues,
gasLimit: utils.convertHexToNumber(blockWithHexValues.gasLimit),
gasUsed: utils.convertHexToNumber(blockWithHexValues.gasUsed),
size: utils.convertHexToNumber(blockWithHexValues.size),
timestamp: utils.convertHexToNumber(blockWithHexValues.timestamp),
number: _.isNull(blockWithHexValues.number) ? null : utils.convertHexToNumber(blockWithHexValues.number),
difficulty: utils.convertAmountToBigNumber(blockWithHexValues.difficulty),
totalDifficulty: utils.convertAmountToBigNumber(blockWithHexValues.totalDifficulty),
};
return block;
},
/**
* Unmarshall block with transaction data
* @param blockWithHexValues block to unmarshall
* @return unmarshalled block with transaction data
*/
unmarshalIntoBlockWithTransactionData(blockWithHexValues: BlockWithTransactionDataRPC): BlockWithTransactionData {
const block = {
...blockWithHexValues,
gasLimit: utils.convertHexToNumber(blockWithHexValues.gasLimit),
gasUsed: utils.convertHexToNumber(blockWithHexValues.gasUsed),
size: utils.convertHexToNumber(blockWithHexValues.size),
timestamp: utils.convertHexToNumber(blockWithHexValues.timestamp),
number: _.isNull(blockWithHexValues.number) ? null : utils.convertHexToNumber(blockWithHexValues.number),
difficulty: utils.convertAmountToBigNumber(blockWithHexValues.difficulty),
totalDifficulty: utils.convertAmountToBigNumber(blockWithHexValues.totalDifficulty),
transactions: [] as Transaction[],
};
block.transactions = _.map(blockWithHexValues.transactions, (tx: TransactionRPC) => {
const transaction = marshaller.unmarshalTransaction(tx);
return transaction;
});
return block;
},
/**
* Unmarshall transaction
* @param txRpc transaction to unmarshall
* @return unmarshalled transaction
*/
unmarshalTransaction(txRpc: TransactionRPC): Transaction {
const tx = {
...txRpc,
blockNumber: !_.isNull(txRpc.blockNumber) ? utils.convertHexToNumber(txRpc.blockNumber) : null,
transactionIndex: !_.isNull(txRpc.transactionIndex)
? utils.convertHexToNumber(txRpc.transactionIndex)
: null,
nonce: utils.convertHexToNumber(txRpc.nonce),
gas: utils.convertHexToNumber(txRpc.gas),
gasPrice: utils.convertAmountToBigNumber(txRpc.gasPrice),
value: utils.convertAmountToBigNumber(txRpc.value),
};
return tx;
},
/**
* Unmarshall transaction receipt
* @param txReceiptRpc transaction receipt to unmarshall
* @return unmarshalled transaction receipt
*/
unmarshalTransactionReceipt(txReceiptRpc: TransactionReceiptRPC): TransactionReceipt {
const txReceipt = {
...txReceiptRpc,
blockNumber: utils.convertHexToNumber(txReceiptRpc.blockNumber),
transactionIndex: utils.convertHexToNumber(txReceiptRpc.transactionIndex),
cumulativeGasUsed: utils.convertHexToNumber(txReceiptRpc.cumulativeGasUsed),
gasUsed: utils.convertHexToNumber(txReceiptRpc.gasUsed),
logs: _.map(txReceiptRpc.logs, marshaller.unmarshalLog.bind(marshaller)),
};
return txReceipt;
},
/**
* Unmarshall transaction data
* @param txDataRpc transaction data to unmarshall
* @return unmarshalled transaction data
*/
unmarshalTxData(txDataRpc: TxDataRPC): TxData {
if (_.isUndefined(txDataRpc.from)) {
throw new Error(`txData must include valid 'from' value.`);
}
const txData = {
...txDataRpc,
value: !_.isUndefined(txDataRpc.value) ? utils.convertAmountToBigNumber(txDataRpc.value) : undefined,
gas: !_.isUndefined(txDataRpc.gas) ? utils.convertHexToNumber(txDataRpc.gas) : undefined,
gasPrice: !_.isUndefined(txDataRpc.gasPrice)
? utils.convertAmountToBigNumber(txDataRpc.gasPrice)
: undefined,
nonce: !_.isUndefined(txDataRpc.nonce) ? utils.convertHexToNumber(txDataRpc.nonce) : undefined,
};
return txData;
},
/**
* Marshall transaction data
* @param txData transaction data to marshall
* @return marshalled transaction data
*/
marshalTxData(txData: Partial<TxData>): Partial<TxDataRPC> {
if (_.isUndefined(txData.from)) {
throw new Error(`txData must include valid 'from' value.`);
}
const callTxDataBase = {
...txData,
};
delete callTxDataBase.from;
const callTxDataBaseRPC = marshaller._marshalCallTxDataBase(callTxDataBase);
const txDataRPC = {
...callTxDataBaseRPC,
from: marshaller.marshalAddress(txData.from),
};
const prunableIfUndefined = ['gasPrice', 'gas', 'value', 'nonce'];
_.each(txDataRPC, (value: any, key: string) => {
if (_.isUndefined(value) && _.includes(prunableIfUndefined, key)) {
delete (txDataRPC as any)[key];
}
});
return txDataRPC;
},
/**
* Marshall call data
* @param callData call data to marshall
* @return marshalled call data
*/
marshalCallData(callData: Partial<CallData>): Partial<CallDataRPC> {
const callTxDataBase = {
...callData,
};
delete callTxDataBase.from;
const callTxDataBaseRPC = marshaller._marshalCallTxDataBase(callTxDataBase);
const callDataRPC = {
...callTxDataBaseRPC,
from: _.isUndefined(callData.from) ? undefined : marshaller.marshalAddress(callData.from),
};
return callDataRPC;
},
/**
* Marshall address
* @param address address to marshall
* @return marshalled address
*/
marshalAddress(address: string): string {
if (addressUtils.isAddress(address)) {
return ethUtil.addHexPrefix(address);
}
throw new Error(`Invalid address encountered: ${address}`);
},
/**
* Marshall block param
* @param blockParam block param to marshall
* @return marshalled block param
*/
marshalBlockParam(blockParam: BlockParam | string | number | undefined): string | undefined {
if (_.isUndefined(blockParam)) {
return BlockParamLiteral.Latest;
}
const encodedBlockParam = _.isNumber(blockParam) ? utils.numberToHex(blockParam) : blockParam;
return encodedBlockParam;
},
/**
* Unmarshall log
* @param rawLog log to unmarshall
* @return unmarshalled log
*/
unmarshalLog(rawLog: RawLogEntry): LogEntry {
const formattedLog = {
...rawLog,
logIndex: utils.convertHexToNumberOrNull(rawLog.logIndex),
blockNumber: utils.convertHexToNumberOrNull(rawLog.blockNumber),
transactionIndex: utils.convertHexToNumberOrNull(rawLog.transactionIndex),
};
return formattedLog;
},
_marshalCallTxDataBase(callTxDataBase: Partial<CallTxDataBase>): Partial<CallTxDataBaseRPC> {
const callTxDataBaseRPC = {
...callTxDataBase,
to: _.isUndefined(callTxDataBase.to) ? undefined : marshaller.marshalAddress(callTxDataBase.to),
gasPrice: _.isUndefined(callTxDataBase.gasPrice)
? undefined
: utils.encodeAmountAsHexString(callTxDataBase.gasPrice),
gas: _.isUndefined(callTxDataBase.gas) ? undefined : utils.encodeAmountAsHexString(callTxDataBase.gas),
value: _.isUndefined(callTxDataBase.value)
? undefined
: utils.encodeAmountAsHexString(callTxDataBase.value),
nonce: _.isUndefined(callTxDataBase.nonce)
? undefined
: utils.encodeAmountAsHexString(callTxDataBase.nonce),
};
return callTxDataBaseRPC;
},
};
|
