AbstractCreates an instance of FeePayer.
The client used to interact with the CKB network.
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.
The transaction to prepare.
A promise that resolves to the prepared Transaction object.
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.
Gets the fee rate for the transaction.
Optionaloptions: FeePayerGetFeeRateOptionsLikeOptional configuration for getting the fee rate.
A promise that resolves to the fee rate.
Completes the transaction fee by applying a custom change function.
The transaction to complete the fee for.
A function that modifies the transaction to handle the change.
Optionaloptions: OptionalfeeRate?: NumLikeThe fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
OptionalfeeRateBlockRange?: NumLikeThe block range to use for calculating the fee rate.
OptionalmaxFeeRate?: NumLikeThe maximum allowed fee rate.
Optionalfilter?: ClientCollectableSearchKeyFilterLikeThe filter to use when searching for cells.
OptionalshouldAddInputs?: booleanWhether to add inputs automatically to cover the fee. Defaults to true.
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
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.
The transaction to complete the fee for.
The lock script for the change output cell.
Optionaloptions: Optional configuration for completing the fee.
OptionalfeeRate?: NumLikeThe fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
OptionalfeeRateBlockRange?: NumLikeThe block range to use for calculating the fee rate.
OptionalmaxFeeRate?: NumLikeThe maximum allowed fee rate.
Optionalfilter?: ClientCollectableSearchKeyFilterLikeThe filter to use when searching for cells.
OptionalshouldAddInputs?: booleanWhether to add inputs automatically to cover the fee. Defaults to true.
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
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.
The transaction to complete the fee for.
The index of the existing output to add excess capacity to.
Optionaloptions: Optional configuration for completing the fee.
OptionalfeeRate?: NumLikeThe fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
OptionalfeeRateBlockRange?: NumLikeThe block range to use for calculating the fee rate.
OptionalmaxFeeRate?: NumLikeThe maximum allowed fee rate.
Optionalfilter?: ClientCollectableSearchKeyFilterLikeThe filter to use when searching for cells.
OptionalshouldAddInputs?: booleanWhether to add inputs automatically to cover the fee. Defaults to true.
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
AbstractgetGets an array of Address objects associated with the signer.
A promise that resolves to an array of Address objects.
Gets an array of addresses associated with the signer as strings.
A promise that resolves to an array of addresses as strings.
Gets the recommended Address object for the signer.
Optional_preference: unknownOptional preference parameter.
A promise that resolves to the recommended Address object.
Gets the recommended address for the signer as a string.
Optionalpreference: unknownOptional preference parameter.
A promise that resolves to the recommended address as a string.
Completes transaction inputs by searching for cells associated with the fee payer's addresses.
The transaction to complete inputs for.
A function that accumulates cells until a condition is met.
The initial value for the accumulator.
Optionaloptions: FeePayerCompleteInputsOptionsLikeOptional configuration for completing inputs.
A promise that resolves to the result of completing inputs.
Completes transaction inputs to satisfy a required capacity.
The transaction to complete inputs for.
OptionalcapacityTweak: NumLikeOptional additional capacity needed.
Optionaloptions: FeePayerCompleteInputsOptionsLikeOptional configuration for completing inputs.
A promise that resolves to the result of completing inputs.
Completes transaction inputs by adding all available cells from the fee payer.
The transaction to complete inputs for.
Optionaloptions: FeePayerCompleteInputsOptionsLikeOptional configuration for completing inputs.
A promise that resolves to the result of completing inputs.
Completes transaction inputs by adding exactly one more cell.
The transaction to complete inputs for.
Optionaloptions: FeePayerCompleteInputsOptionsLikeOptional configuration for completing inputs.
A promise that resolves to the result of completing inputs.
Completes transaction inputs by adding at least one cell if no inputs exist.
The transaction to complete inputs for.
Optionaloptions: FeePayerCompleteInputsOptionsLikeOptional configuration for completing inputs.
A promise that resolves to the result of completing inputs.
Collects capacity for the transaction from the fee payer's addresses.
The transaction to collect capacity for.
OptionalcapacityTweak: NumLikeOptional additional capacity needed.
Optionaloptions: FeePayerCompleteInputsOptionsLikeOptional configuration for completing inputs.
OptionalcontextLike: FeePayerCompleteInputsContextOptional context for completing inputs.
A promise that resolves to the result of collecting capacity, including the total capacity collected from added inputs.
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.
Completes the transaction fee by adding a change output to a recommended address.
The transaction to complete the fee for.
Optionaloptions: Optional configuration for completing the fee.
OptionalfeeRate?: NumLikeThe fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
OptionalfeeRateBlockRange?: NumLikeThe block range to use for calculating the fee rate.
OptionalmaxFeeRate?: NumLikeThe maximum allowed fee rate.
Optionalfilter?: ClientCollectableSearchKeyFilterLikeThe filter to use when searching for cells.
OptionalshouldAddInputs?: booleanWhether to add inputs automatically to cover the fee. Defaults to true.
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
A fee payer that uses addresses to find cells and complete transactions.