Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace types

Index

Enumerations

Type aliases

Type aliases

Anchor

Anchor: { hash: Buffer; url: string }

Type declaration

  • hash: Buffer
  • url: string

Asset

Asset: { amount: BigNumber; assetName: string }

Type declaration

  • amount: BigNumber
  • assetName: string

AuxiliaryData

AuxiliaryData: { metadata: Metadata[] }

Type declaration

BipPath

BipPath: { account: number; chain: number; coin: number; index: number; purpose: number }

Type declaration

  • account: number
  • chain: number
  • coin: number
  • index: number
  • purpose: number

CardanoAddress

CardanoAddress: ShelleyAddress | ByronAddress | RewardAddress

Certificate

Certificate: StakeRegistrationCertificate | StakeDeRegistrationCertificate | StakeDelegationCertificate | StakeKeyRegistrationCertificate | StakeKeyDeRegistrationCertificate | VoteDelegationCertificate | StakeVoteDelegationCertificate | StakeRegDelegationCertificate | VoteRegDelegationCertificate | StakeVoteRegDelegationCertificate | CommitteeAuthHotCertificate | CommitteeResignColdCertificate | DRepRegCertificate | DRepDeRegCertificate | DRepUpdateCertificate

CollateralInput

CollateralInput: { address: ShelleyAddress; amount: BigNumber; index: number; txId: string }

Type declaration

CommitteeAuthHotCertificate

CommitteeAuthHotCertificate: { cert: { coldCredential: CommitteeColdCredential; hotCredential: CommitteeHotCredential }; type: COMMITTEE_AUTH_HOT }

Type declaration

CommitteeColdCredential

CommitteeColdCredential: Credential

CommitteeHotCredential

CommitteeHotCredential: Credential

CommitteeResignColdCertificate

CommitteeResignColdCertificate: { cert: { anchor: Anchor | null; coldCredential: CommitteeColdCredential }; type: COMMITTEE_RESIGN_COLD }

Type declaration

CostMdls

CostMdls: { plutusV1: number[] | undefined; plutusV2: number[] | undefined; plutusV3: number[] | undefined }

Type declaration

  • plutusV1: number[] | undefined
  • plutusV2: number[] | undefined
  • plutusV3: number[] | undefined

Credential

Credential: HashCredential | ScriptCredential

DRep

DRep: { key: Buffer | undefined; type: DRepType }

Type declaration

DRepCredential

DRepCredential: Credential

DRepDeRegCertificate

DRepDeRegCertificate: { cert: { dRepCredential: DRepCredential; deposit: BigNumber }; type: DREP_DE_REG }

Type declaration

DRepRegCertificate

DRepRegCertificate: { cert: { anchor: Anchor | null; dRepCredential: DRepCredential; deposit: BigNumber }; type: DREP_REG }

Type declaration

DRepUpdateCertificate

DRepUpdateCertificate: { cert: { anchor: Anchor | null; dRepCredential: DRepCredential }; type: DREP_UPDATE }

Type declaration

ExUnits

ExUnits: { mem: number; steps: number }

Type declaration

  • mem: number
  • steps: number

GovAction

GovAction: ParameterChangeAction | HardForkInitAction | TreasuryWithdrawalsAction | NoConfidenceAction | UpdateCommitteeAction | NewConstitutionAction | InfoAction

GovActionId

GovActionId: { index: number; txId: Buffer }

Type declaration

  • index: number
  • txId: Buffer

HardForkInitAction

HardForkInitAction: { action: { prevActionId: GovActionId | null; protocolVersion: [number, number] }; type: HF_INIT_ACTION }

Type declaration

HashCredential

HashCredential: { bipPath?: BipPath; hash: Buffer; type: ADDRESS }

Type declaration

InfoAction

InfoAction: { type: INFO_ACTION }

Type declaration

Input

Input: { address: ShelleyAddress; amount: BigNumber; index: number; nativeScript?: NativeScript; plutusData?: PlutusData; plutusScript?: PlutusScript; redeemer?: Redeemer; tokens: Token[]; txId: string }

Type declaration

LanguageView

LanguageView: { PlutusScriptV1: number[]; PlutusScriptV2: number[]; PlutusScriptV3: number[] }

Type declaration

  • PlutusScriptV1: number[]
  • PlutusScriptV2: number[]
  • PlutusScriptV3: number[]

MetaDatum

MetaDatum: Map<MetaDatum, MetaDatum> | MetaDatum[] | number | Buffer | string

Metadata

Metadata: { data: MetaDatum; label: number }

Type declaration

Mint

Mint: { assets: Asset[]; nativeScript?: NativeScript; plutusScript?: PlutusScript; policyId: string; redeemer?: Redeemer }

Type declaration

NativeScript

NativeScript: NativeScriptPubKeyHash | NativeScriptNOfK | NativeScriptInvalidBefore | NativeScriptInvalidAfter | NativeScriptAll | NativeScriptAny

NativeScriptAll

NativeScriptAll: { all: NativeScript[] }

Type declaration

NativeScriptAny

NativeScriptAny: { any: NativeScript[] }

Type declaration

NativeScriptInvalidAfter

NativeScriptInvalidAfter: { invalidAfter: number }

Type declaration

  • invalidAfter: number

NativeScriptInvalidBefore

NativeScriptInvalidBefore: { invalidBefore: number }

Type declaration

  • invalidBefore: number

NativeScriptNOfK

NativeScriptNOfK: { k: NativeScript[]; n: number }

Type declaration

NativeScriptPubKeyHash

NativeScriptPubKeyHash: { pubKeyHash: string }

Type declaration

  • pubKeyHash: string

NewConstitutionAction

NewConstitutionAction: { action: { constitution: { anchor: Anchor; scriptHash: Buffer | null }; prevActionId: GovActionId | null }; type: NEW_CONSTITUTION_ACTION }

Type declaration

NoConfidenceAction

NoConfidenceAction: { action: { prevActionId: GovActionId | null }; type: NO_CONFIDENCE_ACTION }

Type declaration

Output

Output: { address: CardanoAddress; amount: BigNumber; nativeScript?: NativeScript; plutusData?: PlutusData; plutusDataHash?: string; plutusScript?: PlutusScript; tokens: Token[] }

Type declaration

ParameterChangeAction

ParameterChangeAction: { action: { policyHash: Buffer | null; prevActionId: GovActionId | null; protocolParamUpdate: ProtocolParamUpdate }; type: PARAM_CHANGE_ACTION }

Type declaration

PlutusData

PlutusData: number | BigNumber | Buffer | PlutusDataConstructor | PlutusData[] | Map<PlutusData, PlutusData>

PlutusDataConstructor

PlutusDataConstructor: { constructor: number; fields: PlutusData[] }

Type declaration

PlutusScript

PlutusScript: { cborHex: string; type: PlutusScriptType }

Type declaration

ProposalProcedure

ProposalProcedure: { anchor: Anchor; deposit: BigNumber; govAction: GovAction; rewardAccount: Buffer }

Type declaration

ProtocolParamUpdate

ProtocolParamUpdate: { adaPerUtxoByte?: BigNumber; collateralPercent?: number; committeeTermLimit?: number; costMdls?: CostMdls; dRepDeposit?: BigNumber; dRepInactivity?: number; dRepVotingThreshold?: { committeeNoConfidence: number; committeeNormal: number; economicParamVoting: number; govParamVoting: number; hfInitiation: number; motionNoConfidence: number; networkParamVoting: number; technicalParamVoting: number; treasuryWithdrawal: number; updateConstitution: number }; exUnitPrices?: { mem: [number, number]; steps: [number, number] }; expansionRate?: [number, number]; govActionDeposit?: BigNumber; govActionValidity?: number; maxBlockBodySize?: number; maxBlockExUnits?: { mem: number; steps: number }; maxBlockHeaderSize?: number; maxCollateralInputs?: number; maxTransactionSize?: number; maxTxExUnits?: { mem: number; steps: number }; maxValueSize?: BigNumber; minCommitteeSize?: number; minFeeA?: BigNumber; minFeeB?: BigNumber; minPoolCost?: BigNumber; n?: number; pledgeInfluence?: [number, number]; poolDeposit?: BigNumber; poolRetireMaxEpoch?: number; poolVotingThreshold?: { committeeNoConfidence: number; committeeNormal: number; hfInitiation: number; motionNoConfidence: number; securityParamVoting: number }; refScriptCostByte?: [number, number]; stakeKeyDeposit?: BigNumber; treasuryGrowthRate?: [number, number] }

Type declaration

  • Optional adaPerUtxoByte?: BigNumber
  • Optional collateralPercent?: number
  • Optional committeeTermLimit?: number
  • Optional costMdls?: CostMdls
  • Optional dRepDeposit?: BigNumber
  • Optional dRepInactivity?: number
  • Optional dRepVotingThreshold?: { committeeNoConfidence: number; committeeNormal: number; economicParamVoting: number; govParamVoting: number; hfInitiation: number; motionNoConfidence: number; networkParamVoting: number; technicalParamVoting: number; treasuryWithdrawal: number; updateConstitution: number }
    • committeeNoConfidence: number
    • committeeNormal: number
    • economicParamVoting: number
    • govParamVoting: number
    • hfInitiation: number
    • motionNoConfidence: number
    • networkParamVoting: number
    • technicalParamVoting: number
    • treasuryWithdrawal: number
    • updateConstitution: number
  • Optional exUnitPrices?: { mem: [number, number]; steps: [number, number] }
    • mem: [number, number]
    • steps: [number, number]
  • Optional expansionRate?: [number, number]
  • Optional govActionDeposit?: BigNumber
  • Optional govActionValidity?: number
  • Optional maxBlockBodySize?: number
  • Optional maxBlockExUnits?: { mem: number; steps: number }
    • mem: number
    • steps: number
  • Optional maxBlockHeaderSize?: number
  • Optional maxCollateralInputs?: number
  • Optional maxTransactionSize?: number
  • Optional maxTxExUnits?: { mem: number; steps: number }
    • mem: number
    • steps: number
  • Optional maxValueSize?: BigNumber
  • Optional minCommitteeSize?: number
  • Optional minFeeA?: BigNumber
  • Optional minFeeB?: BigNumber
  • Optional minPoolCost?: BigNumber
  • Optional n?: number
  • Optional pledgeInfluence?: [number, number]
  • Optional poolDeposit?: BigNumber
  • Optional poolRetireMaxEpoch?: number
  • Optional poolVotingThreshold?: { committeeNoConfidence: number; committeeNormal: number; hfInitiation: number; motionNoConfidence: number; securityParamVoting: number }
    • committeeNoConfidence: number
    • committeeNormal: number
    • hfInitiation: number
    • motionNoConfidence: number
    • securityParamVoting: number
  • Optional refScriptCostByte?: [number, number]
  • Optional stakeKeyDeposit?: BigNumber
  • Optional treasuryGrowthRate?: [number, number]

ProtocolParams

ProtocolParams: { collateralPercent: BigNumber; languageView: LanguageView; lovelacePerUtxoWord: BigNumber; maxTxSize?: number; maxValueSize: number; minFeeA: BigNumber; minFeeB: BigNumber; minFeeRefScriptCostPerByte: BigNumber; priceMem: BigNumber; priceSteps: BigNumber; stakeKeyDeposit: BigNumber; utxoCostPerByte: BigNumber }

Type declaration

  • collateralPercent: BigNumber
  • languageView: LanguageView
  • lovelacePerUtxoWord: BigNumber
  • Optional maxTxSize?: number
  • maxValueSize: number
  • minFeeA: BigNumber
  • minFeeB: BigNumber
  • minFeeRefScriptCostPerByte: BigNumber
  • priceMem: BigNumber
  • priceSteps: BigNumber
  • stakeKeyDeposit: BigNumber
  • utxoCostPerByte: BigNumber

Redeemer

Redeemer: { exUnits: ExUnits; plutusData: PlutusData }

Type declaration

ReferenceInput

ReferenceInput: { address?: ShelleyAddress; amount?: BigNumber; index: number; nativeScript?: NativeScript; plutusData?: PlutusData; plutusScript?: PlutusScript; tokens?: Token[]; txId: string }

Type declaration

ScriptCredential

ScriptCredential: { hash: Buffer; nativeScript?: NativeScript; plutusScript?: PlutusScript; type: SCRIPT }

Type declaration

ShelleyAddress

ShelleyAddress: BaseAddress | EnterpriseAddress | PointerAddress

StakeCredential

StakeCredential: Credential

StakeDeRegistrationCertificate

StakeDeRegistrationCertificate: { cert: { stakeCredential: StakeCredential }; type: STAKE_DE_REGISTRATION }

Type declaration

StakeDelegationCertificate

StakeDelegationCertificate: { cert: { poolHash: string; stakeCredential: StakeCredential }; type: STAKE_DELEGATION }

Type declaration

StakeKeyDeRegistrationCertificate

StakeKeyDeRegistrationCertificate: { cert: { deposit: BigNumber; stakeCredential: StakeCredential }; type: STAKE_KEY_DE_REGISTRATION }

Type declaration

StakeKeyRegistrationCertificate

StakeKeyRegistrationCertificate: { cert: { deposit: BigNumber; stakeCredential: StakeCredential }; type: STAKE_KEY_REGISTRATION }

Type declaration

StakeRegDelegationCertificate

StakeRegDelegationCertificate: { cert: { deposit: BigNumber; poolKeyHash: Buffer; stakeCredential: StakeCredential }; type: STAKE_REG_DELEG }

Type declaration

StakeRegistrationCertificate

StakeRegistrationCertificate: { cert: { stakeCredential: StakeCredential }; type: STAKE_REGISTRATION }

Type declaration

StakeVoteDelegationCertificate

StakeVoteDelegationCertificate: { cert: { dRep: DRep; poolKeyHash: Buffer; stakeCredential: StakeCredential }; type: STAKE_VOTE_DELEG }

Type declaration

StakeVoteRegDelegationCertificate

StakeVoteRegDelegationCertificate: { cert: { dRep: DRep; deposit: BigNumber; poolKeyHash: Buffer; stakeCredential: StakeCredential }; type: STAKE_VOTE_REG_DELEG }

Type declaration

Token

Token: { amount: BigNumber; assetName: string; policyId: string }

Type declaration

  • amount: BigNumber
  • assetName: string
  • policyId: string

TreasuryWithdrawalsAction

TreasuryWithdrawalsAction: { action: { policyHash: Buffer | null; withdrawals: Withdrawal[] }; type: TREASURY_WITHDRAW_ACTION }

Type declaration

UpdateCommitteeAction

UpdateCommitteeAction: { action: { addColdCreds: { credential: CommitteeColdCredential; epoch: number }[]; prevActionId: GovActionId | null; removeColdCreds: CommitteeColdCredential[]; threshold: [number, number] }; type: UPDATE_COMMITTEE_ACTION }

Type declaration

VKeyWitness

VKeyWitness: { publicKey: Buffer; signature: Buffer }

Type declaration

  • publicKey: Buffer
  • signature: Buffer

Vote

Vote: { anchor: Anchor | null; govActionId: GovActionId; vote: VoteType }

Type declaration

VoteDelegationCertificate

VoteDelegationCertificate: { cert: { dRep: DRep; stakeCredential: StakeCredential }; type: VOTE_DELEGATION }

Type declaration

VoteRegDelegationCertificate

VoteRegDelegationCertificate: { cert: { dRep: DRep; deposit: BigNumber; stakeCredential: StakeCredential }; type: VOTE_REG_DELEG }

Type declaration

Voter

Voter: { key: Credential; type: VoterType }

Type declaration

VotingProcedure

VotingProcedure: { voter: Voter; votes: Vote[] }

Type declaration

Withdrawal

Withdrawal: { amount: BigNumber; rewardAccount: RewardAddress }

Type declaration