Class FeePayerFromAddressAbstract

constructor

• new FeePayerFromAddress(): FeePayerFromAddress

  Returns FeePayerFromAddress

OptionalchangeFn

OptionalfeeRate

Optionalfilter

Optionaloptions

AbstractgetAddressObjs

• 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.

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.

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.

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.

completeTxFee

• completeTxFee(
      tx: Transaction,
      client: Client,
      options?: FeeRateOptions,
  ): Promise<void>

  Parameters

  • tx: Transaction
  • client: Client
  • Optionaloptions: FeeRateOptions

  Returns Promise<void>

mergeOptions

• mergeOptions(
      manualOptions?: FeePayerFromAddressOptions,
  ): FeePayerFromAddressOptions

  Parameters

  • OptionalmanualOptions: FeePayerFromAddressOptions

  Returns FeePayerFromAddressOptions

setOptionalProperties

• setOptionalProperties(
      props: {
          changeFn?: (
              tx: Transaction,
              capacity: bigint,
          ) => NumLike | Promise<NumLike>;
          feeRate?: NumLike;
          filter?: ClientCollectableSearchKeyFilterLike;
          options?: {
              feeRateBlockRange?: NumLike;
              maxFeeRate?: NumLike;
              shouldAddInputs?: boolean;
          };
      },
  ): void

  Parameters

  • props: {
        changeFn?: (
            tx: Transaction,
            capacity: bigint,
        ) => NumLike | Promise<NumLike>;
        feeRate?: NumLike;
        filter?: ClientCollectableSearchKeyFilterLike;
        options?: {
            feeRateBlockRange?: NumLike;
            maxFeeRate?: NumLike;
            shouldAddInputs?: boolean;
        };
    }

  Returns void

completeFee

• completeFee(
      tx: Transaction,
      client: Client,
      options?: FeePayerFromAddressOptions,
  ): Promise<[number, boolean]>

  Parameters

  • tx: Transaction
  • client: Client
  • Optionaloptions: FeePayerFromAddressOptions

  Returns Promise<[number, boolean]>

completeInputsByCapacity

• completeInputsByCapacity(
      tx: Transaction,
      client: Client,
      capacityTweak?: NumLike,
      options?: FeePayerFromAddressOptions,
  ): Promise<number>

  Parameters

  • tx: Transaction
  • client: Client
  • OptionalcapacityTweak: NumLike
  • Optionaloptions: FeePayerFromAddressOptions

  Returns Promise<number>

completeInputs

• completeInputs<T>(
      tx: Transaction,
      client: Client,
      filter: ClientCollectableSearchKeyFilterLike,
      accumulator: (
          acc: T,
          v: Cell,
          i: number,
          array: Cell[],
      ) => undefined | T | Promise<undefined | T>,
      init: T,
  ): Promise<{ addedCount: number; accumulated?: T }>

  Type Parameters

  • T

  Parameters

  • tx: Transaction
  • client: Client
  • filter: ClientCollectableSearchKeyFilterLike
  • accumulator: (
        acc: T,
        v: Cell,
        i: number,
        array: Cell[],
    ) => undefined | T | Promise<undefined | T>
  • init: T

  Returns Promise<{ addedCount: number; accumulated?: T }>