Interface CommonChannelOptions

See

https://github.com/aeternity/protocol/blob/6734de2e4c7cce7e5e626caa8305fb535785131d/node/api/channels_api_usage.md#channel-establishing-parameters

interface CommonChannelOptions {
    channelReserve?: number | BigNumber;
    debug?: boolean;
    existingChannelId?: `ch_${string}`;
    existingFsmId?: `ba_${string}`;
    fee?: number | BigNumber;
    gasPrice?: number | BigNumber;
    initiatorAmount: number | BigNumber;
    initiatorId: `ak_${string}`;
    lockPeriod: number;
    minimumDepth?: number;
    minimumDepthStrategy?: "txfee" | "plain";
    offChainTx?: `tx_${string}`;
    offchainTx?: `tx_${string}`;
    port: number;
    pushAmount: number | BigNumber;
    reconnectTx?: `tx_${string}`;
    responderAmount: number | BigNumber;
    responderId: `ak_${string}`;
    sign: SignTxWithTag;
    signedTx?: `tx_${string}`;
    timeoutAccept?: number;
    timeoutAwaitingOpen?: number;
    timeoutFundingCreate?: number;
    timeoutFundingLock?: number;
    timeoutFundingSign?: number;
    timeoutIdle?: number;
    timeoutInitialized?: number;
    timeoutSign?: number;
    ttl?: number;
    url: string;
}

Properties

channelReserve? debug? existingChannelId? existingFsmId? fee? gasPrice? initiatorAmount initiatorId lockPeriod minimumDepth? minimumDepthStrategy? offChainTx? offchainTx? port pushAmount reconnectTx? responderAmount responderId sign signedTx? timeoutAccept? timeoutAwaitingOpen? timeoutFundingCreate? timeoutFundingLock? timeoutFundingSign? timeoutIdle? timeoutInitialized? timeoutSign? ttl? url

Properties

Optional channelReserve

channelReserve?: number | BigNumber

The minimum amount both peers need to maintain

Optional debug

debug?: boolean

Log websocket communication and state changes

Optional existingChannelId

existingChannelId?: `ch_${string}`

Existing channel id (required if reestablishing a channel)

Optional existingFsmId

existingFsmId?: `ba_${string}`

Optional fee

fee?: number | BigNumber

The fee to be used for the channel open transaction

Optional gasPrice

gasPrice?: number | BigNumber

Used for the fee computation of the channel open transaction

initiatorAmount

initiatorAmount: number | BigNumber

Amount of coins the initiator has committed to the channel

initiatorId

initiatorId: `ak_${string}`

Initiator's public key

lockPeriod

lockPeriod: number

Amount of blocks for disputing a solo close

Optional minimumDepth

minimumDepth?: number

The minimum amount of blocks to be mined

Optional minimumDepthStrategy

minimumDepthStrategy?: "txfee" | "plain"

How to calculate minimum depth (default: txfee)

Optional offChainTx

offChainTx?: `tx_${string}`

Offchain transaction (required if reestablishing a channel)

Optional offchainTx

offchainTx?: `tx_${string}`

port

port: number

The port of the responder's node

pushAmount

pushAmount: number | BigNumber

Initial deposit in favour of the responder by the initiator

Optional reconnectTx

reconnectTx?: `tx_${string}`

responderAmount

responderAmount: number | BigNumber

Amount of coins the responder has committed to the channel

responderId

responderId: `ak_${string}`

Responder's public key

sign

sign: SignTxWithTag

Function which verifies and signs transactions

Optional signedTx

signedTx?: `tx_${string}`

Optional timeoutAccept

timeoutAccept?: number

The time frame the other client has to react to an event. This applies for all off-chain updates that are not meant to land on-chain, as well as some special cases: opening a noise connection, mutual closing acknowledgement and reestablishing an existing channel (default: 120000)

Optional timeoutAwaitingOpen

timeoutAwaitingOpen?: number

The time frame the initiator has to start an outgoing noise session to the responder's node. Applicable only for responder (default: timeout_idle's value)

Optional timeoutFundingCreate

timeoutFundingCreate?: number

The time waiting for the initiator to produce the create channel transaction after the noise session had been established (default: 120000)

Optional timeoutFundingLock

timeoutFundingLock?: number

The time frame the other client has to confirm an on-chain transaction reaching maturity (passing minimum depth) after the local node has detected this. This applies only for double signed on-chain intended updates: channel create transaction, deposit, withdrawal and etc. (default: 360000)

Optional timeoutFundingSign

timeoutFundingSign?: number

The time frame the other client has to sign an off-chain update after our client had initiated and signed it. This applies only for double signed on-chain intended updates: channel create transaction, deposit, withdrawal and etc. (default: 120000)

Optional timeoutIdle

timeoutIdle?: number

The time waiting for a new event to be initiated (default: 600000)

Optional timeoutInitialized

timeoutInitialized?: number

the time frame the responder has to accept an incoming noise session. Applicable only for initiator (default: timeout_accept's value)

Optional timeoutSign

timeoutSign?: number

The time frame the client has to return a signed off-chain update or to decline it. This applies for all off-chain updates (default: 500000)

Optional ttl

ttl?: number

Minimum block height to include the channel_create_tx

url

url: string

Channel url (for example: "ws://localhost:3001")

Settings

Member Visibility

Theme

On This Page

channelReservedebugexistingChannelIdexistingFsmIdfeegasPriceinitiatorAmountinitiatorIdlockPeriodminimumDepthminimumDepthStrategyoffChainTxoffchainTxportpushAmountreconnectTxresponderAmountresponderIdsignsignedTxtimeoutAccepttimeoutAwaitingOpentimeoutFundingCreatetimeoutFundingLocktimeoutFundingSigntimeoutIdletimeoutInitializedtimeoutSignttlurl

Generated using TypeDoc