fix(records): remove contractTxId filter remove lodash shrink readme

ar-io · Feb 26, 2024 · 50669e1 · 50669e1
1 parent 1b7f54f
commit 50669e1
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 73 deletions.
diff --git a/README.md b/README.md
@@ -44,14 +44,7 @@ const contractTxIds = [
   'I-cxQhfh0Zb9UqQNizC9PiLC41KpUeA9hjiVV02rQRw',
   'DGWp8_6c1YywKgCgBFhncMglciQyCdfX1swil4qjNSc',
 ];
-// testnet
-const testnetBalance = await arIO.testnet.getBalance({ address });
-const testnetGateway = await arIO.testnet.getGateway({ address });
-const testnetRecord = await arIO.testnet.getRecord({ domain });
-const testnetRecords = await arIO.testnet.getRecords({ contractTxIds });
-const allTestnetRecords = await arIO.testnet.getRecords({});
-
-// mainnet
+
 const balance = await arIO.mainnet.getBalance({ address });
 const gateway = await arIO.mainnet.getGateway({ address });
 const record = await arIO.mainnet.getRecord({ domain });
@@ -106,14 +99,14 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
 
 The contract that the following methods retrieve data from are determined by the `testnet` or `devnet` clients - see examples above for implementation details.
 
-| Method Name                     | Description                                                                                                                |
-| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
-| `getBalance({ address })`       | Retrieves the balance of the specified address.                                                                            |
-| `getBalances()`                 | Retrieves all balances on the ArIO contract.                                                                               |
-| `getGateway({ address })`       | Retrieves the specified gateway by address.                                                                                |
-| `getGateways()`                 | Retrieves all gateways.                                                                                                    |
-| `getRecord({ domain })`         | Retrieves a specified ArNS record by the domain name.                                                                      |
-| `getRecords({ contractTxIds })` | Retrieves all records with an optional `contractTxIds` filter to only get records associated with specified ANT contracts. |
+| Method Name               | Description                                           |
+| ------------------------- | ----------------------------------------------------- |
+| `getBalance({ address })` | Retrieves the balance of the specified address.       |
+| `getBalances()`           | Retrieves all balances on the ArIO contract.          |
+| `getGateway({ address })` | Retrieves the specified gateway by address.           |
+| `getGateways()`           | Retrieves all gateways.                               |
+| `getRecord({ domain })`   | Retrieves a specified ArNS record by the domain name. |
+| `getRecords()`            | Retrieves all records                                 |
 
 ## Developers
 

diff --git a/package.json b/package.json
@@ -99,7 +99,6 @@
   "dependencies": {
     "arweave": "^1.14.4",
     "axios": "1.4.0",
-    "lodash": "^4.17.21",
     "warp-contracts": "^1.4.34",
     "winston": "^3.11.0"
   }

diff --git a/src/common/caches/arns-remote-cache.ts b/src/common/caches/arns-remote-cache.ts
@@ -14,8 +14,6 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-import { chunk } from 'lodash';
-
 import { ARNS_TESTNET_REGISTRY_TX } from '../../constants.js';
 import {
   ArIOContract,
@@ -131,38 +129,15 @@ export class ArNSRemoteCache implements ContractCache, ArIOContract {
     return record;
   }
 
-  async getRecords({
-    contractTxIds,
-  }: {
-    contractTxIds?: string[];
-  }): Promise<Record<string, ArNSNameData>> {
+  async getRecords(): Promise<Record<string, ArNSNameData>> {
     validateContractTxId(this.contractTxId);
 
-    const contractTxIdsSet = new Set(contractTxIds);
-    const batches = chunk([...contractTxIdsSet]);
-
-    this.logger.debug(`Fetching records for ${contractTxIdsSet.size} ANT's`);
-    const records = await Promise.all(
-      batches.map((batch: string[]) =>
-        this.http.get<
-          ArNSStateResponse<'records', Record<string, ArNSNameData>>
-        >({
-          endpoint: `/contract/${this.contractTxId.toString()}/records${new URLSearchParams(batch.map((id) => ['contractTxId', id.toString()])).toString()}`,
-        }),
-      ),
-    ).then(
-      (
-        responses: ArNSStateResponse<'records', Record<string, ArNSNameData>>[],
-      ) => {
-        const recordsObj = responses.reduce(
-          (acc: Record<string, ArNSNameData>, response) => {
-            return { ...acc, ...response.records };
-          },
-          {},
-        );
-        return recordsObj;
-      },
-    );
+    this.logger.debug(`Fetching all records`);
+    const { records } = await this.http.get<
+      ArNSStateResponse<'records', Record<string, ArNSNameData>>
+    >({
+      endpoint: `/contract/${this.contractTxId.toString()}/records`,
+    });
     return records;
   }
 }
diff --git a/src/types/common.ts b/src/types/common.ts
@@ -29,11 +29,7 @@ export interface ArIOContract {
   getBalance({ address }: { address: WalletAddress }): Promise<number>;
   getBalances(): Promise<Record<WalletAddress, number>>;
   getRecord({ domain }: { domain: string }): Promise<ArNSNameData>;
-  getRecords({
-    contractTxIds,
-  }: {
-    contractTxIds?: string[];
-  }): Promise<Record<string, ArNSNameData>>;
+  getRecords(): Promise<Record<string, ArNSNameData>>;
 }
 
 /* eslint-disable @typescript-eslint/no-explicit-any */

diff --git a/tests/arns-remote-cache.test.ts b/tests/arns-remote-cache.test.ts
@@ -49,26 +49,9 @@ describe('ArNSRemoteCache', () => {
     expect(error).toBeInstanceOf(NotFound);
   });
 
-  it('should fetch records for list of contractIDs', async () => {
-    const allRecords = await remoteCacheProvider
-      .getRecords({})
-      .then((res) => Object.entries(res).slice(200))
-      .catch((e) => e); // deliberately attempting to get more than URL params can handle to test batching but limiting to 200 to not strain service
-
-    const contractTxIds = allRecords.map(([, record]) => record.contractTxId); // deliberately attempting to get more than URL params can handle to test batching but limiting to 200 to not strain service
-
-    const expectedRecords = allRecords
-      .map(([domain]) => domain)
-      .sort((a: string, b: string) => a.localeCompare(b));
-    const records = await remoteCacheProvider.getRecords({
-      contractTxIds: [...contractTxIds, ...contractTxIds], // mapping twice to test duplicates
-    });
-
-    const actualRecords = Object.keys(records).sort((a: string, b: string) =>
-      a.localeCompare(b),
-    );
+  it('should fetch all records', async () => {
+    const records = await remoteCacheProvider.getRecords();
 
     expect(records).toBeDefined();
-    expect(actualRecords).toEqual(expectedRecords);
   });
 });