AbstractGets the client associated with this fee payer.
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.
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.
Sign and broadcast a PSBT.
The hex string of PSBT to sign and broadcast.
Optionaloptions: SignPsbtOptionsLikeOptions for signing the PSBT.
A promise that resolves to the transaction ID as a Hex string.
AbstractgetGets the Bitcoin account associated with the signer.
A promise that resolves to a string representing the Bitcoin account.
AbstractgetGets the Bitcoin public key associated with the signer.
A promise that resolves to a HexLike value representing the Bitcoin public key.
Gets the internal address, which is the Bitcoin account in this case.
A promise that resolves to a string representing the internal address.
Gets the identity, which is the Bitcoin public key in this case.
A promise that resolves to a string representing the identity
Gets an array of Address objects representing the known script addresses for the signer.
A promise that resolves to an array of Address objects.
prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.
The transaction to prepare, represented as a TransactionLike object.
A promise that resolves to the prepared Transaction object.
Signs a transaction without modifying it.
The transaction to sign, represented as a TransactionLike object.
A promise that resolves to a signed Transaction object.
AbstractsignSigns a Partially Signed Bitcoin Transaction (PSBT).
The hex string of PSBT to sign.
Optionaloptions: SignPsbtOptionsLikeOptions for signing the PSBT
A promise that resolves to the signed PSBT as a Hex string.
AbstractbroadcastBroadcasts a PSBT to the Bitcoin network.
The hex string of the PSBT to broadcast.
Optionaloptions: SignPsbtOptionsLikeOptions for broadcasting the PSBT.
A promise that resolves to the transaction ID as a Hex string.
StaticverifyAbstractconnectConnects to the signer.
A promise that resolves when the connection is complete.
Register a listener to be called when this signer is replaced.
A function for unregister
Disconnects to the signer.
A promise that resolves when the signer is disconnected.
AbstractisCheck if the signer is connected.
A promise that resolves the connection status.
Find cells of this signer
The filter for the search key.
OptionalwithData: null | booleanWhether to include cell data in the response.
Optionalorder: "asc" | "desc"The order of the returned cells, can be "asc" or "desc".
Optionallimit: numberThe maximum number of cells for every querying chunk.
A async generator that yields all matching cells
Find cells of this signer
OptionalwithData: null | booleanOptionalorder: "asc" | "desc"Optionallimit: numberA async generator that yields all matches cells
Find transactions of this signer
OptionalgroupByTransaction: null | falseOptionalorder: "asc" | "desc"Optionallimit: numberA async generator that yields all matches transactions
Find transactions of this signer
Optionalorder: "asc" | "desc"Optionallimit: numberA async generator that yields all matches transactions
Find transactions of this signer
OptionalgroupByTransaction: null | booleanOptionalorder: "asc" | "desc"Optionallimit: numberA async generator that yields all matches transactions
Gets balance of all addresses
A promise that resolves to the balance
Signs a message and returns signature only. This method is not implemented and should be overridden by subclasses.
The message to sign, as a string or BytesLike object.
A promise that resolves to the signature as a string.
Sends a transaction after signing it.
The transaction to send, represented as a TransactionLike object.
A promise that resolves to the transaction hash as a Hex string.
Signs a transaction.
The transaction to sign, represented as a TransactionLike object.
A promise that resolves to the signed Transaction object.
An abstract class extending the Signer class for Bitcoin-like signing operations. This class provides methods to get Bitcoin account, public key, and internal address, as well as signing transactions.