Skip to content

Commit f88fa5c

Browse files
committed
keeping docs just on interfaces
1 parent 5050228 commit f88fa5c

File tree

4 files changed

+2
-43
lines changed

4 files changed

+2
-43
lines changed

yarn-project/archiver/src/archiver/archiver.ts

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1415,23 +1415,10 @@ export class Archiver
14151415
return this.store.getSettledTxReceipt(txHash);
14161416
}
14171417

1418-
/**
1419-
* Gets all private logs that match any of the received tags (i.e. logs with their first field equal to a SiloedTag).
1420-
* @param tags - The SiloedTags to filter the logs by.
1421-
* @param logsPerTag - The number of logs to return per tag. Defaults to everything
1422-
* @returns For each received tag, an array of matching private logs is returned. An empty array implies no logs match that tag.
1423-
*/
14241418
getPrivateLogsByTags(tags: SiloedTag[], logsPerTag?: number): Promise<TxScopedL2Log[][]> {
14251419
return this.store.getPrivateLogsByTags(tags, logsPerTag);
14261420
}
14271421

1428-
/**
1429-
* Gets all public logs that match any of the received tags (i.e. logs with their first field equal to a Tag).
1430-
* @param tags - The Tags to filter the logs by.
1431-
* @param logsPerTag - The number of logs to return per tag. Defaults to everything
1432-
* @returns For each received tag, an array of matching public logs is returned. An empty array implies no logs match
1433-
* that tag.
1434-
*/
14351422
getPublicLogsByTagsFromContract(
14361423
contractAddress: AztecAddress,
14371424
tags: Tag[],

yarn-project/archiver/src/archiver/kv_archiver_store/kv_archiver_store.ts

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -318,13 +318,6 @@ export class KVArchiverDataStore implements ArchiverDataStore, ContractDataSourc
318318
return this.#messageStore.getL1ToL2Messages(checkpointNumber);
319319
}
320320

321-
/**
322-
* Gets all private logs that match any of the received tags (i.e. logs with their first field equal to a SiloedTag).
323-
* @param tags - The SiloedTags to filter the logs by.
324-
* @param logsPerTag - How many logs to return per tag. Default returns everything
325-
* @returns For each received tag, an array of matching private logs is returned. An empty array implies no logs match
326-
* that tag.
327-
*/
328321
getPrivateLogsByTags(tags: SiloedTag[], logsPerTag?: number): Promise<TxScopedL2Log[][]> {
329322
try {
330323
return this.#logStore.getPrivateLogsByTags(tags, logsPerTag);
@@ -333,14 +326,6 @@ export class KVArchiverDataStore implements ArchiverDataStore, ContractDataSourc
333326
}
334327
}
335328

336-
/**
337-
* Gets all public logs that match any of the received tags from the specified contract (i.e. logs with their first field equal to a Tag).
338-
* @param contractAddress - The contract that emitted the public logs.
339-
* @param tags - The Tags to filter the logs by.
340-
* @param logsPerTag - How many logs to return per tag. Default returns everything
341-
* @returns For each received tag, an array of matching public logs is returned. An empty array implies no logs match
342-
* that tag.
343-
*/
344329
getPublicLogsByTagsFromContract(
345330
contractAddress: AztecAddress,
346331
tags: Tag[],

yarn-project/aztec-node/src/aztec-node/server.ts

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -695,24 +695,10 @@ export class AztecNodeService implements AztecNode, AztecNodeAdmin, Traceable {
695695
return this.contractDataSource.getContract(address);
696696
}
697697

698-
/**
699-
* Gets all private logs that match any of the received tags (i.e. logs with their first field equal to a SiloedTag).
700-
* @param tags - The SiloedTags to filter the logs by.
701-
* @param logsPerTag - The maximum number of logs to return for each tag. By default no limit is set
702-
* @returns For each received tag, an array of matching private logs is returned. An empty array implies no logs match
703-
* that tag.
704-
*/
705698
public getPrivateLogsByTags(tags: SiloedTag[], logsPerTag?: number): Promise<TxScopedL2Log[][]> {
706699
return this.logsSource.getPrivateLogsByTags(tags, logsPerTag);
707700
}
708701

709-
/**
710-
* Gets all public logs that match any of the received tags (i.e. logs with their first field equal to a Tag).
711-
* @param tags - The Tags to filter the logs by.
712-
* @param logsPerTag - The maximum number of logs to return for each tag. By default no limit is set
713-
* @returns For each received tag, an array of matching public logs is returned. An empty array implies no logs match
714-
* that tag.
715-
*/
716702
public getPublicLogsByTagsFromContract(
717703
contractAddress: AztecAddress,
718704
tags: Tag[],

yarn-project/stdlib/src/interfaces/l2_logs_source.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ export interface L2LogsSource {
2121
getPrivateLogsByTags(tags: SiloedTag[], logsPerTag?: number): Promise<TxScopedL2Log[][]>;
2222

2323
/**
24-
* Gets all public logs that match any of the received tags from the specified contract (i.e. logs with their first field equal to a Tag).
24+
* Gets all public logs that match any of the received tags from the specified contract (i.e. logs with their first
25+
* field equal to a Tag).
2526
* @param contractAddress - The contract that emitted the public logs.
2627
* @param tags - The Tags to filter the logs by.
2728
* @param logsPerTag - The maximum number of logs to return for each tag. Default returns everything

0 commit comments

Comments
 (0)