rename omitUtxo to omitBoxes

Emurgo · Nov 28, 2021 · d8e559d · d8e559d
1 parent 81ebd83
commit d8e559d
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -100,7 +100,7 @@ This is a wrapper for the [Ergo explorer API](https://explorer.ergoplatform.com/
       tx: string, // tx hash
     |},
     untilBlock: string, // block hash - inclusive
-    omitUtxo?: boolean // setting this to true means the response will not include inputs, dataInputs nor outputs
+    omitBoxes?: boolean // setting this to true means the response will not include inputs, dataInputs nor outputs
   }
   ```
   Output:

diff --git a/src/api.js b/src/api.js
@@ -39,7 +39,6 @@ import type {
 
 const addressesRequestLimit = 50;
 const apiResponseLimit = 20;
-const apiTransactionsBoxesLimit = 20;
 
 const isNumberOrBigint = (x: *): boolean =>
   (typeof x === 'number') || BigNumber.isBigNumber(x);
@@ -611,9 +610,9 @@ const history: HandlerFunction = async function (req, _res) {
       hash: tx.id,
       time: iso8601date,
       tx_state: 'Successful',
-      inputs: input.omitUtxo ? undefined : tx.inputs,
-      dataInputs: input.omitUtxo ? undefined : tx.dataInputs,
-      outputs: input.omitUtxo ? undefined : tx.outputs,
+      inputs: input.omitBoxes ? undefined : tx.inputs,
+      dataInputs: input.omitBoxes ? undefined : tx.dataInputs,
+      outputs: input.omitBoxes ? undefined : tx.outputs,
     });
   }
   // 2) add the pending txs
@@ -629,9 +628,9 @@ const history: HandlerFunction = async function (req, _res) {
       hash: tx.id,
       time: iso8601date,
       tx_state: 'Pending',
-      inputs: input.omitUtxo ? undefined : tx.inputs,
-      dataInputs: input.omitUtxo ? undefined : tx.dataInputs,
-      outputs: input.omitUtxo ? undefined : tx.outputs.map(output => ({
+      inputs: input.omitBoxes ? undefined : tx.inputs,
+      dataInputs: input.omitBoxes ? undefined : tx.dataInputs,
+      outputs: input.omitBoxes ? undefined : tx.outputs.map(output => ({
         ...output,
       })),
     });

diff --git a/src/types/wrapperApi.js b/src/types/wrapperApi.js
@@ -37,7 +37,7 @@ export type HistoryInput = {|
     tx: string, // tx hash
   |},
   untilBlock: string, // block hash - inclusive
-  omitUtxo?: boolean // setting this to true means the response will not include inputs, dataInputs nor outputs
+  omitBoxes?: boolean // setting this to true means the response will not include inputs, dataInputs nor outputs
 |};
 export type HistoryOutput = Array<{
   block_hash: null | string,

diff --git a/test/real.test.js b/test/real.test.js
@@ -249,7 +249,7 @@ const specs: Array<Spec> = [
     input: {
       addresses: ['9hK1EHKmPPQu4YJrZDjQ2E5sYZxkHFGvU5kVTcxTxojgP28tWzC'],
       untilBlock: '008a03ddb289aea660f69165245b1448a3fb16dfc7b04061489a77f8911b6572',
-      omitUtxo: true,
+      omitBoxes: true,
     },
     output: (output) => {
       for (let o of output) {