updated docs and comments

AztecProtocol · Oct 11, 2023 · 6a450f6 · 6a450f6
1 parent 3195aec
commit 6a450f6
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 7 deletions.
diff --git a/yarn-project/archiver/src/archiver/archiver_store.ts b/yarn-project/archiver/src/archiver/archiver_store.ts
@@ -369,7 +369,7 @@ export class MemoryArchiverStore implements ArchiverDataStore {
    * Gets unencrypted logs based on the provided filter.
    * @param filter - The filter to apply to the logs.
    * @returns The requested logs.
-   * @throws If filter is invalid.
+   * @remarks Works by doing an intersection of all params in the filter.
    */
   getUnencryptedLogs(filter: LogFilter): Promise<GetsUnencryptedLogsResponse> {
     let txHash: TxHash | undefined;

diff --git a/yarn-project/cli/README.md b/yarn-project/cli/README.md
@@ -387,7 +387,8 @@ aztec-cli parse-parameter-struct 0xabcdef1234567890abcdef1234567890abcdef1234567
 
 ### get-logs
 
-Gets all the unencrypted logs from L2 blocks in the specified range.
+Applies filter and returns the resulting unencrypted logs.
+The filter is applied by doing an intersection of all its params.
 
 Syntax:
 

diff --git a/yarn-project/cli/src/index.ts b/yarn-project/cli/src/index.ts
@@ -283,7 +283,7 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
 
   program
     .command('get-logs')
-    .description('Gets all the unencrypted logs from L2 blocks in the range specified.')
+    .description('Gets all the unencrypted logs from an intersection of all the filter params.')
     .option('-tx, --tx-hash <txHash>', 'A transaction hash to get the receipt for.', parseOptionalTxHash)
     .option(
       '-fb, --from-block <blockNum>',

diff --git a/yarn-project/types/src/logs/log_filter.ts b/yarn-project/types/src/logs/log_filter.ts
@@ -4,23 +4,21 @@ import { LogId, TxHash } from '../index.js';
 
 /**
  * Log filter used to fetch L2 logs.
+ * @remarks This filter is applied as an intersection of all it's params.
  */
 export type LogFilter = {
   /**
    * Hash of a transaction from which to fetch the logs.
-   * @remarks If this is set, `fromBlock` and `toBlock` can't be defined.
    */
   txHash?: TxHash;
   /**
    * The block number from which to start fetching logs (inclusive).
-   * @remarks If this is set, `txHash` can't be defined.
    */
   fromBlock?: number;
   /** The block number until which to fetch logs (not inclusive). */
   toBlock?: number;
   /**
-   * Log id after which to start fetching logs .
-   * @remarks This is a continuation parameter and when it is set, txHash and fromBlock and toBlock are ignored.
+   * Log id after which to start fetching logs.
    */
   afterLog?: LogId;
   /** The contract address to filter logs by. */