aboutsummaryrefslogtreecommitdiffstats
path: root/packages/web3-wrapper/src/marshaller.ts
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-08-09 23:02:13 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-08-09 23:02:13 +0800
commitd44ff6a91582ed2b4dc25059d52556c4f9c6e163 (patch)
tree9e96e2ca11625f47df4e27b0f78db35a283924fb /packages/web3-wrapper/src/marshaller.ts
parent68605ca261330acaf83daaf355170fbda20ad02f (diff)
downloaddexon-sol-tools-d44ff6a91582ed2b4dc25059d52556c4f9c6e163.tar
dexon-sol-tools-d44ff6a91582ed2b4dc25059d52556c4f9c6e163.tar.gz
dexon-sol-tools-d44ff6a91582ed2b4dc25059d52556c4f9c6e163.tar.bz2
dexon-sol-tools-d44ff6a91582ed2b4dc25059d52556c4f9c6e163.tar.lz
dexon-sol-tools-d44ff6a91582ed2b4dc25059d52556c4f9c6e163.tar.xz
dexon-sol-tools-d44ff6a91582ed2b4dc25059d52556c4f9c6e163.tar.zst
dexon-sol-tools-d44ff6a91582ed2b4dc25059d52556c4f9c6e163.zip
Add @return 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 = {