Skip to content

Commit

Permalink
Abstracted JSON-RPC parameter generation for others to use.
Browse files Browse the repository at this point in the history
  • Loading branch information
@ricmoo
ricmoo committed Mar 17, 2020
1 parent 390497f commit 030f65e
Showing 1 changed file with 51 additions and 33 deletions.
84 changes: 51 additions & 33 deletions packages/providers/src.ts/json-rpc-provider.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,80 +330,95 @@ export class JsonRpcProvider extends BaseProvider {
});
}

perform(method: string, params: any): Promise<any> {
prepareRequest(method: string, params: any): [ string, Array<any> ] {
switch (method) {
case "getBlockNumber":
return this.send("eth_blockNumber", []);
return [ "eth_blockNumber", [] ];

case "getGasPrice":
return this.send("eth_gasPrice", []);
return [ "eth_gasPrice", [] ];

case "getBalance":
return this.send("eth_getBalance", [ getLowerCase(params.address), params.blockTag ]);
return [ "eth_getBalance", [ getLowerCase(params.address), params.blockTag ] ];

case "getTransactionCount":
return this.send("eth_getTransactionCount", [ getLowerCase(params.address), params.blockTag ]);
return [ "eth_getTransactionCount", [ getLowerCase(params.address), params.blockTag ] ];

case "getCode":
return this.send("eth_getCode", [ getLowerCase(params.address), params.blockTag ]);
return [ "eth_getCode", [ getLowerCase(params.address), params.blockTag ] ];

case "getStorageAt":
return this.send("eth_getStorageAt", [ getLowerCase(params.address), params.position, params.blockTag ]);
return [ "eth_getStorageAt", [ getLowerCase(params.address), params.position, params.blockTag ] ];

case "sendTransaction":
return this.send("eth_sendRawTransaction", [ params.signedTransaction ]).catch((error) => {
if (error.responseText) {
// "insufficient funds for gas * price + value"
if (error.responseText.indexOf("insufficient funds") > 0) {
logger.throwError("insufficient funds", Logger.errors.INSUFFICIENT_FUNDS, { });
}
// "nonce too low"
if (error.responseText.indexOf("nonce too low") > 0) {
logger.throwError("nonce has already been used", Logger.errors.NONCE_EXPIRED, { });
}
// "replacement transaction underpriced"
if (error.responseText.indexOf("replacement transaction underpriced") > 0) {
logger.throwError("replacement fee too low", Logger.errors.REPLACEMENT_UNDERPRICED, { });
}
}
throw error;
});
return [ "eth_sendRawTransaction", [ params.signedTransaction ] ]

case "getBlock":
if (params.blockTag) {
return this.send("eth_getBlockByNumber", [ params.blockTag, !!params.includeTransactions ]);
return [ "eth_getBlockByNumber", [ params.blockTag, !!params.includeTransactions ] ];
} else if (params.blockHash) {
return this.send("eth_getBlockByHash", [ params.blockHash, !!params.includeTransactions ]);
return [ "eth_getBlockByHash", [ params.blockHash, !!params.includeTransactions ] ];
}
return logger.throwArgumentError("invalid block tag or block hash", "params", params);
return null;

case "getTransaction":
return this.send("eth_getTransactionByHash", [ params.transactionHash ]);
return [ "eth_getTransactionByHash", [ params.transactionHash ] ];

case "getTransactionReceipt":
return this.send("eth_getTransactionReceipt", [ params.transactionHash ]);
return [ "eth_getTransactionReceipt", [ params.transactionHash ] ];

case "call": {
const hexlifyTransaction = getStatic<(t: TransactionRequest, a?: { [key: string]: boolean }) => { [key: string]: string }>(this.constructor, "hexlifyTransaction");
return this.send("eth_call", [ hexlifyTransaction(params.transaction, { from: true }), params.blockTag ]);
return [ "eth_call", [ hexlifyTransaction(params.transaction, { from: true }), params.blockTag ] ];
}

case "estimateGas": {
const hexlifyTransaction = getStatic<(t: TransactionRequest, a?: { [key: string]: boolean }) => { [key: string]: string }>(this.constructor, "hexlifyTransaction");
return this.send("eth_estimateGas", [ hexlifyTransaction(params.transaction, { from: true }) ]);
return [ "eth_estimateGas", [ hexlifyTransaction(params.transaction, { from: true }) ] ];
}

case "getLogs":
if (params.filter && params.filter.address != null) {
params.filter.address = getLowerCase(params.filter.address);
}
return this.send("eth_getLogs", [ params.filter ]);
return [ "eth_getLogs", [ params.filter ] ];

default:
break;
}

return logger.throwError(method + " not implemented", Logger.errors.NOT_IMPLEMENTED, { operation: method });
return null;
}

perform(method: string, params: any): Promise<any> {
const args = this.prepareRequest(method, params);

if (args == null) {
logger.throwError(method + " not implemented", Logger.errors.NOT_IMPLEMENTED, { operation: method });
}

// We need a little extra logic to process errors from sendTransaction
if (method === "sendTransaction") {
return this.send(args[0], args[1]).catch((error) => {
if (error.responseText) {
// "insufficient funds for gas * price + value"
if (error.responseText.indexOf("insufficient funds") > 0) {
logger.throwError("insufficient funds", Logger.errors.INSUFFICIENT_FUNDS, { });
}
// "nonce too low"
if (error.responseText.indexOf("nonce too low") > 0) {
logger.throwError("nonce has already been used", Logger.errors.NONCE_EXPIRED, { });
}
// "replacement transaction underpriced"
if (error.responseText.indexOf("replacement transaction underpriced") > 0) {
logger.throwError("replacement fee too low", Logger.errors.REPLACEMENT_UNDERPRICED, { });
}
}
throw error;
});
}

return this.send(args[0], args[1])
}

_startEvent(event: Event): void {
Expand Down Expand Up @@ -466,8 +481,11 @@ export class JsonRpcProvider extends BaseProvider {
// - gasLimit => gas
// - All values hexlified
// - All numeric values zero-striped
// - All addresses are lowercased
// NOTE: This allows a TransactionRequest, but all values should be resolved
// before this is called
// @TODO: This will likely be removed in future versions and prepareRequest
// will be the preferred method for this.
static hexlifyTransaction(transaction: TransactionRequest, allowExtra?: { [key: string]: boolean }): { [key: string]: string } {
// Check only allowed properties are given
const allowed = shallowCopy(allowedTransactionKeys);
Expand Down

0 comments on commit 030f65e

Please sign in to comment.