Class UploadTransactionRequest

Abstract class to define the functionalities of a transaction request transaction request.

Hierarchy (view full)

BaseTransactionRequest
- UploadTransactionRequest

Constructors

constructor

new UploadTransactionRequest(uploadTransactionRequestLike?): UploadTransactionRequest
Creates an instance UploadTransactionRequest.
Parameters
- uploadTransactionRequestLike: UploadTransactionRequestLike = {}
  The initial values for the instance
Returns UploadTransactionRequest
Overrides BaseTransactionRequest.constructor
- Defined in packages/account/src/providers/transaction-request/upload-transaction-request.ts:65

Properties

inputs

inputs: TransactionRequestInput[] = []

List of inputs

`Optional`maturity

maturity?: number

Block until which tx cannot be included

maxFee

maxFee: BN

The maximum fee payable by this transaction using BASE_ASSET.

outputs

outputs: TransactionRequestOutput[] = []

List of outputs

subsection

subsection: Omit<UploadSubsectionRequest, "subsection">

The subsection data.

`Optional`tip

tip?: BN

Gas price for transaction

type

type: Upload = ...

Type of the transaction

witnessIndex

witnessIndex: number

The witness index of the subsection of the bytecode.

`Optional`witnessLimit

witnessLimit?: BN

The maximum amount of witness data allowed for the transaction

witnesses

witnesses: BytesLike[] = []

List of witnesses

Methods

addAccountWitnesses

addAccountWitnesses(account): Promise<UploadTransactionRequest>
Helper function to add an external signature to the transaction.
Parameters
- account: Account | Account[]
  The account/s to sign to the transaction.
Returns Promise<UploadTransactionRequest>
The transaction with the signature witness added.
Inherited from BaseTransactionRequest.addAccountWitnesses
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:294

addChangeOutput

addChangeOutput(to, assetId): void
Adds a change output to the transaction.
Parameters
- to: AddressLike
  Address of the owner.
- assetId: BytesLike
  Asset ID of coin.
Returns void
Inherited from BaseTransactionRequest.addChangeOutput
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:519

addCoinInput

addCoinInput(coin): void
Adds a single coin input to the transaction and a change output for the related assetId, if one it was not added yet.
Parameters
- coin: Coin
  Coin resource.
Returns void
Inherited from BaseTransactionRequest.addCoinInput
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:368

addCoinOutput

addCoinOutput(to, amount, assetId): UploadTransactionRequest
Adds a coin output to the transaction.
Parameters
- to: AddressLike
  Address of the owner.
- amount: BigNumberish
  Amount of coin.
- assetId: BytesLike
  Asset ID of coin.
Returns UploadTransactionRequest
Inherited from BaseTransactionRequest.addCoinOutput
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:483

addCoinOutputs

addCoinOutputs(to, quantities): UploadTransactionRequest
Adds multiple coin outputs to the transaction.
Parameters
- to: AddressLike
  Address of the destination.
- quantities: CoinQuantityLike[]
  Quantities of coins.
Returns UploadTransactionRequest
Inherited from BaseTransactionRequest.addCoinOutputs
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:500

addMessageInput

addMessageInput(message): void
Adds a single message input to the transaction and a change output for the asset against the message
Parameters
- message: Message | MessageCoin
  Message resource.
Returns void
Inherited from BaseTransactionRequest.addMessageInput
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:409

addResource

addResource(resource): UploadTransactionRequest
Adds a single resource to the transaction by adding a coin/message input and a change output for the related assetId, if one it was not added yet.
Parameters
- resource: Resource
  The resource to add.
Returns UploadTransactionRequest
This transaction.
Inherited from BaseTransactionRequest.addResource
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:453

addResources

addResources(resources): UploadTransactionRequest
Adds multiple resources to the transaction by adding coin/message inputs and change outputs from the related assetIds.
Parameters
- resources: readonly Resource[]
  The resources to add.
Returns UploadTransactionRequest
This transaction.
Inherited from BaseTransactionRequest.addResources
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:470

addSubsection

addSubsection(subsection): void
Adds the subsection.
Parameters
- subsection: UploadSubsectionRequest
  The subsection data.
Returns void
- Defined in packages/account/src/providers/transaction-request/upload-transaction-request.ts:81

byteLength

byteLength(): number
Returns number
Inherited from BaseTransactionRequest.byteLength
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:709

calculateMaxGas

calculateMaxGas(chainInfo, minGas): BN
Parameters
- chainInfo: ChainInfo
- minGas: BN
Returns BN
Inherited from BaseTransactionRequest.calculateMaxGas
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:567

calculateMinGas

calculateMinGas(chainInfo): BN
Calculates the minimum gas for an upload transaction.
Parameters
- chainInfo: ChainInfo
  The chain information.
Returns BN
the minimum gas for the upload transaction
Overrides BaseTransactionRequest.calculateMinGas
- Defined in packages/account/src/providers/transaction-request/upload-transaction-request.ts:141

fundWithFakeUtxos

fundWithFakeUtxos(quantities, baseAssetId, resourcesOwner?): UploadTransactionRequest
Funds the transaction with fake UTXOs for each assetId and amount in the quantities array.
Parameters
- quantities: CoinQuantity[]
  CoinQuantity Array.
- baseAssetId: string
  The base asset to fund the transaction.
- OptionalresourcesOwner: AbstractAddress
Returns UploadTransactionRequest
Deprecated
- This method is deprecated and will be removed in future versions. Please use Account.generateFakeResources along with this.addResources instead.
Inherited from BaseTransactionRequest.fundWithFakeUtxos
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:596

`Protected`getBaseTransaction

getBaseTransaction(): ToBaseTransactionResponse
Method to obtain the base transaction details.

Returns ToBaseTransactionResponse
The base transaction details.
Inherited from BaseTransactionRequest.getBaseTransaction
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:179

getChangeOutputs

getChangeOutputs(): ChangeTransactionRequestOutput[]
Gets the change outputs for a transaction.

Returns ChangeTransactionRequestOutput[]
The change outputs.
Inherited from BaseTransactionRequest.getChangeOutputs
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:332

getCoinInputs

getCoinInputs(): CoinTransactionRequestInput[]
Gets the coin inputs for a transaction.

Returns CoinTransactionRequestInput[]
The coin inputs.
Inherited from BaseTransactionRequest.getCoinInputs
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:310

getCoinOutputs

getCoinOutputs(): CoinTransactionRequestOutput[]
Gets the coin outputs for a transaction.

Returns CoinTransactionRequestOutput[]
The coin outputs.
Inherited from BaseTransactionRequest.getCoinOutputs
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:321

getCoinOutputsQuantities

getCoinOutputsQuantities(): CoinQuantity[]
Retrieves an array of CoinQuantity for each coin output present in the transaction. a transaction.

Returns CoinQuantity[]
CoinQuantity array.
Inherited from BaseTransactionRequest.getCoinOutputsQuantities
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:647

getTransactionId

getTransactionId(chainId): string
Gets the Transaction Request by hashing the transaction.
Parameters
- chainId: number
  The chain ID.
Returns string
- A hash of the transaction, which is the transaction ID.
Overrides BaseTransactionRequest.getTransactionId
- Defined in packages/account/src/providers/transaction-request/upload-transaction-request.ts:94

metadataGas

metadataGas(gasCosts): BN
Calculates the metadata gas cost for an upload transaction.
Parameters
- gasCosts: GasCosts
  gas costs passed from the chain.
Returns BN
metadata gas cost for the upload transaction.
Overrides BaseTransactionRequest.metadataGas
- Defined in packages/account/src/providers/transaction-request/upload-transaction-request.ts:125

removeWitness

removeWitness(index): void
Parameters
- index: number
Returns void
Inherited from BaseTransactionRequest.removeWitness
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:675

toJSON

toJSON(): any
Return the minimum amount in native coins required to create a transaction.

Returns any
The transaction as a JSON object.
Inherited from BaseTransactionRequest.toJSON
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:671

toTransaction

toTransaction(): TransactionUpload
Converts the transaction request to a TransactionUpload.

Returns TransactionUpload
The transaction create object.
Overrides BaseTransactionRequest.toTransaction
- Defined in packages/account/src/providers/transaction-request/upload-transaction-request.ts:103

toTransactionBytes

toTransactionBytes(): Uint8Array
Converts the transaction request to a byte array.

Returns Uint8Array
The transaction bytes.
Inherited from BaseTransactionRequest.toTransactionBytes
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:210

updatePredicateGasUsed

updatePredicateGasUsed(inputs): void
Parameters
- inputs: TransactionRequestInput[]
Returns void
Inherited from BaseTransactionRequest.updatePredicateGasUsed
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:689

updateWitness

updateWitness(index, witness): void
Updates an existing witness without any side effects.
Parameters
- index: number
  The index of the witness to update.
- witness: BytesLike
  The new witness.
Returns void
Throws
If the witness does not exist.
Inherited from BaseTransactionRequest.updateWitness
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:281

updateWitnessByOwner

updateWitnessByOwner(address, signature): void
Updates the witness for a given owner and signature.
Parameters
- address: string | AbstractAddress
  The address to get the coin input witness index for.
- signature: BytesLike
  The signature to update the witness with.
Returns void
Inherited from BaseTransactionRequest.updateWitnessByOwner
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:266

`Static`from

from(obj): UploadTransactionRequest
Parameters
- obj: UploadTransactionRequestLike
Returns UploadTransactionRequest
- Defined in packages/account/src/providers/transaction-request/upload-transaction-request.ts:46

`Static`getPolicyMeta

getPolicyMeta(req): {
policies: Policy[];
policyTypes: number;
}
Parameters
- req: BaseTransactionRequest
Returns {
policies: Policy[];
policyTypes: number;
}
- policies: Policy[]
- policyTypes: number
Inherited from BaseTransactionRequest.getPolicyMeta
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:145

Class UploadTransactionRequest

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UploadTransactionRequest

Properties

inputs

Optionalmaturity

maxFee

outputs

subsection

Optionaltip

type

witnessIndex

OptionalwitnessLimit

witnesses

Methods

addAccountWitnesses

Parameters

Returns Promise<UploadTransactionRequest>

addChangeOutput

Parameters

Returns void

addCoinInput

Parameters

Returns void

addCoinOutput

Parameters

Returns UploadTransactionRequest

addCoinOutputs

Parameters

Returns UploadTransactionRequest

addMessageInput

Parameters

Returns void

addResource

Parameters

Returns UploadTransactionRequest

addResources

Parameters

Returns UploadTransactionRequest

addSubsection

Parameters

Returns void

byteLength

Returns number

calculateMaxGas

Parameters

Returns BN

calculateMinGas

Parameters

Returns BN

fundWithFakeUtxos

Parameters

Returns UploadTransactionRequest

Deprecated

ProtectedgetBaseTransaction

Returns ToBaseTransactionResponse

getChangeOutputs

Returns ChangeTransactionRequestOutput[]

getCoinInputs

Returns CoinTransactionRequestInput[]

getCoinOutputs

Returns CoinTransactionRequestOutput[]

getCoinOutputsQuantities

Returns CoinQuantity[]

getTransactionId

Parameters

Returns string

metadataGas

Parameters

Returns BN

removeWitness

Parameters

Returns void

`Optional`maturity

`Optional`tip

`Optional`witnessLimit

`Protected`getBaseTransaction

`Static`from

`Static`getPolicyMeta

Returns {
policies: Policy[];
policyTypes: number;
}