Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace <internal>

Index

Classes GET

Classes Other

Interfaces

Type aliases

Type aliases

BidOptions: Omit<BidStorageStructure, "bidderKey" | "auctionKey"> & { auctionKey: string; bidderKey: string }
ConstructTransaction<A, O>: DistributiveOverwrite<TransactionBase & A, O>

Transaction builder type that accepts 2 generics:

  • A: Additional parameters on top of the base transaction parameters
  • O: A set of overwrites for transaction parameters

Type parameters

  • A = {}

  • O = {}

DistributiveOverwrite<T, K>: T extends unknown ? Overwrite<T, K> : never

Same as Overwrite, but will distribute the Overwrite over unions

Type parameters

  • T

  • K

Overwrite<T, U>: Pick<T, Exclude<keyof T, keyof U>> & U

Overwrite a type with properties from another type

Type parameters

  • T

  • U: Partial<T>

Query<F>: { format?: F }

Type parameters

  • F

Type declaration

  • [key: string]: any
  • Optional format?: F
SpecificParameters: Pick<TransactionParams, "to" | "amount" | "closeRemainderTo">
SpecificParameters: Pick<TransactionParams, "voteKey" | "selectionKey" | "stateProofKey" | "voteFirst" | "voteLast" | "voteKeyDilution" | "nonParticipation">
SpecificParametersForConfig: Pick<TransactionParams, "assetIndex" | "assetManager" | "assetReserve" | "assetFreeze" | "assetClawback">
SpecificParametersForCreate: Pick<TransactionParams, "assetTotal" | "assetDecimals" | "assetDefaultFrozen" | "assetUnitName" | "assetName" | "assetURL" | "assetMetadataHash" | "assetManager" | "assetReserve" | "assetFreeze" | "assetClawback">
SpecificParametersForCreate: Pick<TransactionParams, "appIndex" | "appOnComplete" | "appApprovalProgram" | "appClearProgram" | "appLocalInts" | "appLocalByteSlices" | "appGlobalInts" | "appGlobalByteSlices" | "appArgs" | "appAccounts" | "appForeignApps" | "appForeignAssets" | "extraPages">
SpecificParametersForDelete: Pick<TransactionParams, "appIndex" | "appOnComplete" | "appArgs" | "appAccounts" | "appForeignApps" | "appForeignAssets">
SpecificParametersForDestroy: Pick<TransactionParams, "assetIndex">
SpecificParametersForFreeze: Pick<TransactionParams, "assetIndex" | "freezeAccount" | "freezeState">
SpecificParametersForTransfer: Pick<TransactionParams, "from" | "to" | "closeRemainderTo" | "assetRevocationTarget" | "amount" | "assetIndex">
SpecificParametersForUpdate: Pick<TransactionParams, "appIndex" | "appOnComplete" | "appApprovalProgram" | "appClearProgram" | "appArgs" | "appAccounts" | "appForeignApps" | "appForeignAssets">

Transaction common fields.

Base transaction type that is extended for all other transaction types. Suggested params must be included, either as named object or included in the rest of the parameters.

TransactionBaseWithSuggestedParams: Pick<TransactionParams, "suggestedParams" | "from" | "type" | "lease" | "note" | "reKeyTo">

Transaction base with suggested params as object

TransactionBaseWithoutSuggestedParams: Pick<TransactionParams, "flatFee" | "fee" | "firstRound" | "lastRound" | "genesisHash" | "from" | "type" | "genesisID" | "lease" | "note" | "reKeyTo">

Transaction base with suggested params included as parameters

Generated using TypeDoc