Variable common

Type declaration

• __tests__: {
      _commonTransfer: ((txSkeleton, fromInfos, amount, minimalChangeCapacity, __namedParameters?) => Promise<{
          capacity: bigint;
          changeCapacity: bigint;
          txSkeleton: TransactionSkeletonType;
      }>);
      calculateFee: ((size, feeRate) => bigint);
      calculateFeeCompatible: ((size, feeRate) => BI);
      generateLockScriptInfos: ((__namedParameters?) => void);
      getLockScriptInfos: (() => LockScriptInfosType);
      getTransactionSize: ((txSkeleton) => number);
      getTransactionSizeByTx: ((tx) => number);
      resetLockScriptInfos: (() => void);
  }

  • _commonTransfer: ((txSkeleton, fromInfos, amount, minimalChangeCapacity, __namedParameters?) => Promise<{
        capacity: bigint;
        changeCapacity: bigint;
        txSkeleton: TransactionSkeletonType;
    }>)

    • • (txSkeleton, fromInfos, amount, minimalChangeCapacity, __namedParameters?): Promise<{
            capacity: bigint;
            changeCapacity: bigint;
            txSkeleton: TransactionSkeletonType;
        }>

      • Parameters

        • txSkeleton: TransactionSkeletonType

        • fromInfos: FromInfo[]

        • amount: bigint

        • minimalChangeCapacity: bigint

        • __namedParameters: Options & {
              enableDeductCapacity?: boolean;
          } = {}

        Returns Promise<{
            capacity: bigint;
            changeCapacity: bigint;
            txSkeleton: TransactionSkeletonType;
        }>

  • calculateFee: ((size, feeRate) => bigint)

    • • (size, feeRate): bigint

      • Parameters

        • size: number

        • feeRate: bigint

        Returns bigint

  • calculateFeeCompatible: ((size, feeRate) => BI)

    • • (size, feeRate): BI

      • Parameters

        • size: number

        • feeRate: BIish

        Returns BI

  • generateLockScriptInfos: ((__namedParameters?) => void)

    • • (__namedParameters?): void

      • Parameters

        • __namedParameters: Options = {}

        Returns void

  • getLockScriptInfos: (() => LockScriptInfosType)

    • • (): LockScriptInfosType

      • Returns LockScriptInfosType

  • getTransactionSize: ((txSkeleton) => number)

    • • (txSkeleton): number

      • Parameters

        • txSkeleton: TransactionSkeletonType

        Returns number

  • getTransactionSizeByTx: ((tx) => number)

    • • (tx): number

      • Parameters

        • tx: Transaction

        Returns number

  • resetLockScriptInfos: (() => void)

    • • (): void

      • Returns void

• injectCapacity: ((txSkeleton, fromInfos, amount, changeAddress?, tipHeader?, __namedParameters?) => Promise<TransactionSkeletonType>)

  • • (txSkeleton, fromInfos, amount, changeAddress?, tipHeader?, __namedParameters?): Promise<TransactionSkeletonType>

    • Parameters

      • txSkeleton: TransactionSkeletonType

      • fromInfos: FromInfo[]

      • amount: BIish

      • Optional changeAddress: string

      • Optional tipHeader: Header

      • __namedParameters: {
            LocktimePoolCellCollector?: CellCollectorConstructor;
            config?: Config;
            enableDeductCapacity?: boolean;
            useLocktimeCellsFirst?: boolean;
        } = {}

        • Optional LocktimePoolCellCollector?: CellCollectorConstructor

        • Optional config?: Config

        • Optional enableDeductCapacity?: boolean

        • Optional useLocktimeCellsFirst?: boolean

      Returns Promise<TransactionSkeletonType>

• payFee: ((txSkeleton, fromInfos, amount, tipHeader?, __namedParameters?) => Promise<TransactionSkeletonType>)

  • • (txSkeleton, fromInfos, amount, tipHeader?, __namedParameters?): Promise<TransactionSkeletonType>

    • Parameters

      • txSkeleton: TransactionSkeletonType

      • fromInfos: FromInfo[]

      • amount: BIish

      • Optional tipHeader: Header

      • __namedParameters: {
            config?: Config;
            enableDeductCapacity?: boolean;
            useLocktimeCellsFirst?: boolean;
        } = {}

        • Optional config?: Config

        • Optional enableDeductCapacity?: boolean

        • Optional useLocktimeCellsFirst?: boolean

      Returns Promise<TransactionSkeletonType>

• payFeeByFeeRate: ((txSkeleton, fromInfos, feeRate, tipHeader?, __namedParameters?) => Promise<TransactionSkeletonType>)

  • • (txSkeleton, fromInfos, feeRate, tipHeader?, __namedParameters?): Promise<TransactionSkeletonType>

    • Parameters

      • txSkeleton: TransactionSkeletonType

      • fromInfos: FromInfo[]

      • feeRate: BIish

      • Optional tipHeader: Header

      • __namedParameters: {
            config?: Config;
            enableDeductCapacity?: boolean;
            useLocktimeCellsFirst?: boolean;
        } = {}

        • Optional config?: Config

        • Optional enableDeductCapacity?: boolean

        • Optional useLocktimeCellsFirst?: boolean

      Returns Promise<TransactionSkeletonType>

• prepareSigningEntries: ((txSkeleton, __namedParameters?) => TransactionSkeletonType)

  • • (txSkeleton, __namedParameters?): TransactionSkeletonType

    • Parameters

      • txSkeleton: TransactionSkeletonType

      • __namedParameters: Options = {}

      Returns TransactionSkeletonType

• registerCustomLockScriptInfos: ((infos) => void)

  • • (infos): void

    • Registers LockScriptInfo for custom scripts.

      Parameters

      • infos: LockScriptInfo[]

      Returns void

• setupInputCell: ((txSkeleton, inputCell, fromInfo?, options?) => Promise<TransactionSkeletonType>)

  • • (txSkeleton, inputCell, fromInfo?, options?): Promise<TransactionSkeletonType>

    • A function to transfer input to output, and add input & output to txSkeleton. And it will deal with cell deps and witnesses too. (Add the input required cell deps and witnesses.) It should be noted that the output must be added to the end of txSkeleton.get("outputs").

      Parameters

      • txSkeleton: TransactionSkeletonType

      • inputCell: Cell

      • Optional fromInfo: FromInfo

      • options: Options & {
            defaultWitness?: string;
            since?: string;
        } = {}

      Returns Promise<TransactionSkeletonType>

• transfer: ((txSkeleton, fromInfos, toAddress, amount, changeAddress?, tipHeader?, options?) => Promise<TransactionSkeletonType>)

  • • (txSkeleton, fromInfos, toAddress, amount, changeAddress?, tipHeader?, options?): Promise<TransactionSkeletonType>

    • Parameters

      • txSkeleton: TransactionSkeletonType

      • fromInfos: FromInfo[]

      • toAddress: string

      • amount: BIish

      • Optional changeAddress: string

      • Optional tipHeader: Header

        will not use locktime cells if tipHeader not provided

      • options: {
            LocktimePoolCellCollector?: CellCollectorConstructor;
            config?: Config;
            useLocktimeCellsFirst?: boolean;
        } = {}

        • Optional LocktimePoolCellCollector?: CellCollectorConstructor

        • Optional config?: Config

        • Optional useLocktimeCellsFirst?: boolean

      Returns Promise<TransactionSkeletonType>