Class SessionBuilder

Builder for creating Session transactions. Used to deploy new smart contracts or upgrade existing ones from WebAssembly bytecode.

Example

const wasmBytes = await fs.readFile('contract.wasm');
const transaction = new SessionBuilder()
  .from(deployerPublicKey)
  .wasm(wasmBytes)
  .installOrUpgrade()
  .runtimeArgs(args)
  .chainName('casper')
  .payment(100_000_000_000)
  .build();

Hierarchy

TransactionBuilder<SessionBuilder>
- SessionBuilder

Constructors

constructor

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

Properties

`Protected` _chainName

_chainName: string

`Protected` _contractHash

_contractHash: string

`Protected` _entryPoint

_entryPoint: TransactionEntryPoint

`Protected` _initiatorAddr

_initiatorAddr: InitiatorAddr

`Protected` _invocationTarget

_invocationTarget: TransactionTarget

`Private` _isInstallOrUpgrade

_isInstallOrUpgrade: boolean = false

`Protected` _pricingMode

_pricingMode: PricingMode

`Protected` _runtimeArgs

_runtimeArgs: Args

`Protected` _scheduling

_scheduling: TransactionScheduling = ...

`Protected` _timestamp

_timestamp: Timestamp = ...

`Protected` _ttl

_ttl: Duration = ...

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

build

build(): Transaction
Builds and returns the Transaction instance.

Returns
A complete Transaction object ready to be signed and submitted

Returns Transaction
Inherited from TransactionBuilder.build
- Defined in src/types/TransactionBuilder.ts:184

buildFor1_5

buildFor1_5(): Transaction
Builds and returns the Session transaction for Casper 1.5. Uses the legacy deploy format for backward compatibility.

Returns
A Transaction object compatible with Casper 1.5

Throws
If WASM bytecode is not specified

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

chainName

chainName(chainName: string): SessionBuilder
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 SessionBuilder
Inherited from TransactionBuilder.chainName
- Defined in src/types/TransactionBuilder.ts:85

contractHash

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

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

from

from(publicKey: PublicKey): SessionBuilder
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 SessionBuilder
Inherited from TransactionBuilder.from
- Defined in src/types/TransactionBuilder.ts:63

fromAccountHash

fromAccountHash(accountHashKey: AccountHash): SessionBuilder
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 SessionBuilder
Inherited from TransactionBuilder.fromAccountHash
- Defined in src/types/TransactionBuilder.ts:74

installOrUpgrade

installOrUpgrade(): SessionBuilder
Marks this session as an install or upgrade operation. Should be called when deploying a new contract or upgrading an existing one.

Returns
The builder instance for method chaining

Returns SessionBuilder
- Defined in src/types/TransactionBuilder.ts:1434

payment

payment(paymentAmount: number, gasPriceTolerance?: number): SessionBuilder
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 SessionBuilder
Inherited from TransactionBuilder.payment
- Defined in src/types/TransactionBuilder.ts:130

runtimeArgs

runtimeArgs(args: Args): SessionBuilder
Sets the runtime arguments to pass to the session.

Returns
The builder instance for method chaining
Parameters
- args: Args
  
  The arguments to pass to the contract installer
Returns SessionBuilder
- Defined in src/types/TransactionBuilder.ts:1448

timestamp

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

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

ttl

ttl(ttl: number): SessionBuilder
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 SessionBuilder
Inherited from TransactionBuilder.ttl
- Defined in src/types/TransactionBuilder.ts:118

wasm

wasm(wasmBytes: Uint8Array): SessionBuilder
Sets the WebAssembly bytecode for the session.

Returns
The builder instance for method chaining
Parameters
- wasmBytes: Uint8Array
  
  The compiled WebAssembly contract bytecode
Returns SessionBuilder
- Defined in src/types/TransactionBuilder.ts:1413

Class SessionBuilder

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SessionBuilder

Properties

Protected _chainName

Protected _contractHash

Protected _entryPoint

Protected _initiatorAddr

Protected _invocationTarget

Private _isInstallOrUpgrade

Protected _pricingMode

Protected _runtimeArgs

Protected _scheduling

Protected _timestamp

Protected _ttl

Methods

Protected _getDefaultDeployHeader

Returns

Returns DeployHeader

Protected _getStandardPayment

Returns

Throws

Returns ExecutableDeployItem

build

Returns

Returns Transaction

buildFor1_5

Returns

Throws

Returns Transaction

chainName

Returns

Parameters

chainName: string

Returns SessionBuilder

contractHash

Returns

Parameters

contractHash: string

Returns SessionBuilder

from

Returns

Parameters

publicKey: PublicKey

Returns SessionBuilder

fromAccountHash

Returns

Parameters

accountHashKey: AccountHash

Returns SessionBuilder

installOrUpgrade

Returns

Returns SessionBuilder

payment

Returns

Parameters

paymentAmount: number

gasPriceTolerance: number = 1

Returns SessionBuilder

runtimeArgs

Returns

Parameters

args: Args

Returns SessionBuilder

timestamp

Returns

Parameters

timestamp: Timestamp

Returns SessionBuilder

ttl

Returns

Parameters

ttl: number

`Protected` _chainName

`Protected` _contractHash

`Protected` _entryPoint

`Protected` _initiatorAddr

`Protected` _invocationTarget

`Private` _isInstallOrUpgrade

`Protected` _pricingMode

`Protected` _runtimeArgs

`Protected` _scheduling

`Protected` _timestamp

`Protected` _ttl

`Protected` _getDefaultDeployHeader

`Protected` _getStandardPayment