Neynar Documentation

Events represent state changes, like a new message or contract event. Snapchain nodes emit events whenever they observe a state change. Clients can subscribe to a node using the Events API to get a live stream of changes. Snapchain keeps events around for 3 days after which they are deleted to save space. To get older data, use the GRPC or HTTP APIs.

HubEvent

Field	Type	Label	Description
type	HubEventType		The type of event
id	uint64		Unique identifier for the event that encodes block height ordering
block_number	uint64		The block number when the event was created
shard_index	uint32		The shard index where the event occurred
timestamp	uint64		The timestamp when the event was created
body	MergeMessageBody, PruneMessageBody, RevokeMessageBody, MergeUserNameProofBody, MergeOnChainEventBody, MergeFailureBody, BlockConfirmedBody	oneOf	The event payload

Event ID Construction

Event IDs are constructed to ensure chronological ordering by block. The ID combines:

The block height (when the event was created)
A sequence number within that block

This design allows clients to determine which events occurred in the same block and their relative order, which is useful for processing events in chronological sequence.

HubEventType

Name	Number	Description
HUB_EVENT_TYPE_NONE	0
HUB_EVENT_TYPE_MERGE_MESSAGE	1
HUB_EVENT_TYPE_PRUNE_MESSAGE	2
HUB_EVENT_TYPE_REVOKE_MESSAGE	3
HUB_EVENT_TYPE_MERGE_USERNAME_PROOF	6
HUB_EVENT_TYPE_MERGE_ON_CHAIN_EVENT	9
HUB_EVENT_TYPE_MERGE_FAILURE	10
HUB_EVENT_TYPE_BLOCK_CONFIRMED	11

MergeMessageBody

Field	Type	Label	Description
message	Message
deleted_messages	Message	repeated

MergeUserNameProofBody

Field	Type	Label	Description
username_proof	UserNameProof
deleted_username_proof	UserNameProof
username_proof_message	Message
deleted_username_proof_message	Message

PruneMessageBody

Field	Type	Label	Description
message	Message

RevokeMessageBody

Field	Type	Label	Description
message	Message

MergeOnChainEventBody

Field	Type	Label	Description
on_chain_event	OnChainEvent

OnChainEvent

Field	Type	Label	Description
type	OnChainEventType		The type of onchain event
chain_id	uint32		The chain id for the event
block_number	uint32		The block number for the event
block_hash	bytes		The block hash for the event
block_timestamp	uint64		The block timestamp for the event
transaction_hash	bytes		The transaction hash for the event
log_index	uint32		The log index for the event
fid	uint64		The fid the event is associated with
body	SignerEventBody, SignerMigratedEventBody, IdRegisterEventBody, StorageRentEventBody, TierPurchaseBody	oneOf
tx_index	uint32		The tx index for the event

OnChainEventType

Name	Number	Description
EVENT_TYPE_NONE	0
EVENT_TYPE_SIGNER	1
EVENT_TYPE_SIGNER_MIGRATED	2
EVENT_TYPE_ID_REGISTER	3
EVENT_TYPE_STORAGE_RENT	4
EVENT_TYPE_TIER_PURCHASE	5

SignerEventBody

Field	Type	Description
key	bytes	The bytes of the public key for the signer
key_type	uint32	The type of the key (currently only set to 1)
event_type	SignerEventType	The type of the signer event
metadata	bytes	The metadata associated with the key
metadata_type	uint32	The type of the metadata (currently only set to 1)

SignerEventType

Name	Number	Description
SIGNER_EVENT_TYPE_NONE	0
SIGNER_EVENT_TYPE_ADD	1
SIGNER_EVENT_TYPE_REMOVE	2
SIGNER_EVENT_TYPE_ADMIN_RESET	3

SignerMigratedEventBody

Field	Type	Label	Description
migratedAt	uint32		The timestamp at which nodes were migrated to OP mainnet

IdRegisterEventBody

Field	Type	Description
to	bytes	The address the fid was registered/transferred to
event_type	IdRegisterEventType	The type of the id register event
from	bytes	The address the transfer originated from
recovery_address	bytes	The recovery address for the fid

IdRegisterEventType

Name	Number	Description
ID_REGISTER_EVENT_TYPE_NONE	0
ID_REGISTER_EVENT_TYPE_REGISTER	1
ID_REGISTER_EVENT_TYPE_TRANSFER	2
ID_REGISTER_EVENT_TYPE_CHANGE_RECOVERY	3

StorageRentEventBody

Field	Type	Description
payer	bytes	The address of the payer
units	uint32	The number of units of storage purchased
expiry	uint32	The timestamp at which these units of storage will expire

TierPurchaseBody

Field	Type	Description
purchaser	bytes	The address of the purchaser
tier	uint32	The tier number purchased
units	uint32	The number of units purchased
expiry	uint32	The timestamp at which tier expires

MergeFailureBody

Field	Type	Label	Description
message	Message		The message that failed to merge
error	string		The reason for the merge failure

BlockConfirmedBody

Field	Type	Description
block_number	uint64	The block number that has been confirmed
block_hash	bytes	The hash of the confirmed block
shard_index	uint32	The shard index of the confirmed block

Overview

Guides

Data Types

gRPC API

HTTP API

Reference

Events

HubEvent

Event ID Construction

HubEventType

MergeMessageBody

MergeUserNameProofBody

PruneMessageBody

RevokeMessageBody

MergeOnChainEventBody

OnChainEvent

OnChainEventType

SignerEventBody

SignerEventType

SignerMigratedEventBody

IdRegisterEventBody

IdRegisterEventType

StorageRentEventBody

TierPurchaseBody

MergeFailureBody

BlockConfirmedBody

​HubEvent

​Event ID Construction

​HubEventType

​MergeMessageBody

​MergeUserNameProofBody

​PruneMessageBody

​RevokeMessageBody

​MergeOnChainEventBody

​OnChainEvent

​OnChainEventType

​SignerEventBody

​SignerEventType

​SignerMigratedEventBody

​IdRegisterEventBody

​IdRegisterEventType

​StorageRentEventBody

​TierPurchaseBody

​MergeFailureBody

​BlockConfirmedBody

HubEvent

Event ID Construction

HubEventType

MergeMessageBody

MergeUserNameProofBody

PruneMessageBody

RevokeMessageBody

MergeOnChainEventBody

OnChainEvent

OnChainEventType

SignerEventBody

SignerEventType

SignerMigratedEventBody

IdRegisterEventBody

IdRegisterEventType

StorageRentEventBody

TierPurchaseBody

MergeFailureBody

BlockConfirmedBody