Class Template

Template class for accessing template data.

Index

Constructors

Methods

getActionOrThrow getFirstRoleOrThrow getLockingScriptForOutputOrThrow getLockingScriptIdentifierOrThrow getLockingScriptOrThrow getOutputOrThrow getRoleOrThrow getSecrets getStartingActions getTemplate getTransactionForActionOrThrow getTransactionOrThrow

Constructors

constructor

new Template(template: XOTemplate): Template
Creates a Template class from a template object.
Parameters
- template: XOTemplate
Returns Template
- Defined in source/utils/template.ts:32

Methods

getActionOrThrow

getActionOrThrow(actionIdentifier: string): XOTemplateAction
Retrieves an action definition by identifier.
Parameters
- actionIdentifier: string
  The identifier of the action.
Returns XOTemplateAction
Throws
If the action is not found.
- Defined in source/utils/template.ts:174

getFirstRoleOrThrow

getFirstRoleOrThrow(
lockingScriptIdentifier: string,
): [string, XOTemplateLockingScriptRole]
Retrieves the first available role in a locking script, or throws if none exist.
Parameters
- lockingScriptIdentifier: string
  The locking script identifier.
Returns [string, XOTemplateLockingScriptRole]
A tuple of [roleIdentifier, role].

Throws
If the locking script is not found.

Throws
If no roles exist.
- Defined in source/utils/template.ts:135

getLockingScriptForOutputOrThrow

getLockingScriptForOutputOrThrow(
outputIdentifier: string,
): XOTemplateLockingScript
Retrieves the locking script for a given output.
Parameters
- outputIdentifier: string
Returns XOTemplateLockingScript
Throws
If the output is not found.

Throws
If the output has no locking script reference.

Throws
If the locking script definition is not found.
- Defined in source/utils/template.ts:105

getLockingScriptIdentifierOrThrow

getLockingScriptIdentifierOrThrow(outputIdentifier: string): string
Retrieves the locking script identifier from an output.
Parameters
- outputIdentifier: string
Returns string
Throws
If the output is not found.

Throws
If the output has no locking script reference.
- Defined in source/utils/template.ts:73

getLockingScriptOrThrow

getLockingScriptOrThrow(
lockingScriptIdentifier: string,
): XOTemplateLockingScript
Retrieves a locking script definition by identifier.
Parameters
- lockingScriptIdentifier: string
Returns XOTemplateLockingScript
Throws
If the locking script is not found.
- Defined in source/utils/template.ts:86

getOutputOrThrow

getOutputOrThrow(outputIdentifier: string): XOTemplateOutput
Retrieves an output definition by identifier.
Parameters
- outputIdentifier: string
Returns XOTemplateOutput
Throws
If the output is not found.
- Defined in source/utils/template.ts:55

getRoleOrThrow

getRoleOrThrow(
lockingScriptIdentifier: string,
roleIdentifier: string,
): XOTemplateLockingScriptRole
Retrieves a role within a locking script.
Parameters
- lockingScriptIdentifier: string
  The locking script identifier.
- roleIdentifier: string
  The role identifier.
Returns XOTemplateLockingScriptRole
Throws
If the locking script is not found.

Throws
If the role is not found.
- Defined in source/utils/template.ts:118

getSecrets

getSecrets(lockingScriptIdentifier: string, roleIdentifier?: string): string[]
Retrieves secrets for a locking script. If roleIdentifier is provided, returns secrets from the role's state. Otherwise, returns secrets from the locking script itself.
Parameters
- lockingScriptIdentifier: string
  The locking script identifier.
- OptionalroleIdentifier: string
  The role identifier (optional, if not provided uses locking script secrets).
Returns string[]
Array of secret identifiers.

Throws
If the locking script is not found.

Throws
If roleIdentifier is provided but the role is not found.
- Defined in source/utils/template.ts:157

getStartingActions

getStartingActions(): XOTemplateActionIntent[]
Gets the starting actions for the template.

Returns XOTemplateActionIntent[]
The list of starting actions.
- Defined in source/utils/template.ts:47

getTemplate

getTemplate(): XOTemplate
Gets the underlying template object.

Returns XOTemplate
- Defined in source/utils/template.ts:39

getTransactionForActionOrThrow

getTransactionForActionOrThrow(actionIdentifier: string): XOTemplateTransaction
Retrieves the transaction for a given action.
Parameters
- actionIdentifier: string
  The identifier of the action.
Returns XOTemplateTransaction
Throws
If the action is not found.

Throws
If the action has no transaction defined or the transaction is not found.
- Defined in source/utils/template.ts:203

getTransactionOrThrow

getTransactionOrThrow(transactionIdentifier: string): XOTemplateTransaction
Retrieves a transaction definition by identifier.
Parameters
- transactionIdentifier: string
  The identifier of the transaction.
Returns XOTemplateTransaction
Throws
If the transaction is not found.
- Defined in source/utils/template.ts:188

Class Template

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Template

Methods

getActionOrThrow

Parameters

Returns XOTemplateAction

Throws

getFirstRoleOrThrow

Parameters

Returns [string, XOTemplateLockingScriptRole]

Throws

Throws

getLockingScriptForOutputOrThrow

Parameters

Returns XOTemplateLockingScript

Throws

Throws

Throws

getLockingScriptIdentifierOrThrow

Parameters

Returns string

Throws

Throws

getLockingScriptOrThrow

Parameters

Returns XOTemplateLockingScript

Throws

getOutputOrThrow

Parameters

Returns XOTemplateOutput

Throws

getRoleOrThrow

Parameters

Returns XOTemplateLockingScriptRole

Throws

Throws

getSecrets

Parameters

Returns string[]

Throws

Throws

getStartingActions

Returns XOTemplateActionIntent[]

getTemplate

Returns XOTemplate

getTransactionForActionOrThrow

Parameters

Returns XOTemplateTransaction

Throws

Throws

getTransactionOrThrow

Parameters

Returns XOTemplateTransaction

Throws

Settings

On This Page