Class Transaction

Index

Constructors

constructor

new Transaction(__namedParameters): Transaction
Parameters
- __namedParameters: {
  protocolParams: ProtocolParams;
  }
  - protocolParams: ProtocolParams
Returns Transaction

Accessors

protocolParams

get protocolParams(): ProtocolParams
Returns ProtocolParams

Methods

addCertificate

addCertificate(certificate): void
Parameters
- certificate: Certificate
Returns void

addCollateral

addCollateral(input): void
Parameters
- input: CollateralInput
Returns void

addInput

addInput(input): void
Parameters
- input: Input
Returns void

addMint

addMint(mint): void
Parameters
- mint: Mint
Returns void

addOutput

addOutput(output): void
Parameters
- output: Output
Returns void

addReferenceInput

addReferenceInput(input): void
Parameters
- input: ReferenceInput
Returns void

addRequiredSigner

addRequiredSigner(credential): void
Parameters
- credential: HashCredential
Returns void

addWithdrawal

addWithdrawal(withdrawal): void
Parameters
- withdrawal: Withdrawal
Returns void

addWitness

addWitness(witness): void
Parameters
- witness: VKeyWitness
Returns void

buildTransaction

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

calculateFee

calculateFee(extraOutputs?): BigNumber
Parameters
- Optional extraOutputs: Output[]
Returns BigNumber

calculateMinUtxoAmountBabbage

calculateMinUtxoAmountBabbage(output): BigNumber
Parameters
- output: Output
Returns BigNumber

calculateTxSize

calculateTxSize(extraOutputs?): number
Parameters
- Optional extraOutputs: Output[]
Returns number

getAdditionalInputAda

getAdditionalInputAda(): BigNumber
Returns BigNumber

getAdditionalOutputAda

getAdditionalOutputAda(): BigNumber
Returns BigNumber

getAuxiliaryData

getAuxiliaryData(): undefined | AuxiliaryData
Returns undefined | AuxiliaryData

getAuxiliaryDataHashHex

getAuxiliaryDataHashHex(): undefined | string
Returns undefined | string

getBurnTokens

getBurnTokens(): Token[]
Returns Token[]

getCertificates

getCertificates(): Certificate[]
Returns Certificate[]

getCollateralAmount

getCollateralAmount(): BigNumber
Returns BigNumber

getCollateralOutput

getCollateralOutput(): undefined | Output
Returns undefined | Output

getCollaterals

getCollaterals(): CollateralInput[]
Returns CollateralInput[]

getFee

getFee(): BigNumber
Returns BigNumber

getInputAmount

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

getInputs

getInputs(): Input[]
Returns Input[]

getMintTokens

getMintTokens(): Token[]
Returns Token[]

getMints

getMints(): Mint[]
Returns Mint[]

getOutputAmount

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

getOutputs

getOutputs(): Output[]
Returns Output[]

getRequiredNativeScriptWitnesses

getRequiredNativeScriptWitnesses(): Map<string, undefined>
Returns Map<string, undefined>

getRequiredSigners

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

getRequiredWitnesses

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

getScriptIntegrityHash

getScriptIntegrityHash(): undefined | Buffer
Returns undefined | Buffer

getTTL

getTTL(): undefined | number
Returns undefined | number

getTotalCollateral

getTotalCollateral(): undefined | BigNumber
Returns undefined | BigNumber

getTransactionHash

getTransactionHash(): Buffer
Returns Buffer

getValidityIntervalStart

getValidityIntervalStart(): undefined | number
Returns undefined | number

getWithdrawals

getWithdrawals(): Withdrawal[]
Returns Withdrawal[]

isPlutusTransaction

isPlutusTransaction(): boolean
Returns boolean

paymentTransaction

paymentTransaction(__namedParameters): Transaction
Function for a simple send ADA transaction Provide necessary outputs, and available inputs, returns a final tx
Parameters
- __namedParameters: {
      auxiliaryData?: AuxiliaryData;
      changeAddress: CardanoAddress;
      inputs: Input[];
      outputs: Output[];
      ttl: number;
  }
  - Optional auxiliaryData?: AuxiliaryData
  - changeAddress: CardanoAddress
  - inputs: Input[]
  - outputs: Output[]
  - ttl: number
Returns Transaction

prepareTransaction

prepareTransaction(__namedParameters): Transaction
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
- __namedParameters: {
      changeAddress: CardanoAddress;
      collateralInputs?: CollateralInput[];
      inputs: Input[];
  }
  - changeAddress: CardanoAddress
  - Optional collateralInputs?: CollateralInput[]
  - inputs: Input[]
Returns Transaction

setAuxiliaryData

setAuxiliaryData(auxData): void
Parameters
- auxData: AuxiliaryData
Returns void

setCollateralOutput

setCollateralOutput(output): void
Parameters
- output: Output
Returns void

setFee

setFee(fee): void
Parameters
- fee: BigNumber
Returns void

setTTL

setTTL(ttl): void
Parameters
- ttl: number
Returns void

setTotalCollateral

setTotalCollateral(amount): void
Parameters
- amount: BigNumber
Returns void

setValidityIntervalStart

setValidityIntervalStart(validityIntervalStart): void
Parameters
- validityIntervalStart: number
Returns void