Class ContractCallBuilder

Builder for creating Contract Call transactions. Enables calling entry points on deployed smart contracts. Supports multiple addressing modes: by hash, by name, by package hash, and by package name.

Example

const transaction = new ContractCallBuilder()
  .from(callerPublicKey)
  .byHash(contractHash)
  .entryPoint('transfer')
  .runtimeArgs(args)
  .chainName('casper')
  .payment(3_000_000_000)
  .build();

Hierarchy

TransactionBuilder<ContractCallBuilder>
- ContractCallBuilder

Constructors

constructor

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

Properties

`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 = ...

`Private` _transactionInvocationTarget

_transactionInvocationTarget: TransactionInvocationTarget

`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 Contract Call transaction for Casper 1.5. Uses the legacy deploy format for backward compatibility.

Returns
A Transaction object compatible with Casper 1.5

Throws
If entry point is not specified

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

byHash

byHash(contractHash: string): ContractCallBuilder
Sets the contract to call using its hash.

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

byName

byName(name: string): ContractCallBuilder
Sets the contract to call using its name.

Returns
The builder instance for method chaining
Parameters
- name: string
  
  The named key under which the contract is stored
Returns ContractCallBuilder
- Defined in src/types/TransactionBuilder.ts:1225

byPackageHash

byPackageHash(contractHash: string, version?: number, protocolVersionMajor?: null | number): ContractCallBuilder
Sets the contract to call using its package hash and optional version.

Returns
The builder instance for method chaining
Parameters
- contractHash: string
  
  The contract package hash in hexadecimal format
- Optional version: number
  
  Optional specific version of the contract to call
- protocolVersionMajor: null | number = null
  
  Optional protocol version major number
Returns ContractCallBuilder
- Defined in src/types/TransactionBuilder.ts:1246

byPackageName

byPackageName(name: string, version?: number, protocolVersionMajor?: null | number): ContractCallBuilder
Sets the contract to call using its package name and optional version.

Returns
The builder instance for method chaining
Parameters
- name: string
  
  The package name under which the contract is stored
- Optional version: number
  
  Optional specific version of the contract to call
- protocolVersionMajor: null | number = null
  
  Optional protocol version major number
Returns ContractCallBuilder
- Defined in src/types/TransactionBuilder.ts:1276

chainName

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

contractHash

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

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

entryPoint

entryPoint(name: string): ContractCallBuilder
Sets the entry point name to call on the contract.

Returns
The builder instance for method chaining
Parameters
- name: string
  
  The name of the contract entry point
Returns ContractCallBuilder
- Defined in src/types/TransactionBuilder.ts:1305

from

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

fromAccountHash

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

payment

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

runtimeArgs

runtimeArgs(args: Args): ContractCallBuilder
Sets the runtime arguments to pass to the contract entry point.

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

timestamp

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

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

ttl

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

Class ContractCallBuilder

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ContractCallBuilder

Properties

Protected _chainName

Protected _contractHash

Protected _entryPoint

Protected _initiatorAddr

Protected _invocationTarget

Protected _pricingMode

Protected _runtimeArgs

Protected _scheduling

Protected _timestamp

Private _transactionInvocationTarget

Protected _ttl

Methods

Protected _getDefaultDeployHeader

Returns

Returns DeployHeader

Protected _getStandardPayment

Returns

Throws

Returns ExecutableDeployItem

build

Returns

Returns Transaction

buildFor1_5

Returns

Throws

Returns Transaction

byHash

Returns

Parameters

contractHash: string

Returns ContractCallBuilder

byName

Returns

Parameters

name: string

Returns ContractCallBuilder

byPackageHash

Returns

Parameters

contractHash: string

Optional version: number

protocolVersionMajor: null | number = null

Returns ContractCallBuilder

byPackageName

Returns

Parameters

name: string

Optional version: number

protocolVersionMajor: null | number = null

Returns ContractCallBuilder

chainName

Returns

Parameters

chainName: string

Returns ContractCallBuilder

contractHash

Returns

Parameters

contractHash: string

Returns ContractCallBuilder

entryPoint

Returns

Parameters

name: string

Returns ContractCallBuilder

from

Returns

Parameters

publicKey: PublicKey

`Protected` _chainName

`Protected` _contractHash

`Protected` _entryPoint

`Protected` _initiatorAddr

`Protected` _invocationTarget

`Protected` _pricingMode

`Protected` _runtimeArgs

`Protected` _scheduling

`Protected` _timestamp

`Private` _transactionInvocationTarget

`Protected` _ttl

`Protected` _getDefaultDeployHeader

`Protected` _getStandardPayment

`Optional` version: number

`Optional` version: number