toEventSignature
Returns the signature for a given event definition.
Install
import { toEventSignature } from 'viem'
Usage
import { const toEventSignature: (def: string | AbiFunction | AbiEvent) => stringReturns the signature for a given function or event definition.
toEventSignature } from 'viem'
// from event definition
const const signature_1: stringsignature_1 = function toEventSignature(def: string | AbiFunction | AbiEvent): stringReturns the signature for a given function or event definition.
toEventSignature('event Transfer(address indexed from, address indexed to, uint256 amount)')Output: Transfer(address,address,uint256)
// from an `AbiEvent` on your contract ABI
const const signature_2: stringsignature_2 = function toEventSignature(def: string | AbiFunction | AbiEvent): stringReturns the signature for a given function or event definition.
toEventSignature({
name: stringname: 'Transfer',
type: "event"type: 'event',
inputs: readonly AbiEventParameter[]inputs: [
{ name: stringname: 'address', type: "address"type: 'address', indexed: trueindexed: true },
{ name: stringname: 'address', type: "address"type: 'address', indexed: trueindexed: true },
{ name: stringname: 'uint256', type: "uint256"type: 'uint256', indexed: falseindexed: false },
],
})Output: Transfer(address,address,uint256)
Returns
string
The signature as a string value.
Parameters
definition
- Type:
string | AbiEvent
The event definition to generate a signature for.