Skip to content

toEventSignature

Returns the signature for a given event definition.

Install

import { toEventSignature } from 'viem'

Usage

import { 
const toEventSignature: (def: string | AbiFunction | AbiEvent) => string

Returns the signature for a given function or event definition.

toEventSignature
} from 'viem'
// from event definition const
const signature_1: string
signature_1
=
function toEventSignature(def: string | AbiFunction | AbiEvent): string

Returns 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: string
signature_2
=
function toEventSignature(def: string | AbiFunction | AbiEvent): string

Returns the signature for a given function or event definition.

toEventSignature
({
name: string
name
: 'Transfer',
type: "event"
type
: 'event',
inputs: readonly AbiEventParameter[]
inputs
: [
{
name: string
name
: 'address',
type: "address"
type
: 'address',
indexed: true
indexed
: true },
{
name: string
name
: 'address',
type: "address"
type
: 'address',
indexed: true
indexed
: true },
{
name: string
name
: 'uint256',
type: "uint256"
type
: 'uint256',
indexed: false
indexed
: 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.