@ecp.eth/protocol

This interface defines the core functionality for managing channels and their associated hooks

Events

BaseURIUpdated(string baseURI)

Emitted when the base URI for NFT metadata is updated

ChannelCreated(uint256 channelId, string name, string description, [struct Metadata.MetadataEntry[]](/protocol-reference/types/Metadata#metadataentry) metadata, address hook, address owner)

Emitted when a new channel is created

ChannelUpdated(uint256 channelId, string name, string description, [struct Metadata.MetadataEntry[]](/protocol-reference/types/Metadata#metadataentry) metadata)

Emitted when a channel's configuration is updated

HookSet(uint256 channelId, address hook)

Emitted when a hook is set for a channel

HookStatusUpdated(uint256 channelId, address hook, bool enabled)

Emitted when a hook's enabled status is updated

ChannelMetadataSet(uint256 channelId, bytes32 key, bytes value)

Emitted when channel metadata is set

Functions

createChannel(string name, string description, struct Metadata.MetadataEntry[] metadata, address hook) → uint256 channelId (external)

Creates a new channel

getChannel(uint256 channelId) → struct Channels.Channel (external)

Get a channel by its ID

updateChannel(uint256 channelId, string name, string description, struct Metadata.MetadataEntryOp[] metadataOperations) (external)

Updates an existing channel's configuration

setHook(uint256 channelId, address hook) (external)

Sets the hook for a channel

setBaseURI(string baseURI_) (external)

Sets the base URI for NFT metadata

channelExists(uint256 channelId) → bool (external)

Checks if a channel exists

getChannelMetadata(uint256 channelId) → struct Metadata.MetadataEntry[] (external)

Get all metadata for a channel

getChannelMetadataValue(uint256 channelId, bytes32 key) → bytes (external)

Get metadata value for a specific key

getChannelMetadataKeys(uint256 channelId) → bytes32[] (external)

Get all metadata keys for a channel