Class State

State class responsible for managing the state of the XO Engine.

Manages the state of the templates, invitations, script hashes, unspent outputs, and events.
Interacts with remote servers to sync the state and maintain consistency.
Manages blockchain and invitation state and events.

Example

import { createStorageAdapter, StorageType, State } from '@xo-cash/state';

// Create storage
const storage = await createStorageAdapter({
  storageType: StorageType.INDEXEDDB,
  databasePath: './',
  databaseFilename: 'XO',
});

// Create state
const state = new State(storage);

// Use state
await state.storeTemplate(template);
const retrievedTemplate = await state.getTemplate('template-identifier');

Index

Constructors

constructor

Methods

deleteUnspentOutputData executeBulkUnspentOutputReservation getInvitation getLastDerivativeIndexForP2PKH getScriptHashData getTemplate getUnspentOutputData listEventsData listScriptHashData listTemplates listUnspentOutputsData storeEvent storeInvitation storeScriptHashData storeTemplate storeUnspentOutputData updateUnspentOutputDataStatus

Constructors

constructor

new State(storage: XOStorage): State
Creates a new State instance.
Parameters
- storage: XOStorage
  The storage adapter
Returns State
- Defined in source/state.ts:46

Methods

deleteUnspentOutputData

deleteUnspentOutputData(
outpointTransactionHash: string,
outpointIndex: number,
): Promise<void>
Deletes unspent output data from the state.
Parameters
- outpointTransactionHash: string
  The transaction hash of the outpoint
- outpointIndex: number
  The index of the outpoint
Returns Promise<void>
Promise that resolves when the unspent output data is deleted
- Defined in source/state.ts:244

executeBulkUnspentOutputReservation

executeBulkUnspentOutputReservation(
    outpoints: { outpointIndex: number; outpointTransactionHash: string }[],
    shouldBeReserved: boolean,
    invitationIdentifier: string,
): Promise<void>
Sets the reservation status of an unspent output for a specific invitation.
Parameters
- outpoints: { outpointIndex: number; outpointTransactionHash: string }[]
  The outpoints to reserve
- shouldBeReserved: boolean
  Whether the output should be reserved
- invitationIdentifier: string
  The invitation identifier to associate with the reservation
Returns Promise<void>
Promise that resolves when the output reservation status is set

Throws
if the output doesn't exist

Throws
if the output is already reserved by another invitation
- Defined in source/state.ts:229

getInvitation

getInvitation(invitationIdentifier: string): Promise<StoredInvitation>
Retrieves an invitation from the state by its identifier.
Parameters
- invitationIdentifier: string
  Identifier for the invitation
Returns Promise<StoredInvitation>
Promise resolving to the stored invitation data, or undefined if not found
- Defined in source/state.ts:64

getLastDerivativeIndexForP2PKH

getLastDerivativeIndexForP2PKH(
    templateIdentifier: string,
    outputIdentifier: string,
    invitationIdentifier?: string,
): Promise<string>
TODO: This needs a different implementation, this function is focused on p2pkh.

Gets the last derivative index used for standard locking bytecodes. Filters by templateIdentifier and outputIdentifier, and optionally by invitationIdentifier.
Parameters
- templateIdentifier: string
  The template identifier to filter by
- outputIdentifier: string
  The output identifier to filter by
- OptionalinvitationIdentifier: string
  Optional invitation identifier to filter by (if provided, only looks at locking bytecodes for that invitation)
Returns Promise<string>
Promise resolving to the last derivative index as a string, or null if none found
- Defined in source/state.ts:90

getScriptHashData

getScriptHashData(scriptHash: string): Promise<ScriptHashData>
Retrieves script hash data from the state by its script hash.
Parameters
- scriptHash: string
  The script hash to look up
Returns Promise<ScriptHashData>
Promise resolving to the script hash data, or undefined if not found
- Defined in source/state.ts:74

getTemplate

getTemplate(templateIdentifier: string): Promise<XOTemplate>
Retrieves a template from the state by its identifier.
Parameters
- templateIdentifier: string
  Identifier for the template
Returns Promise<XOTemplate>
Promise resolving to the template data, or undefined if not found
- Defined in source/state.ts:54

getUnspentOutputData

getUnspentOutputData(
outpointTransactionHash: string,
outpointIndex: number,
): Promise<UnspentOutputData>
Retrieves unspent output data from the state.
Parameters
- outpointTransactionHash: string
  The transaction hash of the outpoint
- outpointIndex: number
  The index of the outpoint
Returns Promise<UnspentOutputData>
Promise resolving to the unspent output data, or undefined if not found
- Defined in source/state.ts:105

listEventsData

listEventsData(query: EventDataQuery): Promise<EventData[]>
Lists event data matching the provided query.
Parameters
- query: EventDataQuery
  Query to apply ( e.g. eventType)
Returns Promise<EventData[]>
Promise resolving to the matching event data

Throws
if the query contains no recognized field
- Defined in source/state.ts:202

listScriptHashData

listScriptHashData(query: ScriptHashDataQuery): Promise<ScriptHashData[]>
Lists script hash data matching the provided query.
Parameters
- query: ScriptHashDataQuery
  Query to apply (e.g. templateIdentifier, scriptHash, or invitationIdentifier)
Returns Promise<ScriptHashData[]>
Promise resolving to the matching script hash data

Throws
if the query contains no recognized field
- Defined in source/state.ts:179

listTemplates

listTemplates(): Promise<XOTemplate[]>
Lists all templates stored in the state.

Returns Promise<XOTemplate[]>
Promise resolving to an array of all templates
- Defined in source/state.ts:168

listUnspentOutputsData

listUnspentOutputsData(
query?: UnspentOutputDataQuery,
filter?: UnspentOutputDataFilter,
): Promise<UnspentOutputData[]>
Lists unspent output data matching the provided query and optional filter.
Parameters
- Optionalquery: UnspentOutputDataQuery
  Query to apply ( e.g. templateIdentifier, reservedBy, lockingBytecode, or status)
- Optionalfilter: UnspentOutputDataFilter
  Optional filter to apply ( e.g. reserved)
Returns Promise<UnspentOutputData[]>
Promise resolving to the matching unspent output data

Throws
if the query contains no recognized field
- Defined in source/state.ts:191

storeEvent

storeEvent(
    eventId: string,
    eventType: string,
    data: unknown,
    timestamp?: number,
): Promise<void>
Stores an event in the state.
Parameters
- eventId: string
  Identifier for the event
- eventType: string
  Type of the event
- data: unknown
  Event data
- Optionaltimestamp: number
  Optional timestamp
Returns Promise<void>
Promise that resolves when the event is stored
- Defined in source/state.ts:159

storeInvitation

storeInvitation(
invitationIdentifier: string,
invitation: StoredInvitation,
): Promise<void>
Stores an invitation in the state.
Parameters
- invitationIdentifier: string
  Identifier for the invitation
- invitation: StoredInvitation
  The invitation data to store
Returns Promise<void>
Promise that resolves when the invitation is stored
- Defined in source/state.ts:126

storeScriptHashData

storeScriptHashData(data: ScriptHashData): Promise<void>
Stores script hash data in the state.
Parameters
- data: ScriptHashData
  The script hash data to store
Returns Promise<void>
Promise that resolves when the script hash data is stored
- Defined in source/state.ts:136

storeTemplate

storeTemplate(template: XOTemplate): Promise<void>
Stores a template in the state.
Parameters
- template: XOTemplate
  The template data to store
Returns Promise<void>
Promise that resolves when the template is stored
- Defined in source/state.ts:115

storeUnspentOutputData

storeUnspentOutputData(data: UnspentOutputData): Promise<void>
Stores unspent output data in the state.
Parameters
- data: UnspentOutputData
  The unspent output data to store
Returns Promise<void>
Promise that resolves when the unspent output data is stored
- Defined in source/state.ts:146

updateUnspentOutputDataStatus

updateUnspentOutputDataStatus(
    outpointTransactionHash: string,
    outpointIndex: number,
    status: UnspentOutputStatus,
): Promise<void>
Updates the status of existing unspent output data in the state.
Parameters
- outpointTransactionHash: string
  The transaction hash of the outpoint
- outpointIndex: number
  The index of the outpoint
- status: UnspentOutputStatus
  The new status to set ('confirmed' or 'pending')
Returns Promise<void>
Promise that resolves when the status is updated

Throws
if the output doesn't exist
- Defined in source/state.ts:215

Class State

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns State

Methods

deleteUnspentOutputData

Parameters

Returns Promise<void>

executeBulkUnspentOutputReservation

Parameters

Returns Promise<void>

Throws

Throws

getInvitation

Parameters

Returns Promise<StoredInvitation>

getLastDerivativeIndexForP2PKH

Parameters

Returns Promise<string>

getScriptHashData

Parameters

Returns Promise<ScriptHashData>

getTemplate

Parameters

Returns Promise<XOTemplate>

getUnspentOutputData

Parameters

Returns Promise<UnspentOutputData>

listEventsData

Parameters

Returns Promise<EventData[]>

Throws

listScriptHashData

Parameters

Returns Promise<ScriptHashData[]>

Throws

listTemplates

Returns Promise<XOTemplate[]>

listUnspentOutputsData

Parameters

Returns Promise<UnspentOutputData[]>

Throws

storeEvent

Parameters

Returns Promise<void>

storeInvitation

Parameters

Returns Promise<void>

storeScriptHashData

Parameters

Returns Promise<void>

storeTemplate

Parameters

Returns Promise<void>

storeUnspentOutputData

Parameters

Returns Promise<void>

updateUnspentOutputDataStatus

Parameters

Returns Promise<void>

Throws

Settings

On This Page