Class FeePayerFromAddress`Abstract`

A fee payer that uses addresses to find cells and complete transactions.

Hierarchy (View Summary)

FeePayer<FeePayerCompleteInputsOptionsLike, FeePayerCompleteInputsContext>
- FeePayerFromAddress

Constructors

constructor

new FeePayerFromAddress(client_: Client): FeePayerFromAddress
Creates an instance of FeePayer.
Parameters
- client_: Client
  The client used to interact with the CKB network.
Returns FeePayerFromAddress
Inherited from FeePayer.constructor
- Defined in feePayer/feePayer.ts:39

Properties

`Protected`client_

client_: Client

The client used to interact with the CKB network.

Accessors

client

get client(): Client
Gets the client associated with this fee payer.

Returns Client
Inherited from FeePayer.client
- Defined in feePayer/feePayer.ts:44

Methods

prepareTransaction

prepareTransaction(tx: TransactionLike): Promise<Transaction>
Prepares a transaction before signing. This method can be overridden by subclasses to perform any necessary steps, such as adding cell dependencies or witnesses, before the transaction is signed. The default implementation converts the TransactionLike object to a Transaction object without modification.
Parameters
- tx: TransactionLike
  The transaction to prepare.
Returns Promise<Transaction>
A promise that resolves to the prepared Transaction object.

Remarks
Note that this default implementation does not add any cell dependencies or dummy witnesses. This may lead to an underestimation of transaction size and fees if used with methods like Transaction.completeFee. Subclasses for signers that are intended to sign transactions should override this method to perform necessary preparations.
Inherited from FeePayer.prepareTransaction
- Defined in feePayer/feePayer.ts:97

getFeeRate

getFeeRate(options?: FeePayerGetFeeRateOptionsLike): Promise<bigint>
Gets the fee rate for the transaction.
Parameters
- Optionaloptions: FeePayerGetFeeRateOptionsLike
  Optional configuration for getting the fee rate.
Returns Promise<bigint>
A promise that resolves to the fee rate.
Inherited from FeePayer.getFeeRate
- Defined in feePayer/feePayer.ts:107

completeFeeChangeTo

completeFeeChangeTo(
    txLike: TransactionLike,
    change: FeePayerCompleteFeeChangeFn,
    options?:
        | {
            feeRate?: NumLike;
            feeRateBlockRange?: NumLike;
            maxFeeRate?: NumLike;
        } & {
            filter?: ClientCollectableSearchKeyFilterLike;
            shouldAddInputs?: boolean;
        }
        | null,
): Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
Completes the transaction fee by applying a custom change function.
Parameters
- txLike: TransactionLike
  The transaction to complete the fee for.
- change: FeePayerCompleteFeeChangeFn
  A function that modifies the transaction to handle the change.
- Optionaloptions:
      | {
          feeRate?: NumLike;
          feeRateBlockRange?: NumLike;
          maxFeeRate?: NumLike;
      } & {
          filter?: ClientCollectableSearchKeyFilterLike;
          shouldAddInputs?: boolean;
      }
      | null
  - { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
    filter?: ClientCollectableSearchKeyFilterLike;
    shouldAddInputs?: boolean;
    }
    
    OptionalfeeRate?: NumLike
    
    The fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
    
    OptionalfeeRateBlockRange?: NumLike
    
    The block range to use for calculating the fee rate.
    
    OptionalmaxFeeRate?: NumLike
    
    The maximum allowed fee rate.
    
    Optionalfilter?: ClientCollectableSearchKeyFilterLike
    
    The filter to use when searching for cells.
    
    OptionalshouldAddInputs?: boolean
    
    Whether to add inputs automatically to cover the fee. Defaults to true.
  - null
Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
Inherited from FeePayer.completeFeeChangeTo
- Defined in feePayer/feePayer.ts:121

completeFeeChangeToLock

completeFeeChangeToLock(
    txLike: TransactionLike,
    change: {} & {
        codeHash: BytesLike;
        hashType: HashTypeLike;
        args: BytesLike;
    },
    options?:
        | {
            feeRate?: NumLike;
            feeRateBlockRange?: NumLike;
            maxFeeRate?: NumLike;
        } & {
            filter?: ClientCollectableSearchKeyFilterLike;
            shouldAddInputs?: boolean;
        }
        | null,
): Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
Completes the transaction fee by adding inputs and creating a change output with the specified lock script. This is a convenience method that automatically creates a change cell with the provided lock script when there's excess capacity after paying the transaction fee.
Parameters
- txLike: TransactionLike
  The transaction to complete the fee for.
- change: {} & { codeHash: BytesLike; hashType: HashTypeLike; args: BytesLike }
  The lock script for the change output cell.
- Optionaloptions:
      | {
          feeRate?: NumLike;
          feeRateBlockRange?: NumLike;
          maxFeeRate?: NumLike;
      } & {
          filter?: ClientCollectableSearchKeyFilterLike;
          shouldAddInputs?: boolean;
      }
      | null
  Optional configuration for completing the fee.
  - { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
    filter?: ClientCollectableSearchKeyFilterLike;
    shouldAddInputs?: boolean;
    }
    
    OptionalfeeRate?: NumLike
    
    The fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
    
    OptionalfeeRateBlockRange?: NumLike
    
    The block range to use for calculating the fee rate.
    
    OptionalmaxFeeRate?: NumLike
    
    The maximum allowed fee rate.
    
    Optionalfilter?: ClientCollectableSearchKeyFilterLike
    
    The filter to use when searching for cells.
    
    OptionalshouldAddInputs?: boolean
    
    Whether to add inputs automatically to cover the fee. Defaults to true.
  - null
Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
Example
```
const changeScript = Script.from({
  codeHash: "0x...",
  hashType: "type",
  args: "0x..."
});

const { hasChanged } = await feePayer.completeFeeChangeToLock(
  tx,
  changeScript,
);
```
Inherited from FeePayer.completeFeeChangeToLock
- Defined in feePayer/feePayer.ts:254

completeFeeChangeToOutput

completeFeeChangeToOutput(
    txLike: TransactionLike,
    index: NumLike,
    options?:
        | {
            feeRate?: NumLike;
            feeRateBlockRange?: NumLike;
            maxFeeRate?: NumLike;
        } & {
            filter?: ClientCollectableSearchKeyFilterLike;
            shouldAddInputs?: boolean;
        }
        | null,
): Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
Completes the transaction fee by adding excess capacity to an existing output. Instead of creating a new change output, this method adds any excess capacity to the specified existing output in the transaction.
Parameters
- txLike: TransactionLike
  The transaction to complete the fee for.
- index: NumLike
  The index of the existing output to add excess capacity to.
- Optionaloptions:
      | {
          feeRate?: NumLike;
          feeRateBlockRange?: NumLike;
          maxFeeRate?: NumLike;
      } & {
          filter?: ClientCollectableSearchKeyFilterLike;
          shouldAddInputs?: boolean;
      }
      | null
  Optional configuration for completing the fee.
  - { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
    filter?: ClientCollectableSearchKeyFilterLike;
    shouldAddInputs?: boolean;
    }
    
    OptionalfeeRate?: NumLike
    
    The fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
    
    OptionalfeeRateBlockRange?: NumLike
    
    The block range to use for calculating the fee rate.
    
    OptionalmaxFeeRate?: NumLike
    
    The maximum allowed fee rate.
    
    Optionalfilter?: ClientCollectableSearchKeyFilterLike
    
    The filter to use when searching for cells.
    
    OptionalshouldAddInputs?: boolean
    
    Whether to add inputs automatically to cover the fee. Defaults to true.
  - null
Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
Throws
When the specified output index doesn't exist.
Example
```
// Add excess capacity to the first output (index 0)
const { hasChanged } = await feePayer.completeFeeChangeToOutput(
  tx,
  0, // Output index
);
```
Inherited from FeePayer.completeFeeChangeToOutput
- Defined in feePayer/feePayer.ts:302

`Abstract`getAddressObjs

getAddressObjs(): Promise<Address[]>
Gets an array of Address objects associated with the signer.

Returns Promise<Address[]>
A promise that resolves to an array of Address objects.
- Defined in feePayer/feePayerFromAddress.ts:30

getAddresses

getAddresses(): Promise<string[]>
Gets an array of addresses associated with the signer as strings.

Returns Promise<string[]>
A promise that resolves to an array of addresses as strings.
- Defined in feePayer/feePayerFromAddress.ts:37

getRecommendedAddressObj

getRecommendedAddressObj(_preference?: unknown): Promise<Address>
Gets the recommended Address object for the signer.
Parameters
- Optional_preference: unknown
  Optional preference parameter.
Returns Promise<Address>
A promise that resolves to the recommended Address object.
- Defined in feePayer/feePayerFromAddress.ts:49

getRecommendedAddress

getRecommendedAddress(preference?: unknown): Promise<string>
Gets the recommended address for the signer as a string.
Parameters
- Optionalpreference: unknown
  Optional preference parameter.
Returns Promise<string>
A promise that resolves to the recommended address as a string.
- Defined in feePayer/feePayerFromAddress.ts:59

completeInputs

completeInputs<T>(
    txLike: TransactionLike,
    accumulator: (
        acc: T,
        v: Cell,
        i: number,
        array: Cell[],
    ) => T | Promise<T | undefined> | undefined,
    init: T,
    options?: FeePayerCompleteInputsOptionsLike,
): Promise<
    { tx: Transaction } & FeePayerCompleteInputsContext & {
        accumulated?: T;
    },
>
Completes transaction inputs by searching for cells associated with the fee payer's addresses.
Type Parameters
- T
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- accumulator: (
      acc: T,
      v: Cell,
      i: number,
      array: Cell[],
  ) => T | Promise<T | undefined> | undefined
  A function that accumulates cells until a condition is met.
- init: T
  The initial value for the accumulator.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<
    { tx: Transaction } & FeePayerCompleteInputsContext & {
        accumulated?: T;
    },
>
A promise that resolves to the result of completing inputs.
- Defined in feePayer/feePayerFromAddress.ts:72

completeInputsByCapacity

completeInputsByCapacity(
    txLike: TransactionLike,
    capacityTweak?: NumLike,
    options?: FeePayerCompleteInputsOptionsLike,
): Promise<FeePayerCompleteInputsResult>
Completes transaction inputs to satisfy a required capacity.
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- OptionalcapacityTweak: NumLike
  Optional additional capacity needed.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<FeePayerCompleteInputsResult>
A promise that resolves to the result of completing inputs.
- Defined in feePayer/feePayerFromAddress.ts:157

completeInputsAll

completeInputsAll(
txLike: TransactionLike,
options?: FeePayerCompleteInputsOptionsLike,
): Promise<FeePayerCompleteInputsResult>
Completes transaction inputs by adding all available cells from the fee payer.
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<FeePayerCompleteInputsResult>
A promise that resolves to the result of completing inputs.
- Defined in feePayer/feePayerFromAddress.ts:189

completeInputsAddOne

completeInputsAddOne(
txLike: TransactionLike,
options?: FeePayerCompleteInputsOptionsLike,
): Promise<FeePayerCompleteInputsResult>
Completes transaction inputs by adding exactly one more cell.
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<FeePayerCompleteInputsResult>
A promise that resolves to the result of completing inputs.
- Defined in feePayer/feePayerFromAddress.ts:208

completeInputsAtLeastOne

completeInputsAtLeastOne(
txLike: TransactionLike,
options?: FeePayerCompleteInputsOptionsLike,
): Promise<FeePayerCompleteInputsResult>
Completes transaction inputs by adding at least one cell if no inputs exist.
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<FeePayerCompleteInputsResult>
A promise that resolves to the result of completing inputs.
- Defined in feePayer/feePayerFromAddress.ts:233

collectCapacity

collectCapacity(
    txLike: TransactionLike,
    capacityTweak?: NumLike,
    options?: FeePayerCompleteInputsOptionsLike,
    contextLike?: FeePayerCompleteInputsContext,
): Promise<
    FeePayerCollectCapacityResult<FeePayerCompleteInputsContext> & {
        expectedCapacity: bigint;
        accumulated?: bigint;
    },
>
Collects capacity for the transaction from the fee payer's addresses.
Parameters
- txLike: TransactionLike
  The transaction to collect capacity for.
- OptionalcapacityTweak: NumLike
  Optional additional capacity needed.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
- OptionalcontextLike: FeePayerCompleteInputsContext
  Optional context for completing inputs.
Returns Promise<
    FeePayerCollectCapacityResult<FeePayerCompleteInputsContext> & {
        expectedCapacity: bigint;
        accumulated?: bigint;
    },
>
A promise that resolves to the result of collecting capacity, including the total capacity collected from added inputs.

Remarks
This method attempts to collect sufficient capacity to meet the requirement (outputs capacity plus capacityTweak). If the requirement cannot be fully met, it adds as many inputs as possible to minimize the deficit and does NOT throw an error. This behavior enables multiple fee payers to collaborate in providing the necessary capacity.
Overrides FeePayer.collectCapacity
- Defined in feePayer/feePayerFromAddress.ts:263

completeFee

completeFee(
    txLike: TransactionLike,
    options?:
        | {
            feeRate?: NumLike;
            feeRateBlockRange?: NumLike;
            maxFeeRate?: NumLike;
        } & {
            filter?: ClientCollectableSearchKeyFilterLike;
            shouldAddInputs?: boolean;
        }
        | null,
): Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
Completes the transaction fee by adding a change output to a recommended address.
Parameters
- txLike: TransactionLike
  The transaction to complete the fee for.
- Optionaloptions:
      | {
          feeRate?: NumLike;
          feeRateBlockRange?: NumLike;
          maxFeeRate?: NumLike;
      } & {
          filter?: ClientCollectableSearchKeyFilterLike;
          shouldAddInputs?: boolean;
      }
      | null
  Optional configuration for completing the fee.
  - { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
    filter?: ClientCollectableSearchKeyFilterLike;
    shouldAddInputs?: boolean;
    }
    
    OptionalfeeRate?: NumLike
    
    The fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
    
    OptionalfeeRateBlockRange?: NumLike
    
    The block range to use for calculating the fee rate.
    
    OptionalmaxFeeRate?: NumLike
    
    The maximum allowed fee rate.
    
    Optionalfilter?: ClientCollectableSearchKeyFilterLike
    
    The filter to use when searching for cells.
    
    OptionalshouldAddInputs?: boolean
    
    Whether to add inputs automatically to cover the fee. Defaults to true.
  - null
Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
Overrides FeePayer.completeFee
- Defined in feePayer/feePayerFromAddress.ts:325

Class FeePayerFromAddressAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FeePayerFromAddress

Properties

Protectedclient_

Accessors

client

Returns Client

Methods

prepareTransaction

Parameters

Returns Promise<Transaction>

Remarks

getFeeRate

Parameters

Returns Promise<bigint>

completeFeeChangeTo

Parameters

OptionalfeeRate?: NumLike

OptionalfeeRateBlockRange?: NumLike

OptionalmaxFeeRate?: NumLike

Optionalfilter?: ClientCollectableSearchKeyFilterLike

OptionalshouldAddInputs?: boolean

Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>

completeFeeChangeToLock

Parameters

OptionalfeeRate?: NumLike

OptionalfeeRateBlockRange?: NumLike

OptionalmaxFeeRate?: NumLike

Optionalfilter?: ClientCollectableSearchKeyFilterLike

OptionalshouldAddInputs?: boolean

Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>

Example

completeFeeChangeToOutput

Parameters

OptionalfeeRate?: NumLike

OptionalfeeRateBlockRange?: NumLike

OptionalmaxFeeRate?: NumLike

Optionalfilter?: ClientCollectableSearchKeyFilterLike

OptionalshouldAddInputs?: boolean

Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>

Throws

Example

AbstractgetAddressObjs

Returns Promise<Address[]>

getAddresses

Returns Promise<string[]>

getRecommendedAddressObj

Parameters

Returns Promise<Address>

getRecommendedAddress

Parameters

Returns Promise<string>

completeInputs

Type Parameters

Parameters

Returns Promise< { tx: Transaction } & FeePayerCompleteInputsContext & { accumulated?: T; },>

completeInputsByCapacity

Parameters

Returns Promise<FeePayerCompleteInputsResult>

completeInputsAll

Parameters

Returns Promise<FeePayerCompleteInputsResult>

completeInputsAddOne

Parameters

Returns Promise<FeePayerCompleteInputsResult>

completeInputsAtLeastOne

Parameters

Returns Promise<FeePayerCompleteInputsResult>

collectCapacity

Parameters

Returns Promise< FeePayerCollectCapacityResult<FeePayerCompleteInputsContext> & { expectedCapacity: bigint; accumulated?: bigint; },>

Class FeePayerFromAddress`Abstract`

`Protected`client_

`Optional`feeRate?: NumLike

`Optional`feeRateBlockRange?: NumLike

`Optional`maxFeeRate?: NumLike

`Optional`filter?: ClientCollectableSearchKeyFilterLike

`Optional`shouldAddInputs?: boolean

`Optional`feeRate?: NumLike

`Optional`feeRateBlockRange?: NumLike

`Optional`maxFeeRate?: NumLike

`Optional`filter?: ClientCollectableSearchKeyFilterLike

`Optional`shouldAddInputs?: boolean

`Optional`feeRate?: NumLike

`Optional`feeRateBlockRange?: NumLike

`Optional`maxFeeRate?: NumLike

`Optional`filter?: ClientCollectableSearchKeyFilterLike

`Optional`shouldAddInputs?: boolean

`Abstract`getAddressObjs

Returns Promise<
{ tx: Transaction } & FeePayerCompleteInputsContext & {
accumulated?: T;
},
>

Returns Promise<
FeePayerCollectCapacityResult<FeePayerCompleteInputsContext> & {
expectedCapacity: bigint;
accumulated?: bigint;
},
>

`Optional`feeRate?: NumLike

`Optional`feeRateBlockRange?: NumLike

`Optional`maxFeeRate?: NumLike

`Optional`filter?: ClientCollectableSearchKeyFilterLike

`Optional`shouldAddInputs?: boolean