Class FeePayer`Abstract`

Hierarchy (View Summary)

FeePayer
- FeePayerFromAddress
- FeePayerGroup

Index

Constructors

Methods

completeTxFee prepareTransaction getFeeRate

Constructors

constructor

new FeePayer(): FeePayer
Returns FeePayer
- Defined in signer/feePayer/feePayer.ts:14

Methods

`Abstract`completeTxFee

completeTxFee(
    tx: Transaction,
    client: Client,
    options?: FeeRateOptions,
): Promise<void>
Parameters
- tx: Transaction
- client: Client
- Optionaloptions: FeeRateOptions
Returns Promise<void>
- Defined in signer/feePayer/feePayer.ts:16

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.
- Defined in signer/feePayer/feePayer.ts:38

`Static`getFeeRate

getFeeRate(client: Client, options?: FeeRateOptions): Promise<bigint>
Parameters
- client: Client
- Optionaloptions: FeeRateOptions
Returns Promise<bigint>
- Defined in signer/feePayer/feePayer.ts:42