Events
Events represent state changes, like a new message or contract event.
Hubble emit events whenever it observes a state change. Since a hub may see messages in a different order than other hubs, events ordering is specific to each hub. Clients can subscribe to the hub using the Events API to get a live stream of changes to the hub.
Hubble keeps event 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 | ||
| id | uint64 | ||
| body | MergeMessageBody, PruneMessageBody, RevokeMessageBody, MergeUserNameProofBody, MergeOnChainEventBody | oneOf |
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 |
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 | 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 |
SignerEventBody
| Field | Type | Label | 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 |
|---|---|---|---|
| migrated_at | uint32 | The timestamp at which hubs were migrated to OP mainnet |
SignerEventBody
| Field | Type | Label | Description |
|---|---|---|---|
| to | bytes | The address the fid was registers/transferred to | |
| event_type | IdRegisterEventType | The type of the id register event | |
| from | bytes | The address the transfer originated from | |
| recover_address | bytes | The recovery address for the fid |
IdRegisterEventType
| Name | Number | Description |
|---|---|---|
| ID_REGISTER_EVENT_TYPE_NONE | 0 | |
| ID_REGISTER_EVENT_TYPE_REGISTER | 0 | |
| ID_REGISTER_EVENT_TYPE_TRANSFER | 0 | |
| ID_REGISTER_EVENT_TYPE_CHANGE_RECOVERY | 0 |
StorageRentEventBody
| Field | Type | Label | 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 |