aboutsummaryrefslogtreecommitdiffstats
path: root/packages/web3-wrapper/src/marshaller.ts
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-14 04:01:32 +0800
committerFabio Berger <me@fabioberger.com>2018-08-14 04:01:32 +0800
commit9d3c287918389d07f884245bd1bc968955768b6f (patch)
tree460fded537c7d64154972b7d14332f88554d14c0 /packages/web3-wrapper/src/marshaller.ts
parentc2b5fe3d844d35966c5498326000bd8317fb547c (diff)
parent15e15f994a1b18cf2e9be151194c826d53a01601 (diff)
downloaddexon-sol-tools-9d3c287918389d07f884245bd1bc968955768b6f.tar
dexon-sol-tools-9d3c287918389d07f884245bd1bc968955768b6f.tar.gz
dexon-sol-tools-9d3c287918389d07f884245bd1bc968955768b6f.tar.bz2
dexon-sol-tools-9d3c287918389d07f884245bd1bc968955768b6f.tar.lz
dexon-sol-tools-9d3c287918389d07f884245bd1bc968955768b6f.tar.xz
dexon-sol-tools-9d3c287918389d07f884245bd1bc968955768b6f.tar.zst
dexon-sol-tools-9d3c287918389d07f884245bd1bc968955768b6f.zip
Merge branch 'sol-cov-fixes' of github.com:0xProject/0x-monorepo into sol-cov-fixes
* 'sol-cov-fixes' of github.com:0xProject/0x-monorepo: (49 commits) Add @return comments Import marshaller directly Update comment about ethers checksummed address behavior Add packages/coverage/.gitkeep file Update CI config and package.json to run @0xproject/utils tests on CI Update remaining CHANGELOG.json files Change amir picture Update CHANGELOG.json for contract-wrappers Update ethers typings for TypeScript 2.9.2 Update CHANGELOG.json for base-contract Move some ethers-related types to typescript-typings/ethers Apply prettier Add strictArgumentEncodingCheck to BaseContract and use it in contract templates fix(monorepo-scripts): Fix typo in git tag command feat(monorepo-scripts): Add confirmation prompt before publishing fix comments and styling for MixinSignatureValidator Update TypeScript to version 2.9.2 Use asm for hashEIP712Message, increment free memory pointer after asm hashing functions Fix comments, styling, and optimize hashOrder Remove assertion comments ...
Diffstat (limited to 'packages/web3-wrapper/src/marshaller.ts')
-rw-r--r--packages/web3-wrapper/src/marshaller.ts9
1 files changed, 9 insertions, 0 deletions
diff --git a/packages/web3-wrapper/src/marshaller.ts b/packages/web3-wrapper/src/marshaller.ts
index 7d254b49e..572a322d6 100644
--- a/packages/web3-wrapper/src/marshaller.ts
+++ b/packages/web3-wrapper/src/marshaller.ts
@@ -32,6 +32,7 @@ export const marshaller = {
/**
* Unmarshall block without transaction data
* @param blockWithHexValues block to unmarshall
+ * @return unmarshalled block without transaction data
*/
unmarshalIntoBlockWithoutTransactionData(
blockWithHexValues: BlockWithoutTransactionDataRPC,
@@ -51,6 +52,7 @@ export const marshaller = {
/**
* Unmarshall block with transaction data
* @param blockWithHexValues block to unmarshall
+ * @return unmarshalled block with transaction data
*/
unmarshalIntoBlockWithTransactionData(blockWithHexValues: BlockWithTransactionDataRPC): BlockWithTransactionData {
const block = {
@@ -73,6 +75,7 @@ export const marshaller = {
/**
* Unmarshall transaction
* @param txRpc transaction to unmarshall
+ * @return unmarshalled transaction
*/
unmarshalTransaction(txRpc: TransactionRPC): Transaction {
const tx = {
@@ -91,6 +94,7 @@ export const marshaller = {
/**
* Unmarshall transaction data
* @param txDataRpc transaction data to unmarshall
+ * @return unmarshalled transaction data
*/
unmarshalTxData(txDataRpc: TxDataRPC): TxData {
if (_.isUndefined(txDataRpc.from)) {
@@ -108,6 +112,7 @@ export const marshaller = {
/**
* Marshall transaction data
* @param txData transaction data to marshall
+ * @return marshalled transaction data
*/
marshalTxData(txData: Partial<TxData>): Partial<TxDataRPC> {
if (_.isUndefined(txData.from)) {
@@ -133,6 +138,7 @@ export const marshaller = {
/**
* Marshall call data
* @param callData call data to marshall
+ * @return marshalled call data
*/
marshalCallData(callData: Partial<CallData>): Partial<CallDataRPC> {
const callTxDataBase = {
@@ -149,6 +155,7 @@ export const marshaller = {
/**
* Marshall address
* @param address address to marshall
+ * @return marshalled address
*/
marshalAddress(address: string): string {
if (addressUtils.isAddress(address)) {
@@ -159,6 +166,7 @@ export const marshaller = {
/**
* Marshall block param
* @param blockParam block param to marshall
+ * @return marshalled block param
*/
marshalBlockParam(blockParam: BlockParam | string | number | undefined): string | undefined {
if (_.isUndefined(blockParam)) {
@@ -170,6 +178,7 @@ export const marshaller = {
/**
* Unmarshall log
* @param rawLog log to unmarshall
+ * @return unmarshalled log
*/
unmarshalLog(rawLog: RawLogEntry): LogEntry {
const formattedLog = {