fix(types): correct type of getTxField PE-2284

ar-io · Oct 17, 2022 · 2f15049 · 2f15049
1 parent b3bef1f
commit 2f15049
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/src/arweave/composite-client.ts b/src/arweave/composite-client.ts
@@ -480,10 +480,10 @@ export class ArweaveCompositeClient
     }
   }
 
-  async getTxField<T>(
+  async getTxField<K extends keyof PartialJsonTransaction>(
     txId: string,
-    field: keyof PartialJsonTransaction,
-  ): Promise<T> {
+    field: K,
+  ): Promise<PartialJsonTransaction[K]> {
     try {
       this.failureSimulator.maybeFail();
 

diff --git a/src/arweave/tx-chunks-data-source.ts b/src/arweave/tx-chunks-data-source.ts
@@ -32,7 +32,7 @@ export class TxChunksDataSource implements TxDataSource {
 
     try {
       const [txDataRoot, txOffset] = await Promise.all([
-        this.chainSource.getTxField<string>(txId, 'data_root'),
+        this.chainSource.getTxField(txId, 'data_root'),
         this.chainSource.getTxOffset(txId),
       ]);
       const size = +txOffset.size;

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -152,7 +152,10 @@ export interface ChainSource {
   getBlockByHeight(height: number): Promise<PartialJsonBlock>;
   getTx(txId: string): Promise<PartialJsonTransaction>;
   getTxOffset(txId: string): Promise<JsonTransactionOffset>;
-  getTxField<T>(txId: string, field: keyof PartialJsonTransaction): Promise<T>;
+  getTxField<K extends keyof PartialJsonTransaction>(
+    txId: string,
+    field: K,
+  ): Promise<PartialJsonTransaction[K]>;
   getBlockAndTxsByHeight(height: number): Promise<{
     block: PartialJsonBlock;
     txs: PartialJsonTransaction[];

diff --git a/test/stubs.ts b/test/stubs.ts
@@ -90,12 +90,12 @@ export class ArweaveChainSourceStub implements ChainSource {
     }
   }
 
-  async getTxField<T>(
+  async getTxField<K extends keyof PartialJsonTransaction>(
     txId: string,
-    field: keyof PartialJsonTransaction,
-  ): Promise<T> {
+    field: K,
+  ): Promise<PartialJsonTransaction[K]> {
     const tx = await this.getTx(txId);
-    return tx[field] as T;
+    return tx[field];
   }
 
   async getBlockAndTxsByHeight(height: number) {