Class NativeUndelegateBuilder

Builder for creating Native Undelegate transactions. Allows accounts to undelegate their staked CSPR tokens from a validator.

Example

const transaction = new NativeUndelegateBuilder()
  .from(delegatorPublicKey)
  .validator(validatorPublicKey)
  .amount('250000000000') // 250 CSPR
  .chainName('casper')
  .payment(2_500_000_000)
  .build();

Hierarchy

TransactionBuilder<NativeUndelegateBuilder>
- NativeUndelegateBuilder

Index

Constructors

constructor

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

Properties

`Private` _amount

_amount: CLValue = ...

`Protected` _chainName

_chainName: string

`Protected` _contractHash

_contractHash: string

`Protected` _entryPoint

_entryPoint: TransactionEntryPoint

`Protected` _initiatorAddr

_initiatorAddr: InitiatorAddr

`Protected` _invocationTarget

_invocationTarget: TransactionTarget

`Protected` _pricingMode

_pricingMode: PricingMode

`Protected` _runtimeArgs

_runtimeArgs: Args

`Protected` _scheduling

_scheduling: TransactionScheduling = ...

`Protected` _timestamp

_timestamp: Timestamp = ...

`Protected` _ttl

_ttl: Duration = ...

`Private` _validator

_validator: CLValue

Methods

`Protected` _getDefaultDeployHeader

_getDefaultDeployHeader(): DeployHeader
Protected
Creates a default deploy header with the configured transaction settings.

Returns
A deploy header with account, chain name, timestamp, TTL, and gas price

Returns DeployHeader
Inherited from TransactionBuilder._getDefaultDeployHeader
- Defined in src/types/TransactionBuilder.ts:148

`Protected` _getStandardPayment

_getStandardPayment(): ExecutableDeployItem
Protected
Creates a standard payment executable deploy item.

Returns
An executable deploy item configured for standard payment

Throws
If payment amount is not specified

Returns ExecutableDeployItem
Inherited from TransactionBuilder._getStandardPayment
- Defined in src/types/TransactionBuilder.ts:169

amount

amount(amount: string | BigNumber): NativeUndelegateBuilder
Sets the amount to undelegate in motes.

Returns
The builder instance for method chaining
Parameters
- amount: string | BigNumber
  
  The undelegation amount
Returns NativeUndelegateBuilder
- Defined in src/types/TransactionBuilder.ts:815

build

build(): Transaction
Builds and returns the Undelegate transaction for Casper 2.0+.

Returns
A complete Transaction object ready to be signed and submitted

Throws
If initiator address is not specified

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

buildFor1_5

buildFor1_5(): Transaction
Builds and returns the Undelegate transaction for Casper 1.5. Uses the auction manager contract for backward compatibility.

Returns
A Transaction object compatible with Casper 1.5

Throws
If initiator address or contract hash is not specified

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

chainName

chainName(chainName: string): NativeUndelegateBuilder
Sets the chain name for the transaction.

Returns
The builder instance for method chaining
Parameters
- chainName: string
  
  The name of the Casper network chain (e.g., 'casper-test', 'casper')
Returns NativeUndelegateBuilder
Inherited from TransactionBuilder.chainName
- Defined in src/types/TransactionBuilder.ts:85

contractHash

contractHash(contractHash: string): NativeUndelegateBuilder
Sets the contract hash for the transaction.

Returns
The builder instance for method chaining
Parameters
- contractHash: string
  
  The contract hash in hexadecimal format
Returns NativeUndelegateBuilder
Inherited from TransactionBuilder.contractHash
- Defined in src/types/TransactionBuilder.ts:96

from

from(publicKey: PublicKey): NativeUndelegateBuilder
Sets the initiator address using a public key.

Returns
The builder instance for method chaining
Parameters
- publicKey: PublicKey
  
  The public key of the transaction initiator
Returns NativeUndelegateBuilder
Inherited from TransactionBuilder.from
- Defined in src/types/TransactionBuilder.ts:63

fromAccountHash

fromAccountHash(accountHashKey: AccountHash): NativeUndelegateBuilder
Sets the initiator address using an account hash.

Returns
The builder instance for method chaining
Parameters
- accountHashKey: AccountHash
  
  The account hash of the transaction initiator
Returns NativeUndelegateBuilder
Inherited from TransactionBuilder.fromAccountHash
- Defined in src/types/TransactionBuilder.ts:74

payment

payment(paymentAmount: number, gasPriceTolerance?: number): NativeUndelegateBuilder
Sets the payment amount for the transaction using a limited payment mode.

Returns
The builder instance for method chaining
Parameters
- paymentAmount: number
  
  The payment amount in motes
- gasPriceTolerance: number = 1
  
  Gas price tolerance multiplier (default: 1)
Returns NativeUndelegateBuilder
Inherited from TransactionBuilder.payment
- Defined in src/types/TransactionBuilder.ts:130

timestamp

timestamp(timestamp: Timestamp): NativeUndelegateBuilder
Sets the timestamp for the transaction.

Returns
The builder instance for method chaining
Parameters
- timestamp: Timestamp
  
  The transaction timestamp
Returns NativeUndelegateBuilder
Inherited from TransactionBuilder.timestamp
- Defined in src/types/TransactionBuilder.ts:107

ttl

ttl(ttl: number): NativeUndelegateBuilder
Sets the time-to-live for the transaction.

Returns
The builder instance for method chaining
Parameters
- ttl: number
  
  Time-to-live in milliseconds (default: 1800000ms = 30 minutes)
Returns NativeUndelegateBuilder
Inherited from TransactionBuilder.ttl
- Defined in src/types/TransactionBuilder.ts:118

validator

validator(publicKey: PublicKey): NativeUndelegateBuilder
Sets the validator's public key to undelegate from.

Returns
The builder instance for method chaining
Parameters
- publicKey: PublicKey
  
  The validator's public key
Returns NativeUndelegateBuilder
- Defined in src/types/TransactionBuilder.ts:804

Class NativeUndelegateBuilder

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns NativeUndelegateBuilder

Properties

Private _amount

Protected _chainName

Protected _contractHash

Protected _entryPoint

Protected _initiatorAddr

Protected _invocationTarget

Protected _pricingMode

Protected _runtimeArgs

Protected _scheduling

Protected _timestamp

Protected _ttl

Private _validator

Methods

Protected _getDefaultDeployHeader

Returns

Returns DeployHeader

Protected _getStandardPayment

Returns

Throws

Returns ExecutableDeployItem

amount

Returns

Parameters

amount: string | BigNumber

Returns NativeUndelegateBuilder

build

Returns

Throws

Returns Transaction

buildFor1_5

Returns

Throws

Returns Transaction

chainName

Returns

Parameters

chainName: string

Returns NativeUndelegateBuilder

contractHash

Returns

Parameters

contractHash: string

Returns NativeUndelegateBuilder

from

Returns

Parameters

publicKey: PublicKey

Returns NativeUndelegateBuilder

fromAccountHash

Returns

Parameters

accountHashKey: AccountHash

Returns NativeUndelegateBuilder

payment

Returns

Parameters

paymentAmount: number

gasPriceTolerance: number = 1

Returns NativeUndelegateBuilder

timestamp

Returns

Parameters

timestamp: Timestamp

Returns NativeUndelegateBuilder

ttl

Returns

Parameters

ttl: number

Returns NativeUndelegateBuilder

`Private` _amount

`Protected` _chainName

`Protected` _contractHash

`Protected` _entryPoint

`Protected` _initiatorAddr

`Protected` _invocationTarget

`Protected` _pricingMode

`Protected` _runtimeArgs

`Protected` _scheduling

`Protected` _timestamp

`Protected` _ttl

`Private` _validator

`Protected` _getDefaultDeployHeader

`Protected` _getStandardPayment