viem
Version:
72 lines • 2.49 kB
JavaScript
import { encodeEventTopics, } from '../../utils/abi/encodeEventTopics.js';
import { parseEventLogs } from '../../utils/abi/parseEventLogs.js';
import { numberToHex, } from '../../utils/encoding/toHex.js';
import { formatLog, } from '../../utils/formatters/log.js';
/**
* Returns a list of event logs matching the provided parameters.
*
* - Docs: https://viem.sh/docs/actions/public/getLogs
* - Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/logs_event-logs
* - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs)
*
* @param client - Client to use
* @param parameters - {@link GetLogsParameters}
* @returns A list of event logs. {@link GetLogsReturnType}
*
* @example
* import { createPublicClient, http, parseAbiItem } from 'viem'
* import { mainnet } from 'viem/chains'
* import { getLogs } from 'viem/public'
*
* const client = createPublicClient({
* chain: mainnet,
* transport: http(),
* })
* const logs = await getLogs(client)
*/
export async function getLogs(client, { address, blockHash, fromBlock, toBlock, event, events: events_, args, strict: strict_, } = {}) {
const strict = strict_ ?? false;
const events = events_ ?? (event ? [event] : undefined);
let topics = [];
if (events) {
const encoded = events.flatMap((event) => encodeEventTopics({
abi: [event],
eventName: event.name,
args: events_ ? undefined : args,
}));
// TODO: Clean up type casting
topics = [encoded];
if (event)
topics = topics[0];
}
let logs;
if (blockHash) {
logs = await client.request({
method: 'eth_getLogs',
params: [{ address, topics, blockHash }],
});
}
else {
logs = await client.request({
method: 'eth_getLogs',
params: [
{
address,
topics,
fromBlock: typeof fromBlock === 'bigint' ? numberToHex(fromBlock) : fromBlock,
toBlock: typeof toBlock === 'bigint' ? numberToHex(toBlock) : toBlock,
},
],
});
}
const formattedLogs = logs.map((log) => formatLog(log));
if (!events)
return formattedLogs;
return parseEventLogs({
abi: events,
args: args,
logs: formattedLogs,
strict,
});
}
//# sourceMappingURL=getLogs.js.map