Class ExecutableDeployItem

Represents an executable deploy item, which can be one of several types such as ModuleBytes, StoredContractByHash, etc.

Hierarchy

ExecutableDeployItem

Constructors

constructor

new ExecutableDeployItem(): ExecutableDeployItem
Returns ExecutableDeployItem

Properties

`Optional` moduleBytes

moduleBytes?: ModuleBytes

A module bytes deploy item.

`Optional` storedContractByHash

storedContractByHash?: StoredContractByHash

A stored contract deploy item referenced by hash.

`Optional` storedContractByName

storedContractByName?: StoredContractByName

A stored contract deploy item referenced by name.

`Optional` storedVersionedContractByHash

storedVersionedContractByHash?: StoredVersionedContractByHash

A stored versioned contract deploy item referenced by hash.

`Optional` storedVersionedContractByName

storedVersionedContractByName?: StoredVersionedContractByName

A stored versioned contract deploy item referenced by name.

`Optional` transfer

transfer?: TransferDeployItem

A transfer deploy item.

Methods

asModuleBytes

asModuleBytes(): undefined | ModuleBytes
Casts the ExecutableDeployItem to ModuleBytes if possible.

Returns
The ModuleBytes representation of the ExecutableDeployItem, or undefined if not possible.

Returns undefined | ModuleBytes
- Defined in src/types/ExecutableDeployItem.ts:550

bytes

bytes(): Uint8Array
Serializes the ExecutableDeployItem to a byte array.

Returns
The serialized byte array.

Returns Uint8Array
- Defined in src/types/ExecutableDeployItem.ts:489

getArgByName

getArgByName(name: string): undefined | CLValue
Retrieves an argument by name from the deploy item.

Returns
The argument value, or undefined if not found.
Parameters
- name: string
  
  The name of the argument.
Returns undefined | CLValue
- Defined in src/types/ExecutableDeployItem.ts:454

getArgs

getArgs(): Args
Retrieves the arguments for the deploy item.

Returns
The arguments for the deploy item.

Returns Args
- Defined in src/types/ExecutableDeployItem.ts:473

isModuleBytes

isModuleBytes(): boolean
Checks if the ExecutableDeployItem is of type ModuleBytes.

Returns
true if the ExecutableDeployItem is of type ModuleBytes, false otherwise.

Returns boolean
- Defined in src/types/ExecutableDeployItem.ts:598

isStoredContractByHash

isStoredContractByHash(): boolean
Checks if the ExecutableDeployItem is of type StoredContractByHash.

Returns
true if the ExecutableDeployItem is a stored contract by hash, false otherwise.

Returns boolean
- Defined in src/types/ExecutableDeployItem.ts:590

isStoredContractByName

isStoredContractByName(): boolean
Checks if the ExecutableDeployItem is of type StoredContractByName.

Returns
true if the ExecutableDeployItem is a stored contract by name, false otherwise.

Returns boolean
- Defined in src/types/ExecutableDeployItem.ts:582

isStoredVersionContractByHash

isStoredVersionContractByHash(): boolean
Checks if the ExecutableDeployItem is of type StoredVersionedContractByHash.

Returns
true if the ExecutableDeployItem is a stored versioned contract by hash, false otherwise.

Returns boolean
- Defined in src/types/ExecutableDeployItem.ts:566

isStoredVersionContractByName

isStoredVersionContractByName(): boolean
Checks if the ExecutableDeployItem is of type StoredVersionedContractByName.

Returns
true if the ExecutableDeployItem is a stored versioned contract by name, false otherwise.

Returns boolean
- Defined in src/types/ExecutableDeployItem.ts:574

isTransfer

isTransfer(): boolean
Checks if the ExecutableDeployItem is of type Transfer.

Returns
true if the ExecutableDeployItem is a transfer item, false otherwise.

Returns boolean
- Defined in src/types/ExecutableDeployItem.ts:558

setArg

setArg(name: string, value: CLValue): void
Sets an argument by name for the deploy item.
Parameters
- name: string
  
  The name of the argument.
- value: CLValue
  
  The value of the argument.
Returns void
- Defined in src/types/ExecutableDeployItem.ts:464

`Static` newModuleBytes

newModuleBytes(moduleBytes: Uint8Array, args: Args): ExecutableDeployItem
Creates a new ModuleBytes object from a Uint8Array of module bytes and a set of RuntimeArgs

Returns
A new ExecutableDeployItem created from a new ModuleBytes object built using moduleBytes and args
Parameters
- moduleBytes: Uint8Array
  
  A set of module bytes as a Uint8Array
- args: Args
  
  The runtime arguments for the new ModuleBytes object
Returns ExecutableDeployItem
- Defined in src/types/ExecutableDeployItem.ts:608

`Static` standardPayment

standardPayment(amount: string | BigNumber): ExecutableDeployItem
Creates a standard payment ExecutableDeployItem with the specified amount.

Returns
A new ExecutableDeployItem instance with the payment.
Parameters
- amount: string | BigNumber
  
  The amount to be transferred.
Returns ExecutableDeployItem
- Defined in src/types/ExecutableDeployItem.ts:535

Class ExecutableDeployItem

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ExecutableDeployItem

Properties

Optional moduleBytes

Optional storedContractByHash

Optional storedContractByName

Optional storedVersionedContractByHash

Optional storedVersionedContractByName

Optional transfer

Methods

asModuleBytes

Returns

Returns undefined | ModuleBytes

bytes

Returns

Returns Uint8Array

getArgByName

Returns

Parameters

name: string

Returns undefined | CLValue

getArgs

Returns

Returns Args

isModuleBytes

Returns

Returns boolean

isStoredContractByHash

Returns

Returns boolean

isStoredContractByName

Returns

Returns boolean

isStoredVersionContractByHash

Returns

Returns boolean

isStoredVersionContractByName

Returns

Returns boolean

isTransfer

Returns

Returns boolean

setArg

Parameters

name: string

value: CLValue

Returns void

Static newModuleBytes

Returns

Parameters

moduleBytes: Uint8Array

args: Args

Returns ExecutableDeployItem

Static standardPayment

Returns

Parameters

amount: string | BigNumber

Returns ExecutableDeployItem

Settings

Member Visibility

Theme

`Optional` moduleBytes

`Optional` storedContractByHash

`Optional` storedContractByName

`Optional` storedVersionedContractByHash

`Optional` storedVersionedContractByName

`Optional` transfer

`Static` newModuleBytes

`Static` standardPayment