Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Transaction

Index

Constructors

Accessors

Methods

  • The method will add a certificate to the transaction to be included in cbor This method will automatically scan and include each unique required witnesses in the map to help sign the transaction

    Parameters

    • certificate: Certificate

      a certificate to include in the transaction

    Returns void

  • addInput(input: Input): void
  • Parameters

    Returns void

  • addMint(mint: Mint): void
  • Parameters

    Returns void

  • addOutput(output: Output): void
  • Parameters

    Returns void

  • buildTransaction(): { hash: string; payload: string }
  • Returns { hash: string; payload: string }

    • hash: string
    • payload: string
  • calculateFee(extraOutputs?: Output[]): BigNumber
  • Parameters

    • Optional extraOutputs: Output[]

    Returns BigNumber

  • calculateMinUtxoAmountBabbage(output: Output): BigNumber
  • Parameters

    Returns BigNumber

  • calculateTxSize(extraOutputs?: Output[]): number
  • Parameters

    • Optional extraOutputs: Output[]

    Returns number

  • getAdditionalInputAda(): BigNumber
  • This method scans the certificates added in the transaction to calculate additional ADA available in inputs as part of the deposit refund. Essentially ADA to be considered as additional input due to deposit refunds.

    Returns BigNumber

    additional ADA available as input

  • getAdditionalOutputAda(): BigNumber
  • This method scans the certificates and proposal procedures added in the transaction to calculate additional ADA required for transaction validity.

    1. stake key registration deposit ADA
    2. proposal procedure deposit ADA
    3. donation amount

    Returns BigNumber

    additional ADA required for a valid transaction

  • getAuxiliaryDataHashHex(): undefined | string
  • Returns undefined | string

  • getCollateralAmount(): BigNumber
  • Returns BigNumber

  • getCollateralOutput(): undefined | Output
  • getDonationAmount(): undefined | BigNumber
  • Returns undefined | BigNumber

  • getFee(): BigNumber
  • Returns BigNumber

  • getInputAmount(): { ada: BigNumber; tokens: Token[] }
  • Returns { ada: BigNumber; tokens: Token[] }

    • ada: BigNumber
    • tokens: Token[]
  • getOutputAmount(): { ada: BigNumber; tokens: Token[] }
  • Returns { ada: BigNumber; tokens: Token[] }

    • ada: BigNumber
    • tokens: Token[]
  • getRequiredNativeScriptWitnesses(): Map<string, undefined>
  • Returns Map<string, undefined>

  • getRequiredSigners(): Map<string, undefined | BipPath>
  • Returns Map<string, undefined | BipPath>

  • getRequiredWitnesses(): Map<string, undefined | BipPath>
  • Returns Map<string, undefined | BipPath>

  • getScriptIntegrityHash(): undefined | Buffer
  • Returns undefined | Buffer

  • getTTL(): undefined | number
  • Returns undefined | number

  • getTotalCollateral(): undefined | BigNumber
  • Returns undefined | BigNumber

  • getTransactionHash(): Buffer
  • Returns Buffer

  • getTreasuryAmount(): undefined | BigNumber
  • Returns undefined | BigNumber

  • getValidityIntervalStart(): undefined | number
  • Returns undefined | number

  • isPlutusTransaction(): boolean
  • Returns boolean

  • Function to prepare transaction automatically There are other helper methods for preparing transactions that use this method This method should be used when you know what you are doing sets required inputs, fees, change etc resulting transaction is the final tx that can be built for signing

    Parameters

    Returns Transaction

  • setCollateralOutput(output: Output): void
  • Parameters

    Returns void

  • setDonationAmount(amount: BigNumber): void
  • Parameters

    • amount: BigNumber

    Returns void

  • setFee(fee: BigNumber): void
  • Parameters

    • fee: BigNumber

    Returns void

  • setTTL(ttl: number): void
  • Parameters

    • ttl: number

    Returns void

  • setTotalCollateral(amount: BigNumber): void
  • Parameters

    • amount: BigNumber

    Returns void

  • setTreasuryAmount(amount: BigNumber): void
  • Parameters

    • amount: BigNumber

    Returns void

  • setValidityIntervalStart(validityIntervalStart: number): void
  • Parameters

    • validityIntervalStart: number

    Returns void