Skip to content

@ecp.eth/sdk


@ecp.eth/sdk / channel-manager

channel-manager

Ethereum Comments Protocol SDK Channel Manager Core functionality for managing comment channels

Type Aliases

Type AliasDescription
ChannelExistsParams-
CreateChannelParams-
CreateChannelResult-
DeductProtocolHookTransactionFeeParams-
DeductProtocolHookTransactionFeeResult-
GetChannelCreationFeeParams-
GetChannelCreationFeeResult-
GetChannelMetadataParams-
GetChannelMetadataResult-
GetChannelParams-
GetChannelResult-
GetCommentCreationFeeParams-
GetCommentCreationFeeResult-
GetHookTransactionFeeParams-
GetHookTransactionFeeResult-
OwnerOfParams-
OwnerOfResult-
SetBaseURIParams-
SetBaseURIResult-
SetChannelCreationFeeParams-
SetChannelCreationFeeResult-
SetCommentCreationFeeParams-
SetCommentCreationFeeResult-
SetHookParams-
SetHookResult-
SetHookTransactionFeeParams-
SetHookTransactionFeeResult-
UpdateChannelParams-
UpdateChannelResult-
WithdrawFeesParams-
WithdrawFeesResult-

Variables

VariableDescription
createChannelCreate a new channel
updateChannelUpdate a channel

Functions

FunctionDescription
channelExistsCheck if a channel exists
deductProtocolHookTransactionFeeCalculates the hook transaction fee by deducting the protocol fee
estimateChannelEditCommentFeeBest-effort estimation of the total fee for editing a comment to a channel
estimateChannelPostCommentFeeBest-effort estimation of the total fee for posting a comment to a channel
getChannelGet a channel
getChannelCreationFeeGet the creation fee from channel manager
getChannelMetadataGet channel metadata
getCommentCreationFeeGet the creation fee from channel manager
getEstimatedChannelEditCommentHookFeeIt calls the estimateEditCommentFee function on the hook to retrieve the estimated fee for editing a comment to a channel. It also tries to probe if the hook is any known legacy hook and return corresponding fee estimation. For estimation of total fee, use the estimateChannelEditCommentFee helper
getEstimatedChannelPostCommentHookFeeIt calls the estimateAddCommentFee function on the hook to retrieve the estimated fee for posting a comment to a channel. It also tries to probe if the hook is any known legacy hook and return corresponding fee estimation. For estimation of total fee, use the estimateChannelPostCommentFee helper
getHookTransactionFeeGet the hook transaction fee from channel manager
ownerOfGet the owner of a channel
setBaseURISets the base URI for NFT metadata
setChannelCreationFeeSet the fee for creating a new channel
setCommentCreationFeeSet the fee for creating a new comment
setHookSet the hook for a channel
setHookTransactionFeeSet the percentage of the fee for the hook transaction
withdrawFeesWithdraws accumulated fees to a specified address

References

BaseHookABIType

Re-exports BaseHookABIType


Channel

Re-exports Channel


ChannelManagerABIType

Re-exports ChannelManagerABIType


ChannelPermissions

Re-exports ChannelPermissions


ContractBasedAssetERCType

Re-exports ContractBasedAssetERCType


ContractBasedAssetType

Re-exports ContractBasedAssetType


ContractReadFunctions

Re-exports ContractReadFunctions


ContractWriteFunctions

Re-exports ContractWriteFunctions


HookContractReadFunctions

Re-exports HookContractReadFunctions


HookFeeEstimation

Re-exports HookFeeEstimation


TotalFeeEstimation

Re-exports TotalFeeEstimation