Skip to content

@ecp.eth/sdk


@ecp.eth/sdk / channel-manager / CreateChannelParams

Type Alias: CreateChannelParams

type CreateChannelParams = {
  channelManagerAddress?: Hex;
  description?: string;
  fee?: bigint;
  hook?: Hex;
  metadata?: MetadataEntry[];
  name: string;
  writeContract: ContractWriteFunctions["createChannel"];
};

Defined in: packages/sdk/src/channel-manager/channel.ts:23

Properties

channelManagerAddress?

optional channelManagerAddress: Hex;

Defined in: packages/sdk/src/channel-manager/channel.ts:49

The address of the channel manager

Default

CHANNEL_MANAGER_ADDRESS

description?

optional description: string;

Defined in: packages/sdk/src/channel-manager/channel.ts:31

The description of the channel


fee?

optional fee: bigint;

Defined in: packages/sdk/src/channel-manager/channel.ts:43

The fee for creating the channel this will be paid in the ETH by the caller.


hook?

optional hook: Hex;

Defined in: packages/sdk/src/channel-manager/channel.ts:39

The hook of the channel


metadata?

optional metadata: MetadataEntry[];

Defined in: packages/sdk/src/channel-manager/channel.ts:35

The metadata of the channel


name

name: string;

Defined in: packages/sdk/src/channel-manager/channel.ts:27

The name of the channel


writeContract

writeContract: ContractWriteFunctions["createChannel"];

Defined in: packages/sdk/src/channel-manager/channel.ts:50