Module

rpc

Classes

Server

Members

'temporary' | 'persistent'

# static Durability

Specifies the durability namespace of contract-related ledger entries.

See:

View Source lib/rpc/server.js, line 37

Methods

# static assembleTransaction(raw, simulation) → {TransactionBuilder}

Combines the given raw transaction alongside the simulation results. If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

Parameters:
Name Type Description
raw Transaction | FeeBumpTransaction

the initial transaction, w/o simulation applied

simulation Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the Soroban RPC simulation result (see module:rpc.Server#simulateTransaction)

See:

View Source lib/rpc/transaction.js, line 42

a new, cloned transaction with the proper auth and resource (fee, footprint) simulation data applied

# static parseRawEvents(raw) → {Api.GetEventsResponse}

Parse and return the retrieved events, if any, from a raw response from a Soroban RPC server.

Parameters:
Name Type Description
raw Api.RawGetEventsResponse

the raw getEvents response from the Soroban RPC server to parse

View Source lib/rpc/parsers.js, line 75

events parsed from the Soroban RPC server's response

Api.GetEventsResponse

# static parseRawSimulation(sim) → {Api.SimulateTransactionResponse}

Converts a raw response schema into one with parsed XDR fields and a simplified interface.

Parameters:
Name Type Description
sim Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the raw response schema (parsed ones are allowed, best-effort detected, and returned untouched)

View Source lib/rpc/parsers.js, line 184

the original parameter (if already parsed), parsed otherwise

Api.SimulateTransactionResponse

Classes

Server

Members

'temporary' | 'persistent'

# static Durability

Specifies the durability namespace of contract-related ledger entries.

See:

View Source lib/rpc/server.js, line 37

Methods

# static assembleTransaction(raw, simulation) → {TransactionBuilder}

Combines the given raw transaction alongside the simulation results. If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

Parameters:
Name Type Description
raw Transaction | FeeBumpTransaction

the initial transaction, w/o simulation applied

simulation Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the Soroban RPC simulation result (see module:rpc.Server#simulateTransaction)

See:

View Source lib/rpc/transaction.js, line 42

a new, cloned transaction with the proper auth and resource (fee, footprint) simulation data applied

# static parseRawEvents(raw) → {Api.GetEventsResponse}

Parse and return the retrieved events, if any, from a raw response from a Soroban RPC server.

Parameters:
Name Type Description
raw Api.RawGetEventsResponse

the raw getEvents response from the Soroban RPC server to parse

View Source lib/rpc/parsers.js, line 75

events parsed from the Soroban RPC server's response

Api.GetEventsResponse

# static parseRawSimulation(sim) → {Api.SimulateTransactionResponse}

Converts a raw response schema into one with parsed XDR fields and a simplified interface.

Parameters:
Name Type Description
sim Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the raw response schema (parsed ones are allowed, best-effort detected, and returned untouched)

View Source lib/rpc/parsers.js, line 184

the original parameter (if already parsed), parsed otherwise

Api.SimulateTransactionResponse

Classes

Server

Members

'temporary' | 'persistent'

# static Durability

Specifies the durability namespace of contract-related ledger entries.

See:

View Source lib/rpc/server.js, line 37

Methods

# static assembleTransaction(raw, simulation) → {TransactionBuilder}

Combines the given raw transaction alongside the simulation results. If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

Parameters:
Name Type Description
raw Transaction | FeeBumpTransaction

the initial transaction, w/o simulation applied

simulation Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the Soroban RPC simulation result (see module:rpc.Server#simulateTransaction)

See:

View Source lib/rpc/transaction.js, line 42

a new, cloned transaction with the proper auth and resource (fee, footprint) simulation data applied

# static parseRawEvents(raw) → {Api.GetEventsResponse}

Parse and return the retrieved events, if any, from a raw response from a Soroban RPC server.

Parameters:
Name Type Description
raw Api.RawGetEventsResponse

the raw getEvents response from the Soroban RPC server to parse

View Source lib/rpc/parsers.js, line 75

events parsed from the Soroban RPC server's response

Api.GetEventsResponse

# static parseRawSimulation(sim) → {Api.SimulateTransactionResponse}

Converts a raw response schema into one with parsed XDR fields and a simplified interface.

Parameters:
Name Type Description
sim Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the raw response schema (parsed ones are allowed, best-effort detected, and returned untouched)

View Source lib/rpc/parsers.js, line 184

the original parameter (if already parsed), parsed otherwise

Api.SimulateTransactionResponse

Classes

Server

Members

'temporary' | 'persistent'

# static Durability

Specifies the durability namespace of contract-related ledger entries.

See:

View Source lib/rpc/server.js, line 37

Methods

# static assembleTransaction(raw, simulation) → {TransactionBuilder}

Combines the given raw transaction alongside the simulation results. If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

Parameters:
Name Type Description
raw Transaction | FeeBumpTransaction

the initial transaction, w/o simulation applied

simulation Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the Soroban RPC simulation result (see module:rpc.Server#simulateTransaction)

See:

View Source lib/rpc/transaction.js, line 42

a new, cloned transaction with the proper auth and resource (fee, footprint) simulation data applied

# static parseRawEvents(raw) → {Api.GetEventsResponse}

Parse and return the retrieved events, if any, from a raw response from a Soroban RPC server.

Parameters:
Name Type Description
raw Api.RawGetEventsResponse

the raw getEvents response from the Soroban RPC server to parse

View Source lib/rpc/parsers.js, line 75

events parsed from the Soroban RPC server's response

Api.GetEventsResponse

# static parseRawSimulation(sim) → {Api.SimulateTransactionResponse}

Converts a raw response schema into one with parsed XDR fields and a simplified interface.

Parameters:
Name Type Description
sim Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the raw response schema (parsed ones are allowed, best-effort detected, and returned untouched)

View Source lib/rpc/parsers.js, line 184

the original parameter (if already parsed), parsed otherwise

Api.SimulateTransactionResponse

Classes

Server

Members

'temporary' | 'persistent'

# static Durability

Specifies the durability namespace of contract-related ledger entries.

See:

View Source lib/rpc/server.js, line 37

Methods

# static assembleTransaction(raw, simulation) → {TransactionBuilder}

Combines the given raw transaction alongside the simulation results. If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

If the given transaction already has authorization entries in a host function invocation (see Operation.invokeHostFunction), the simulation entries are ignored.

Parameters:
Name Type Description
raw Transaction | FeeBumpTransaction

the initial transaction, w/o simulation applied

simulation Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the Soroban RPC simulation result (see module:rpc.Server#simulateTransaction)

See:

View Source lib/rpc/transaction.js, line 42

a new, cloned transaction with the proper auth and resource (fee, footprint) simulation data applied

# static parseRawEvents(raw) → {Api.GetEventsResponse}

Parse and return the retrieved events, if any, from a raw response from a Soroban RPC server.

Parameters:
Name Type Description
raw Api.RawGetEventsResponse

the raw getEvents response from the Soroban RPC server to parse

View Source lib/rpc/parsers.js, line 75

events parsed from the Soroban RPC server's response

Api.GetEventsResponse

# static parseRawSimulation(sim) → {Api.SimulateTransactionResponse}

Converts a raw response schema into one with parsed XDR fields and a simplified interface.

Parameters:
Name Type Description
sim Api.SimulateTransactionResponse | Api.RawSimulateTransactionResponse

the raw response schema (parsed ones are allowed, best-effort detected, and returned untouched)

View Source lib/rpc/parsers.js, line 184

the original parameter (if already parsed), parsed otherwise

Api.SimulateTransactionResponse