Class NativeTransferBuilder

Builder for creating Native Transfer transactions.

Hierarchy

TransactionBuilder<NativeTransferBuilder>
- NativeTransferBuilder

Constructors

constructor

new NativeTransferBuilder(): NativeTransferBuilder
Returns NativeTransferBuilder
Overrides TransactionBuilder< NativeTransferBuilder >.constructor
- Defined in src/types/TransactionBuilder.ts:169

Properties

`Private` _amount

_amount: CLValue = ...

`Private` _amountRow

_amountRow: string | BigNumber = '0'

`Protected` _chainName

_chainName: string

`Protected` _contractHash

_contractHash: string

`Protected` _entryPoint

_entryPoint: TransactionEntryPoint

`Private` `Optional` _idTransfer

_idTransfer?: number

`Protected` _initiatorAddr

_initiatorAddr: InitiatorAddr

`Protected` _invocationTarget

_invocationTarget: TransactionTarget

`Protected` _pricingMode

_pricingMode: PricingMode

`Private` _publicKey

_publicKey: PublicKey

`Protected` _runtimeArgs

_runtimeArgs: Args

`Protected` _scheduling

_scheduling: TransactionScheduling = ...

`Private` _target

_target: CLValue

`Protected` _timestamp

_timestamp: Timestamp = ...

`Protected` _ttl

_ttl: Duration = ...

Methods

`Protected` _getDefaultDeployHeader

_getDefaultDeployHeader(): DeployHeader
Returns DeployHeader
Inherited from TransactionBuilder._getDefaultDeployHeader
- Defined in src/types/TransactionBuilder.ts:116

`Protected` _getStandardPayment

_getStandardPayment(): ExecutableDeployItem
Returns ExecutableDeployItem
Inherited from TransactionBuilder._getStandardPayment
- Defined in src/types/TransactionBuilder.ts:126

amount

amount(amount: string | BigNumber): NativeTransferBuilder
Sets the amount to transfer.
Parameters
- amount: string | BigNumber
Returns NativeTransferBuilder
- Defined in src/types/TransactionBuilder.ts:197

build

build(): Transaction
Builds and returns the Native Transfer transaction.

Returns Transaction
Overrides TransactionBuilder.build
- Defined in src/types/TransactionBuilder.ts:214

buildFor1_5

buildFor1_5(): Transaction
Builds and returns the Native Transfer transaction.

Returns Transaction
- Defined in src/types/TransactionBuilder.ts:234

chainName

chainName(chainName: string): NativeTransferBuilder
Sets the chain name for the transaction.
Parameters
- chainName: string
Returns NativeTransferBuilder
Inherited from TransactionBuilder.chainName
- Defined in src/types/TransactionBuilder.ts:72

contractHash

contractHash(contractHash: string): NativeTransferBuilder
Sets the contract hash for the transaction.
Parameters
- contractHash: string
Returns NativeTransferBuilder
Inherited from TransactionBuilder.contractHash
- Defined in src/types/TransactionBuilder.ts:80

from

from(publicKey: PublicKey): NativeTransferBuilder
Sets the initiator address using a public key.
Parameters
- publicKey: PublicKey
Returns NativeTransferBuilder
Inherited from TransactionBuilder.from
- Defined in src/types/TransactionBuilder.ts:56

fromAccountHash

fromAccountHash(accountHashKey: AccountHash): NativeTransferBuilder
Sets the initiator address using an account hash.
Parameters
- accountHashKey: AccountHash
Returns NativeTransferBuilder
Inherited from TransactionBuilder.fromAccountHash
- Defined in src/types/TransactionBuilder.ts:64

id

id(id: number): NativeTransferBuilder
Sets the transfer ID.
Parameters
- id: number
Returns NativeTransferBuilder
- Defined in src/types/TransactionBuilder.ts:206

payment

payment(paymentAmount: number, gasPriceTolerance?: number): NativeTransferBuilder
Sets the payment amount for the transaction.
Parameters
- paymentAmount: number
- gasPriceTolerance: number = 1
Returns NativeTransferBuilder
Inherited from TransactionBuilder.payment
- Defined in src/types/TransactionBuilder.ts:104

target

target(publicKey: PublicKey): NativeTransferBuilder
Sets the target public key for the transfer.
Parameters
- publicKey: PublicKey
Returns NativeTransferBuilder
- Defined in src/types/TransactionBuilder.ts:180

targetAccountHash

targetAccountHash(accountHashKey: AccountHash): NativeTransferBuilder
Sets the target account hash for the transfer.
Parameters
- accountHashKey: AccountHash
Returns NativeTransferBuilder
- Defined in src/types/TransactionBuilder.ts:189

timestamp

timestamp(timestamp: Timestamp): NativeTransferBuilder
Sets the timestamp for the transaction.
Parameters
- timestamp: Timestamp
Returns NativeTransferBuilder
Inherited from TransactionBuilder.timestamp
- Defined in src/types/TransactionBuilder.ts:88

ttl

ttl(ttl: number): NativeTransferBuilder
Sets the time-to-live for the transaction.
Parameters
- ttl: number
Returns NativeTransferBuilder
Inherited from TransactionBuilder.ttl
- Defined in src/types/TransactionBuilder.ts:96

Generated using TypeDoc