@xo-cash/types 0.0.1 → 0.0.2-development.15414648562

package/dist/index.d.mts

@@ -1,213 +1,95 @@
 import { Input, Output } from "@bitauth/libauth";
 
-//#region source/invitation.d.ts
+//#region source/utilities.d.ts
 /**
- * The requirements for an invitation.
+ * Union of all property values in an object type.
+ *
+ * Use this to derive a string literal union from a runtime const object declared
+ * with `as const`.
+ *
+ * @example
+ * export const XOTemplateLockingTypes = {
+ *     P2S: 'p2s',
+ *     P2PKH: 'p2pkh',
+ *     P2SH: 'p2sh',
+ * } as const;
+ *
+ * export type XOTemplateLockingType = ValueOf<typeof XOTemplateLockingTypes>;
+ * // 'p2s' | 'p2pkh' | 'p2sh'
  */
-type XOInvitationRoleRequirement = {
-  variables?: string[];
-  inputs?: string[];
-  outputs?: string[];
-};
+type ValueOf<T> = T[keyof T];
+//#endregion
+//#region source/template.d.ts
 /**
- * The requirements for an invitation with a role.
+ * Type for satoshis.
  */
-type XOInvitationRequirements = XOInvitationRoleRequirement & {
-  roles?: Record<string, XOInvitationRoleRequirement>;
-};
+type Satoshis = bigint;
 /**
- * The value of a variable in an invitation.
+ * A fungible token amount.
  */
-type XOInvitationVariableValue = bigint | boolean | number | string;
+type FungibleTokenAmount = bigint;
 /**
- * A variable in an invitation.
+ * Values for BCH VM versions that an XO template can declare support for.
  */
-type XOInvitationVariable = {
-  /**
-   * The variable identifier for this variable.
-   */
-  variableIdentifier: string;
-  /**
-   * The value of this variable.
-   */
-  value: XOInvitationVariableValue;
-  /**
-   * The role identifier this variable belongs to.
-   */
-  roleIdentifier?: string;
+declare const BchVmVersions: {
+  readonly BCH_2020_05: "BCH_2020_05";
+  readonly BCH_2021_05: "BCH_2021_05";
+  readonly BCH_2022_05: "BCH_2022_05";
+  readonly BCH_2023_05: "BCH_2023_05";
+  readonly BCH_2024_05: "BCH_2024_05";
+  readonly BCH_2025_05: "BCH_2025_05";
+  readonly BCH_2026_05: "BCH_2026_05";
 };
 /**
- * A transaction input in an invitation.
+ * The set of BCH VM versions that an XO template can declare support for.
  */
-type XOInvitationInput = Partial<Input> & {
-  /**
-   * The input identifier for this input.
-   */
-  inputIdentifier?: string;
-  /**
-   * The position/index this input should occupy in the final transaction.
-   */
-  transactionIndex?: number;
-  /**
-   * The role identifier this input belongs to.
-   * If undefined, this is generic data applicable to the whole invitation.
-   */
-  roleIdentifier?: string;
-  /**
-   * The parent commit's item that this item extends.
-   */
-  mergesWith?: {
-    /**
-     * The commit identifier of the parent commit.
-     */
-    commitIdentifier: string;
-    /**
-     * The array index of the item in the parent commit's data array.
-     * 0-based index (0 = first item, 1 = second item, etc.)
-     */
-    index: number;
-  };
-};
+type BchVmVersion = ValueOf<typeof BchVmVersions>;
 /**
- * A transaction output in an invitation.
+ * Values for NFT capability on template token fields.
  */
-type XOInvitationOutput = Partial<Output> & {
-  /**
-   * The output identifier for this output.
-   */
-  outputIdentifier?: string;
-  /**
-   * The position/index this output should occupy in the final transaction.
-   */
-  transactionIndex?: number;
-  /**
-   * The secret identifier for this output.
-   */
-  secretIdentifier?: string;
-  /**
-   * The role identifier this output belongs to.
-   */
-  roleIdentifier?: string;
-  /**
-   * The parent commit's item that this item extends.
-   */
-  mergesWith?: {
-    /**
-     * The commit identifier of the parent commit.
-     */
-    commitIdentifier: string;
-    /**
-     * The array index of the item in the parent commit's data array.
-     * 0-based index (0 = first item, 1 = second item, etc.)
-     */
-    index: number;
-  };
+declare const XOTemplateNftCapabilities: {
+  readonly NONE: "none";
+  readonly MUTABLE: "mutable";
+  readonly MINTING: "minting";
 };
 /**
- * Represents a commit in the invitation.
+ * The capability of a non-fungible token.
+ * `minting` can create new NFTs of the same category.
+ * `mutable` can update its own commitment data.
+ * `none` means the commitment is immutable.
  */
-type XOInvitationCommit = {
-  /**
-   * The commit identifier for this commit.
-   */
-  commitIdentifier: string;
-  /**
-   * The identifier of the previous commit.
-   */
-  previousCommitIdentifier: string | undefined;
-  /**
-   * The entity identifier that made this commit.
-   */
-  entityIdentifier: string;
-  /**
-   * The data contributed by this commit.
-   */
-  data: {
-    /**
-     * The version of the transaction.
-     */
-    transactionVersion?: number;
-    /**
-     * The locktime for the transaction.
-     */
-    transactionLocktime?: number;
-    /**
-     * Variables provided in this commit.
-     */
-    variables?: XOInvitationVariable[];
-    /**
-     * Transaction inputs provided in this commit.
-     */
-    inputs?: XOInvitationInput[];
-    /**
-     * Transaction outputs provided in this commit.
-     */
-    outputs?: XOInvitationOutput[];
-  };
-  /**
-   * Signature of the entity committing this data.
-   */
-  signature: string;
-  /**
-   * Expiration timestamp for this specific commit.
-   */
-  expiresAtTimestamp: number;
-};
+type XOTemplateNftCapability = ValueOf<typeof XOTemplateNftCapabilities>;
 /**
- * An invitation to be shared among the participants using the xo stack.
+ * Values for XO template locking script types.
  */
-type XOInvitation = {
-  /**
-   * The invitation identifier for the invitation.
-   */
-  invitationIdentifier: string;
-  /**
-   * The timestamp when the invitation was created.
-   */
-  createdAtTimestamp: number;
-  /**
-   * The template identifier.
-   */
-  templateIdentifier: string;
-  /**
-   * The action identifier.
-   */
-  actionIdentifier: string;
-  /**
-   * The commits in the invitation.
-   */
-  commits: XOInvitationCommit[];
+declare const XOTemplateLockingTypes: {
+  readonly P2S: "p2s";
+  readonly P2PKH: "p2pkh";
+  readonly P2SH: "p2sh";
 };
-//#endregion
-//#region source/template.d.ts
 /**
- * Type for satoshis.
- */
-type Satoshis = bigint;
-/**
- * A fungible token amount.
- */
-type FungibleTokenAmount = bigint;
-/**
- * The set of BCH VM versions that an XO template can declare support for.
- */
-type BchVmVersion = 'BCH_2020_05' | 'BCH_2021_05' | 'BCH_2022_05' | 'BCH_2023_05' | 'BCH_2024_05' | 'BCH_2025_05' | 'BCH_2026_05';
-/**
- * The capability of a non-fungible token.
- * - `minting` — can create new NFTs of the same category.
- * - `mutable` — can update its own commitment data.
- * - `none` — commitment is immutable.
+ * The standard locking script types supported by XO.
+ *
  */
-type XOTemplateNftCapability = 'minting' | 'mutable' | 'none';
+type XOTemplateLockingType = ValueOf<typeof XOTemplateLockingTypes>;
 /**
- * The standard locking script types supported on BCH and by XO.
+ * Values for primitive types declared in an XO template.
+ * Used by constants, variables, and data fields.
  */
-type XOTemplateLockingType = 'p2s' | 'p2pkh' | 'p2sh';
+declare const XOTemplatePrimitiveTypes: {
+  readonly BOOLEAN: "boolean";
+  readonly BYTES: "bytes";
+  readonly INTEGER: "integer";
+  readonly BIGINT: "bigint";
+  readonly STRING: "string";
+  readonly PRIVATE_KEY: "private_key";
+  readonly PUBLIC_KEY: "public_key";
+};
 /**
  * The primitive types that can be declared in an XO template.
  * Used by constants, variables, and data fields.
  */
-type XOTemplatePrimitiveType = 'boolean' | 'bytes' | 'integer' | 'bigint' | 'string' | 'private_key' | 'public_key';
+type XOTemplatePrimitiveType = ValueOf<typeof XOTemplatePrimitiveTypes>;
 /** Identifies a role defined in the template's roles. */
 type XOTemplateRoleIdentifier = string;
 /** Identifies an action defined in the template's actions. */
@@ -230,6 +112,8 @@ type XOTemplateConstantIdentifier = string;
 type XOTemplateDataIdentifier = string;
 /** Identifies a secret defined in a role or action's secrets list. */
 type XOTemplateSecretIdentifier = string;
+/** Identifier for an XO template. */
+type XOTemplateIdentifier = string;
 /**
  * Human-readable display properties shared by most template elements.
  */
@@ -243,7 +127,7 @@ type XOTemplateViewProperties = {
    */
   description: string;
   /**
-   * An optional icon identifier or URL for this element.
+   * An optional icon identifier.
    */
   icon?: string;
 };
@@ -254,10 +138,9 @@ type XOTemplateViewProperties = {
  */
 type XOTemplateIntent = {
   /**
-   * An optional reference to a target defined in a different template, enabling
-   * cross-template interaction.
+   * Optional identifier for the template used in this intent. If not provided, uses the current template.
    */
-  templateIdentifier?: string;
+  templateIdentifier?: XOTemplateIdentifier;
   /**
    * Identifiers for items to generate when this intent is resolved (e.g. keys or secrets).
    */
@@ -275,7 +158,7 @@ type XOTemplateIntent = {
    */
   secrets?: Array<Record<XOTemplateSecretIdentifier, unknown>>;
   /**
-   * The identifier for the intended role for this intent.
+   * Optional identifier for the role used in this intent.
    */
   role?: XOTemplateRoleIdentifier;
 };
@@ -367,7 +250,11 @@ type XOTemplateRoleSlot = {
  */
 type XOTemplateActionRequirements = {
   /**
-   * The participants for this action.
+   * List of variable identifiers required for this action.
+   */
+  variables?: Array<XOTemplateVariableIdentifier>;
+  /**
+   * The participants required for this action.
    */
   participants?: Array<XOTemplateRoleSlot>;
   /**
@@ -380,7 +267,7 @@ type XOTemplateActionRequirements = {
  */
 type XOTemplateAction = XOTemplateViewProperties & {
   /**
-   * The roles for this action.
+   * Specific context for each role participating in this action.
    */
   roles?: Record<XOTemplateRoleIdentifier, XOTemplateActionRole>;
   /**
@@ -428,9 +315,7 @@ type XOTemplateToken = {
    */
   category?: string;
   /**
-   * The amount of fungible tokens.
-   * - `bigint`: A specific token amount.
-   * - `string`: A CashASM expression that resolves to the amount.
+   * The amount of fungible tokens as a bigint, a CashASM expression resolving to a bigint, or null indicating no FT is present.
    */
   amount?: bigint | string | null;
   /**
@@ -460,8 +345,10 @@ type XOTemplateAssetAmounts = {
   /**
    * Whether a non-fungible token is present (0 for absent, 1 for present),
    * or a CashASM expression that evaluates to 0 or 1.
-   * - `true`: all, i.e. the entire amount
-   * - `0`: None, i.e. nothing in expected to be included
+   * - `true`: resolves to 1 if an NFT is present, or 0 if none is present. Use this when
+   *   the NFT is optional, to express that the NFT is estimated to be part of the balance
+   *   if present, or absent from it if not.
+   * - `0`: None, i.e. nothing is expected to be included
    * - `1`: present and complete, as value > 1 does not make sense for non-fungible tokens
    * - `string`: A CashASM expression that evaluates to 0 or 1.
    */
@@ -473,11 +360,11 @@ type XOTemplateAssetAmounts = {
  */
 type XOTemplateState = {
   /**
-   * List of variable identifiers tracked in state.
+   * List of variable identifiers to track in state.
    */
   variables?: Array<XOTemplateVariableIdentifier>;
   /**
-   * List of secret identifiers tracked in state.
+   * List of secret identifiers to track in state.
    */
   secrets?: Array<XOTemplateSecretIdentifier>;
 };
@@ -486,7 +373,7 @@ type XOTemplateState = {
  */
 type XOTemplateLockingScriptRole = Partial<XOTemplateViewProperties> & {
   /**
-   * State configuration for this role.
+   * List of items to track as state for this role.
    */
   state?: XOTemplateState;
   /**
@@ -494,11 +381,11 @@ type XOTemplateLockingScriptRole = Partial<XOTemplateViewProperties> & {
    */
   actions?: Array<XOTemplateActionIntent>;
   /**
-   * Balance configuration for this role. Partial — any subset of asset amounts may be specified.
+   * Estimated ownership in the optional set of asset amounts specified.
    */
   balance?: Partial<XOTemplateAssetAmounts>;
   /**
-   * Whether outputs locked to this script should be selectable for coin selection.
+   * Whether outputs locked to this script should be available for coin selection.
    */
   selectable?: boolean;
   /**
@@ -521,7 +408,7 @@ type XOTemplateLockingScript = XOTemplateViewProperties & {
    */
   lockingBytecode: string;
   /**
-   * The unlocking script bytecode.
+   * Optional default unlocking bytecode when used in automatic coin selection.
    */
   unlockingBytecode?: string;
   /**
@@ -529,15 +416,15 @@ type XOTemplateLockingScript = XOTemplateViewProperties & {
    */
   actions?: Array<XOTemplateActionIntent>;
   /**
-   * State configuration for this locking script.
+   * List of items to track as state for all participants.
    */
   state?: XOTemplateState;
   /**
-   * Balance configuration for this locking script. Partial — any subset of asset amounts may be specified.
+   * Estimated ownership in the optional set of asset amounts specified.
    */
   balance?: Partial<XOTemplateAssetAmounts>;
   /**
-   * Whether outputs locked to this script should be selectable for coin selection.
+   * Whether outputs locked to this script should be available for coin selection.
    */
   selectable?: boolean;
   /**
@@ -547,7 +434,7 @@ type XOTemplateLockingScript = XOTemplateViewProperties & {
    */
   privacy?: number | string;
   /**
-   * A map of roles defined for this locking script.
+   * Specific context for each role participating in this locking script.
    */
   roles?: Record<XOTemplateRoleIdentifier, XOTemplateLockingScriptRole>;
 };
@@ -572,11 +459,11 @@ type XOTemplateInput = XOTemplateViewProperties & {
    */
   sequenceNumber?: number | string;
   /**
-   * The unlocking script for this input.
+   * Identifier of the unlocking script to use for the UTXO provided for this input.
    */
   unlockingScript?: string;
   /**
-   * Omit amount change configuration for this input.
+   * Amount of change that should be omitted from the automatic change handling. WARNING: Setting this can result in loss of funds!
    */
   omitChangeAmounts?: XOTemplateAssetAmounts;
 };
@@ -588,7 +475,7 @@ type XOTemplateInput = XOTemplateViewProperties & {
  */
 type XOTemplateOutput = Omit<XOTemplateLockingScript, 'lockingType' | 'lockingBytecode' | 'unlockingBytecode'> & {
   /**
-   * The identifier of the locking script in template definition used by this output.
+   * Identifier of the locking script to use for this output.
    */
   lockingScript: XOTemplateLockingScriptIdentifier;
   /**
@@ -651,8 +538,10 @@ type XOTemplateTransaction = XOTemplateViewProperties & {
   version?: number;
   /**
    * The locktime for this transaction.
+   * - `number`: A specific locktime value.
+   * - `string`: A CashASM expression that resolves to the locktime.
    */
-  locktime?: number;
+  locktime?: number | string;
   /**
    * The inputs for this transaction.
    */
@@ -662,7 +551,7 @@ type XOTemplateTransaction = XOTemplateViewProperties & {
    */
   outputs: Array<XOTemplateTransactionOutput>;
   /**
-   * The roles required for this transaction.
+   * Specific context for each role participating in this transaction.
    */
   roles?: Record<XOTemplateRoleIdentifier, XOTemplateTransactionRoleData>;
   /**
@@ -740,7 +629,7 @@ type XOTemplateIcon = {
    */
   name: string;
   /**
-   * The identifier of the icon resource.
+   * The identifier of the icon.
    */
   hash: string;
 };
@@ -759,7 +648,7 @@ type XOTemplateResource = XOTemplateViewProperties & {
  */
 type XOTemplateDefaults = {
   /**
-   * The default change output intent applied when a transaction generates change.
+   * Instructions for how to construct automated change output.
    */
   change?: XOTemplateOutputIntent;
 };
@@ -773,7 +662,7 @@ type XOTemplate = XOTemplateViewProperties & {
    */
   $schema: string;
   /**
-   * A string identifying the format version of this template.
+   * A string identifying the version of this template.
    */
   version?: string;
   /**
@@ -789,7 +678,7 @@ type XOTemplate = XOTemplateViewProperties & {
    */
   roles: Record<XOTemplateRoleIdentifier, XOTemplateViewProperties>;
   /**
-   * A list of entry points defining which actions are available to each role at the start.
+   * A list of entry points defining which actions are available at the start.
    */
   start: Array<XOTemplateActionIntent>;
   /**
@@ -843,5 +732,566 @@ type XOTemplate = XOTemplateViewProperties & {
   scenarios?: unknown;
 };
 //#endregion
-export { BchVmVersion, FungibleTokenAmount, Satoshis, XOInvitation, XOInvitationCommit, XOInvitationInput, XOInvitationOutput, XOInvitationRequirements, XOInvitationRoleRequirement, XOInvitationVariable, XOInvitationVariableValue, XOTemplate, XOTemplateAction, XOTemplateActionIdentifier, XOTemplateActionIntent, XOTemplateActionRequirements, XOTemplateActionRole, XOTemplateActionRoleRequirements, XOTemplateAssetAmounts, XOTemplateConstant, XOTemplateConstantIdentifier, XOTemplateData, XOTemplateDataIdentifier, XOTemplateDefaults, XOTemplateIcon, XOTemplateImportDefaultValue, XOTemplateInput, XOTemplateInputIdentifier, XOTemplateIntent, XOTemplateLockingScript, XOTemplateLockingScriptIdentifier, XOTemplateLockingScriptIntent, XOTemplateLockingScriptRole, XOTemplateLockingType, XOTemplateNftCapability, XOTemplateNonFungibleTokenDetails, XOTemplateOutput, XOTemplateOutputIdentifier, XOTemplateOutputIntent, XOTemplatePrimitiveType, XOTemplateResource, XOTemplateRoleIdentifier, XOTemplateRoleSlot, XOTemplateRoleSlotsRequirements, XOTemplateScriptIdentifier, XOTemplateSecretIdentifier, XOTemplateState, XOTemplateToken, XOTemplateTransaction, XOTemplateTransactionIdentifier, XOTemplateTransactionInput, XOTemplateTransactionOutput, XOTemplateTransactionRoleData, XOTemplateVariable, XOTemplateVariableIdentifier, XOTemplateViewProperties };
+//#region source/invitation.d.ts
+/**
+ * Identifier for an XO invitation.
+ */
+type XOInvitationIdentifier = string;
+/**
+ * Commit Identifier within an invitation.
+ */
+type XOInvitationCommitIdentifier = string;
+/**
+ * Entity Identifier identifying an entity that signed an invitation commit.
+ */
+type XOInvitationEntityIdentifier = string;
+/**
+ * The position/index that the input should occupy in the final transaction structure produced by the invitation.
+ */
+type XOInvitationTransactionInputIndex = number;
+/**
+ * The position/index that the output should occupy in the final transaction structure produced by the invitation.
+ */
+type XOInvitationTransactionOutputIndex = number;
+/**
+ * Index of an item within a commit data array. Used in `mergesWith.itemIndex` to locate the referenced item.
+ */
+type XOInvitationCommitDataItemIndex = number;
+/**
+ * Signature of the entity producing a commit or result.
+ * - commit.signature: Signature of the entity that made the commit, including `data`, `createdAtTimestamp`, and optional `memo`.
+ * - result.createdBySignature: Signature of the entity that created the transaction before broadcasting or produced data.
+ * - result.broadcastedBySignature: Signature of the entity that broadcasted the transaction.
+ */
+type XOInvitationSignature = string;
+/**
+ * Timestamps in an invitation e.g.
+ * - createdAtTimestamp: When the invitation, commit, or result was created.
+ * - expiresAtTimestamp: When the commit expires.
+ * - broadcastedAtTimestamp: When the transaction was broadcasted.
+ */
+type XOInvitationTimestamp = number;
+/**
+ * The Hash of a Transaction.
+ */
+type XOInvitationTransactionHash = string;
+/**
+ * The transaction version in the final transaction structure produced by the invitation.
+ */
+type XOInvitationTransactionVersion = number;
+/**
+ * The transaction locktime in the final transaction structure produced by the invitation.
+ */
+type XOInvitationTransactionLocktime = number;
+/**
+ * Pair of template and action identifiers used to resolve a template action for an invitation commit.
+ *
+ * ```
+ * {
+ *   "invitationIdentifier": "...",
+ *   ...
+ *   "commits": [
+ *     {
+ *       "commitIdentifier": "...",
+ *       "actionReference": {
+ *         "templateIdentifier": "...",
+ *         "actionIdentifier": "..."
+ *       }  ← this type
+ *       ...
+ *     }
+ *     ...
+ *   ]
+ * }
+ * ```
+ */
+type XOInvitationActionReference = {
+  /**
+   * The template that defines the action.
+   */
+  templateIdentifier: XOTemplateIdentifier;
+  /**
+   * The action within that template.
+   */
+  actionIdentifier: XOTemplateActionIdentifier;
+};
+/**
+ * Reference to an item in an earlier commit that a variable, input, or output extends.
+ *
+ * ```
+ * {
+ *   "invitationIdentifier": "...",
+ *   ...
+ *   "commits": [
+ *     {
+ *       "commitIdentifier": "...",
+ *       "data": {
+ *         "variables|inputs|outputs": [
+ *           {
+ *             "mergesWith": {
+ *               "commitIdentifier": "...",
+ *               "itemIndex": 0
+ *             }  ← this type
+ *           }
+ *         ]
+ *       }
+ *       ...
+ *     }
+ *     ...
+ *   ]
+ * }
+ * ```
+ */
+type XOInvitationMergesWithReference = {
+  /**
+   * Identifier of the earlier commit that contains the item being extended.
+   */
+  commitIdentifier: XOInvitationCommitIdentifier;
+  /**
+   * Together with `commitIdentifier`, this identifies the exact item to extend when a later
+   * commit supplies information that was not added earlier. For example, when an input was
+   * already provided without `unlockingBytecode`, a follow up commit can add a new input
+   * entry with `mergesWith`, `itemIndex` and `unlockingBytecode`. The merger then uses this index to
+   * locate that earlier input and populate the missing field without replacing the commit.
+   *
+   * This variable is named 'item' because it's used with variables, inputs and outputs.
+   *
+   * Note: The index starts at 0 for the first item in the commit data array.
+   */
+  itemIndex: XOInvitationCommitDataItemIndex;
+};
+/**
+ * The requirements for an invitation.
+ */
+type XOInvitationRoleRequirement = {
+  variables?: XOInvitationVariable[];
+  inputs?: XOInvitationInput[];
+  outputs?: XOInvitationOutput[];
+};
+/**
+ * The requirements for an invitation with a role.
+ */
+type XOInvitationRequirements = XOInvitationRoleRequirement & {
+  roles?: Record<XOTemplateRoleIdentifier, XOInvitationRoleRequirement>;
+};
+/**
+ * The value of a variable in an invitation.
+ */
+type XOInvitationVariableValue = bigint | boolean | number | string;
+/**
+ * A variable provided in a commit.
+ *
+ * ```
+ * {
+ *   "invitationIdentifier": "...",
+ *   ...
+ *   "commits": [
+ *     {
+ *       "commitIdentifier": "...",
+ *       "data": {
+ *         "variables": [
+ *           {
+ *             "variableIdentifier": "...",
+ *             "value": "..."
+ *           }  ← this type
+ *         ]
+ *       }
+ *       ...
+ *     }
+ *     ...
+ *   ]
+ * }
+ * ```
+ */
+type XOInvitationVariable = {
+  /**
+   * The identifier of this variable.
+   */
+  variableIdentifier: XOTemplateVariableIdentifier;
+  /**
+   * The value of this variable.
+   */
+  value: XOInvitationVariableValue;
+  /**
+   * The role identifier this variable belongs to.
+   */
+  roleIdentifier?: XOTemplateRoleIdentifier;
+  /**
+   * Reference to a variable in an earlier commit that this variable extends.
+   */
+  mergesWith?: XOInvitationMergesWithReference;
+};
+/**
+ * A transaction input provided in a commit.
+ *
+ * ```
+ * {
+ *   "invitationIdentifier": "...",
+ *   ...
+ *   "commits": [
+ *     {
+ *       "commitIdentifier": "...",
+ *       "data": {
+ *         "inputs": [
+ *           {
+ *             "inputIdentifier": "...",
+ *             "transactionIndex": 0
+ *           }  ← this type
+ *         ]
+ *       }
+ *       ...
+ *     }
+ *     ...
+ *   ]
+ * }
+ * ```
+ */
+type XOInvitationInput = Partial<Input> & {
+  /**
+   * The identifier of this input.
+   */
+  inputIdentifier?: XOTemplateInputIdentifier;
+  /**
+   * The position/index this input should occupy in the final transaction.
+   */
+  transactionIndex?: XOInvitationTransactionInputIndex;
+  /**
+   * The role identifier this input belongs to.
+   * If undefined, this is generic data applicable to the whole invitation.
+   */
+  roleIdentifier?: XOTemplateRoleIdentifier;
+  /**
+   * Reference to an input in an earlier commit that this input extends.
+   */
+  mergesWith?: XOInvitationMergesWithReference;
+};
+/**
+ * A transaction output provided in a commit.
+ *
+ * ```
+ * {
+ *   "invitationIdentifier": "...",
+ *   ...
+ *   "commits": [
+ *     {
+ *       "commitIdentifier": "...",
+ *       "data": {
+ *         "outputs": [
+ *           {
+ *             "outputIdentifier": "...",
+ *             "transactionIndex": 0
+ *           }  ← this type
+ *         ]
+ *       }
+ *       ...
+ *     }
+ *     ...
+ *   ]
+ * }
+ * ```
+ */
+type XOInvitationOutput = Partial<Output> & {
+  /**
+   * The identifier of this output.
+   */
+  outputIdentifier?: XOTemplateOutputIdentifier;
+  /**
+   * The position/index this output should occupy in the final transaction.
+   */
+  transactionIndex?: XOInvitationTransactionOutputIndex;
+  /**
+   * The secret identifier of this output.
+   */
+  secretIdentifier?: XOTemplateSecretIdentifier;
+  /**
+   * The role identifier this output belongs to.
+   */
+  roleIdentifier?: XOTemplateRoleIdentifier;
+  /**
+   * Reference to an output in an earlier commit that this output extends.
+   */
+  mergesWith?: XOInvitationMergesWithReference;
+};
+/**
+ * Payload provided by a single invitation commit.
+ *
+ * ```
+ * {
+ *   "invitationIdentifier": "...",
+ *   ...
+ *   "commits": [
+ *     {
+ *       "commitIdentifier": "...",
+ *       "data": { }  ← this type
+ *       ...
+ *     }
+ *     ...
+ *   ]
+ * }
+ * ```
+ */
+type XOInvitationCommitData = {
+  /**
+   * The version of the transaction.
+   */
+  transactionVersion?: XOInvitationTransactionVersion;
+  /**
+   * The locktime for the transaction.
+   */
+  transactionLocktime?: XOInvitationTransactionLocktime;
+  /**
+   * Variables provided in this commit.
+   */
+  variables?: XOInvitationVariable[];
+  /**
+   * Transaction inputs provided in this commit.
+   */
+  inputs?: XOInvitationInput[];
+  /**
+   * Transaction outputs provided in this commit.
+   */
+  outputs?: XOInvitationOutput[];
+};
+/**
+ * Human readable note attached to a commit so participants can coordinate better or just general notes.
+ *
+ * Note: When present, the engine includes the memo in the commit signing payload so peers can trust the text.
+ */
+type XOInvitationMemo = string;
+/**
+ * A signed commit in an invitation history chain.
+ *
+ * ```
+ * {
+ *   "invitationIdentifier": "...",
+ *   ...
+ *   "commits": [
+ *     {
+ *       "commitIdentifier": "...",
+ *       "createdAtTimestamp": 1717000000000,
+ *       "memo": "Invoice 1042",
+ *       ...
+ *     }  ← this type
+ *     ...
+ *   ]
+ * }
+ * ```
+ */
+type XOInvitationCommit = {
+  /**
+   * The commit identifier for this commit.
+   */
+  commitIdentifier: XOInvitationCommitIdentifier;
+  /**
+   * The identifier of the previous commit.
+   */
+  previousCommitIdentifier: XOInvitationCommitIdentifier | undefined;
+  /**
+   * The entity identifier that made this commit.
+   */
+  entityIdentifier: XOInvitationEntityIdentifier;
+  /**
+   * When this commit was created.
+   */
+  createdAtTimestamp: XOInvitationTimestamp;
+  /**
+   * When set, the engine resolves the template action from these identifiers for this commit.
+   * When omitted, it uses the invitation root `templateIdentifier` and `actionIdentifier`.
+   */
+  actionReference?: XOInvitationActionReference;
+  /**
+   * The data provided by this commit.
+   */
+  data: XOInvitationCommitData;
+  /**
+   * Signature of the entity committing this data.
+   */
+  signature: XOInvitationSignature;
+  /**
+   * Expiration timestamp for this specific commit.
+   */
+  expiresAtTimestamp: XOInvitationTimestamp;
+  /**
+   * Optional note from the entity.
+   */
+  memo?: XOInvitationMemo;
+};
+/**
+ * Core transaction result fields that are always present, regardless of whether the transaction has been broadcasted.
+ */
+type XOInvitationTransactionResultBase = {
+  /**
+   * Transaction hash of the resulting transaction.
+   */
+  transactionHash: XOInvitationTransactionHash;
+  /**
+   * Timestamp when the transaction was created i.e. before broadcasting.
+   */
+  createdAtTimestamp: XOInvitationTimestamp;
+  /**
+   * The entity identifier that created the transaction i.e. before broadcasting.
+   */
+  createdByEntityIdentifier: XOInvitationEntityIdentifier;
+  /**
+   * Signature of the entity that created the transaction i.e. before broadcasting.
+   *
+   * Note: The signature should cover the transaction data, entity details and the timestamp.
+   */
+  createdBySignature: XOInvitationSignature;
+};
+/**
+ * The broadcast fields added once the transaction has been submitted to the network.
+ */
+type XOInvitationTransactionBroadcastDetails = {
+  /**
+   * Timestamp when the transaction was broadcasted.
+   */
+  broadcastedAtTimestamp: XOInvitationTimestamp;
+  /**
+   * The entity identifier that broadcasted the transaction.
+   */
+  broadcastedByEntityIdentifier: XOInvitationEntityIdentifier;
+  /**
+   * Signature of the entity that broadcasted the transaction.
+   *
+   * Note: The signature should cover the transaction data, the timestamp, entity details that created the transaction
+   * and the entity details that broadcasts the transaction.
+   */
+  broadcastedBySignature: XOInvitationSignature;
+};
+/**
+ * Result for a completed invitation process that resulted in a transaction.
+ *
+ * ```
+ * {
+ *   "transactions": {
+ *     "requestSatoshisTransaction": {
+ *       "transactionHash": "..."
+ *     }  ← this type
+ *   }
+ * }
+ * ```
+ *
+ * Note: The broadcast fields are either all present or all absent.
+ */
+type XOInvitationTransactionResult = XOInvitationTransactionResultBase | (XOInvitationTransactionResultBase & XOInvitationTransactionBroadcastDetails);
+/**
+ * Result for a completed invitation process that resulted in a data field.
+ *
+ * ```
+ * {
+ *   "data": {
+ *     "messageSignature": {
+ *       "value": "..."
+ *     }  ← this type
+ *   }
+ * }
+ * ```
+ */
+type XOInvitationDataResult = {
+  /**
+   * Resolved value for the data.
+   */
+  value: XOInvitationVariableValue;
+  /**
+   * Timestamp when the data was created.
+   */
+  createdAtTimestamp: XOInvitationTimestamp;
+  /**
+   * The entity identifier that created this data.
+   */
+  createdByEntityIdentifier: XOInvitationEntityIdentifier;
+  /**
+   * Signature of the entity that created this data.
+   */
+  createdBySignature: XOInvitationSignature;
+};
+/**
+ * Result of a completed invitation. An invitation may produce one or more transactions or data fields.
+ *
+ * ```
+ * {
+ *   "invitationIdentifier": "...",
+ *   ...
+ *   "result": {
+ *     "transactions": {
+ *       "requestSatoshisTransaction": {
+ *         "transactionHash": "...",
+ *         "transactionHex": "..."
+ *       },
+ *     },
+ *     "data": {
+ *       "messageSignature": {
+ *         "value": "..."
+ *       }
+ *     }
+ *   }  ← this type
+ * }
+ * ```
+ */
+type XOInvitationResult = {
+  /**
+   * Transactions resulting from the invitation process.
+   *
+   * Note: The existing workflow does not support multiple transactions, but this structure already supports it.
+   */
+  transactions?: Record<XOTemplateTransactionIdentifier, XOInvitationTransactionResult>;
+  /**
+   * Data resulting from the invitation process.
+   */
+  data?: Record<XOTemplateDataIdentifier, XOInvitationDataResult>;
+};
+/**
+ * An invitation shared among participants in the XO stack.
+ *
+ * ```
+ * {
+ *   "invitationIdentifier": "...",
+ *   "templateIdentifier": "...",
+ *   "actionIdentifier": "...",
+ *   ...
+ *   "commits": [
+ *     {
+ *       "commitIdentifier": "...",
+ *       ...
+ *     },
+ *     {
+ *       "commitIdentifier": "...",
+ *       ...
+ *     }
+ *   ],
+ *   "result": {
+ *     "transactions": { },
+ *     "data": { }
+ *   }
+ * }  ← this type
+ * ```
+ */
+type XOInvitation = {
+  /**
+   * The invitation identifier for the invitation.
+   */
+  invitationIdentifier: XOInvitationIdentifier;
+  /**
+   * The timestamp when the invitation was created.
+   */
+  createdAtTimestamp: XOInvitationTimestamp;
+  /**
+   * The template identifier.
+   */
+  templateIdentifier: XOTemplateIdentifier;
+  /**
+   * The action identifier.
+   */
+  actionIdentifier: XOTemplateActionIdentifier;
+  /**
+   * The commits in the invitation.
+   */
+  commits: XOInvitationCommit[];
+  /**
+   * Result of the invitation process
+   */
+  result?: XOInvitationResult;
+};
+//#endregion
+export { BchVmVersion, BchVmVersions, FungibleTokenAmount, Satoshis, ValueOf, XOInvitation, XOInvitationActionReference, XOInvitationCommit, XOInvitationCommitData, XOInvitationCommitDataItemIndex, XOInvitationCommitIdentifier, XOInvitationDataResult, XOInvitationEntityIdentifier, XOInvitationIdentifier, XOInvitationInput, XOInvitationMemo, XOInvitationMergesWithReference, XOInvitationOutput, XOInvitationRequirements, XOInvitationResult, XOInvitationRoleRequirement, XOInvitationSignature, XOInvitationTimestamp, XOInvitationTransactionBroadcastDetails, XOInvitationTransactionHash, XOInvitationTransactionInputIndex, XOInvitationTransactionLocktime, XOInvitationTransactionOutputIndex, XOInvitationTransactionResult, XOInvitationTransactionVersion, XOInvitationVariable, XOInvitationVariableValue, XOTemplate, XOTemplateAction, XOTemplateActionIdentifier, XOTemplateActionIntent, XOTemplateActionRequirements, XOTemplateActionRole, XOTemplateActionRoleRequirements, XOTemplateAssetAmounts, XOTemplateConstant, XOTemplateConstantIdentifier, XOTemplateData, XOTemplateDataIdentifier, XOTemplateDefaults, XOTemplateIcon, XOTemplateIdentifier, XOTemplateImportDefaultValue, XOTemplateInput, XOTemplateInputIdentifier, XOTemplateIntent, XOTemplateLockingScript, XOTemplateLockingScriptIdentifier, XOTemplateLockingScriptIntent, XOTemplateLockingScriptRole, XOTemplateLockingType, XOTemplateLockingTypes, XOTemplateNftCapabilities, XOTemplateNftCapability, XOTemplateNonFungibleTokenDetails, XOTemplateOutput, XOTemplateOutputIdentifier, XOTemplateOutputIntent, XOTemplatePrimitiveType, XOTemplatePrimitiveTypes, XOTemplateResource, XOTemplateRoleIdentifier, XOTemplateRoleSlot, XOTemplateRoleSlotsRequirements, XOTemplateScriptIdentifier, XOTemplateSecretIdentifier, XOTemplateState, XOTemplateToken, XOTemplateTransaction, XOTemplateTransactionIdentifier, XOTemplateTransactionInput, XOTemplateTransactionOutput, XOTemplateTransactionRoleData, XOTemplateVariable, XOTemplateVariableIdentifier, XOTemplateViewProperties };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../source/invitation.ts","../source/template.ts"],"mappings":";;;;;AAKA;KAAY,2BAAA;EACR,SAAA;EACA,MAAA;EACA,OAAA;AAAA;;;;KAMQ,wBAAA,GAA2B,2BAAA;EACnC,KAAA,GAAQ,MAAA,SAAe,2BAAA;AAAA;;;;KAMf,yBAAA;;;;KAKA,oBAAA;EAXe;;;EAgBvB,kBAAA;EAViC;;;EAejC,KAAA,EAAO,yBAAA;EAVC;;;EAeR,cAAA;AAAA;;;;KAMQ,iBAAA,GAAoB,OAAA,CAAQ,KAAA;EANtB;AAMlB;;EAKI,eAAA;EALmC;;;EAUnC,gBAAA;EAAA;;;;EAMA,cAAA;EAgBS;;AAOb;EAlBI,UAAA;IAkBqC;;;IAbjC,gBAAA;IAkBJ;;;;IAZI,KAAA;EAAA;AAAA;;;AAkDR;KA3CY,kBAAA,GAAqB,OAAA,CAAQ,MAAA;;;;EAKrC,gBAAA;EAmFgC;;;EA9EhC,gBAAA;EAgDA;;;EA3CA,gBAAA;EA+DI;;;EA1DJ,cAAA;EAoEI;;;EA/DJ,UAAA;IA0EkB;;AAMtB;IA3EQ,gBAAA;IAoGK;;;;IA9FL,KAAA;EAAA;AAAA;;;;KAOI,kBAAA;;;AC1HZ;ED+HI,gBAAA;;;;EAKA,wBAAA;EC/H2B;;;EDoI3B,gBAAA;EC/HQ;;;EDoIR,IAAA;ICpIoB;AAQxB;;IDiIQ,kBAAA;ICjI2B;;AAKnC;IDiIQ,mBAAA;ICjIyB;;;IDsIzB,SAAA,GAAY,oBAAA;IChIe;;;IDqI3B,MAAA,GAAS,iBAAA;IC9HL;;;IDmIJ,OAAA,GAAU,kBAAA;EAAA;EChIN;;;EDsIR,SAAA;ECtIkC;AAGtC;;EDwII,kBAAA;AAAA;;ACrIJ;;KD2IY,YAAA;EC3I0B;;AAGtC;ED6II,oBAAA;;;;EAKA,kBAAA;EC/IkC;;;EDoJlC,kBAAA;ECjJQ;;;EDsJR,gBAAA;ECtJuC;AAG3C;;EDwJI,OAAA,EAAS,kBAAA;AAAA;;;;;;KCjND,QAAA;;;;KAKA,mBAAA;;;;KAKA,YAAA;ADHZ;;;;;;AAAA,KCWY,uBAAA;;;;KAKA,qBAAA;;;;ADTZ;KCeY,uBAAA;;KAOA,wBAAA;;KAGA,0BAAA;;KAGA,yBAAA;;KAGA,0BAAA;;KAGA,iCAAA;;KAGA,0BAAA;;KAGA,+BAAA;;KAGA,4BAAA;;KAGA,4BAAA;;KAGA,wBAAA;;KAGA,0BAAA;;;;KASA,wBAAA;EDHC;AAOb;;ECCI,IAAA;EDDoC;;;ECMpC,WAAA;EDIA;;;ECCA,IAAA;AAAA;;;;ADgCJ;;KCpBY,gBAAA;EDuDQ;;;;ECjDhB,kBAAA;EDmBA;;;ECdA,QAAA,GAAW,KAAA;EDkCP;;;EC7BJ,SAAA,GAAY,KAAA,CAAM,MAAA,CAAO,4BAAA;ED4CrB;;;ECvCJ,SAAA,GAAY,KAAA,CAAM,MAAA,CAAO,4BAAA;EDkDzB;;;EC7CA,OAAA,GAAU,KAAA,CAAM,MAAA,CAAO,0BAAA;EDwDf;;;ECnDR,IAAA,GAAO,wBAAA;AAAA;;;;KAMC,sBAAA,GAAyB,gBAAA;EDsExB;;;ECjET,MAAA,EAAQ,0BAAA;AAAA;;AAhJZ;;KAsJY,sBAAA,GAAyB,gBAAA;EAtJjB;;AAKpB;EAsJI,MAAA,EAAQ,0BAAA;AAAA;;;AAjJZ;KAuJY,6BAAA,GAAgC,gBAAA;;;;EAKxC,aAAA,EAAe,iCAAA;AAAA;;;;AA/InB;KA0JY,gCAAA;;;;EAKR,SAAA,GAAY,KAAA,CAAM,4BAAA;EAzJa;;;EA8J/B,OAAA,GAAU,KAAA,CAAM,0BAAA;AAAA;;;;KAMR,oBAAA,GAAuB,OAAA,CAAQ,wBAAA;EA1J/B;;;;EAgKR,QAAA,GAAW,KAAA;EA7JH;;;EAkKR,YAAA,GAAe,gCAAA;AAAA;AA/JnB;;;;AAAA,KAsKY,+BAAA;EAnKA;;;EAwKR,GAAA;EAxKyC;AAG7C;;EA0KI,GAAA;AAAA;;AAvKJ;;;KA8KY,kBAAA;EA9K+B;AAG3C;;EAgLI,IAAA,EAAM,wBAAA;EAhL8B;;AAGxC;EAkLI,KAAA,EAAO,+BAAA;AAAA;;;AA/KX;KAqLY,4BAAA;;;;EAKR,YAAA,GAAe,KAAA,CAAM,kBAAA;EAvLa;;;EA4LlC,OAAA,GAAU,KAAA,CAAM,0BAAA;AAAA;;;;KAMR,gBAAA,GAAmB,wBAAA;EA/K3B;;;EAoLA,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,oBAAA;EAnKjC;;;EAwKR,YAAA,GAAe,4BAAA;EAxJU;;;;;EA+JzB,UAAA,GAAa,KAAA;EArJU;;;;EA2JvB,WAAA,GAAc,+BAAA;EAtJiB;;;;;;EA8J/B,IAAA,GAAO,wBAAA;AAAA;;;;KAUC,iCAAA;EA7KR;;;EAkLA,UAAA,GAAa,uBAAA;EA7Kb;;;EAkLA,UAAA;AAAA;;;;KAMQ,eAAA;EA7KR;;;EAkLA,QAAA;EA5KQ;;;;;EAmLR,MAAA;EA9KQ;;;EAmLR,GAAA,GAAM,iCAAA;AAAA;;;;;KAOE,sBAAA;EA/KwC;;AAWpD;;;;EA4KI,QAAA,GAAW,QAAA;EAlKK;;;;;;EA0KhB,cAAA,GAAiB,mBAAA;EA1KjB;;;;;AAMJ;;;EA8KI,iBAAA;AAAA;;;;;KAWQ,eAAA;EAzL+B;;;EA8LvC,SAAA,GAAY,KAAA,CAAM,4BAAA;EAnLH;;;EAwLf,OAAA,GAAU,KAAA,CAAM,0BAAA;AAAA;;;;KAUR,2BAAA,GAA8B,OAAA,CAAQ,wBAAA;EA1KpB;;;EA+K1B,KAAA,GAAQ,eAAA;EA1KF;;;EA+KN,OAAA,GAAU,KAAA,CAAM,sBAAA;EA1KsB;AAM1C;;EAyKI,OAAA,GAAU,OAAA,CAAQ,sBAAA;EApKG;;;EAyKrB,UAAA;EApKe;;;;;EA2Kf,OAAA;AAAA;;;;KAMQ,uBAAA,GAA0B,wBAAA;EA3KV;;;EAgLxB,WAAA,GAAc,qBAAA;EA3K2B;;;EAgLzC,eAAA;EA9Jc;;;EAmKd,iBAAA;EA1L2B;;;EA+L3B,OAAA,GAAU,KAAA,CAAM,sBAAA;EA1LyB;;;EA+LzC,KAAA,GAAQ,eAAA;EAnLK;;;EAwLb,OAAA,GAAU,OAAA,CAAQ,sBAAA;EA1KX;;;EA+KP,UAAA;EArKyC;;;;;EA4KzC,OAAA;EAlKU;;AAMd;EAiKI,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,2BAAA;AAAA;;;;KAUjC,eAAA,GAAkB,wBAAA;EA1JpB;;;AAOV;;EA0JI,aAAA,GAAgB,QAAA;EA1IoB;;;EA+IpC,KAAA,GAAQ,eAAA;EA/IS;;;;AAqBrB;EAiII,cAAA;;;;EAKA,eAAA;EA5HU;;;EAiIV,iBAAA,GAAoB,sBAAA;AAAA;;;;;;;KAaZ,gBAAA,GAAmB,IAAA,CAAK,uBAAA;EApIG;;;EAyInC,aAAA,EAAe,iCAAA;EApIP;;;;;EA2IR,aAAA,GAAgB,QAAA;EAjIC;;;EAsIjB,KAAA,GAAQ,eAAA;AAAA;;;;KAUA,0BAAA;EAhJE;;;EAqJV,KAAA,EAAO,yBAAA;EAzIA;;AAMX;EAwII,UAAA;AAAA;;;;KAMQ,2BAAA;EArHA;;;EA0HR,MAAA,EAAQ,0BAAA;EApGiC;;;EAyGzC,WAAA;AAAA;;;;KAMQ,6BAAA,GAAgC,OAAA,CAAQ,wBAAA;EA1IhD;;;EA+IA,MAAA,GAAS,KAAA,CAAM,0BAAA;EA1IP;;;EA+IR,OAAA,GAAU,KAAA,CAAM,2BAAA;AAAA;;;;KAMR,qBAAA,GAAwB,wBAAA;EA/HS;;;EAoIzC,OAAA;EA1HuB;;;EA+HvB,QAAA;EAnHQ;;;EAwHR,MAAA,EAAQ,KAAA,CAAM,0BAAA;EApIY;;;EAyI1B,OAAA,EAAS,KAAA,CAAM,2BAAA;EA7HP;;;EAkIR,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,6BAAA;EAjHrB;;;EAsHpB,UAAA;AAAA;;;;KAUQ,kBAAA,GAAqB,wBAAA;EAvGb;;;EA4GhB,IAAA,EAAM,uBAAA;EAxHqB;;;EA6H3B,KAAA;EAjHA;;;EAsHA,IAAA;AAAA;;AAvGJ;;;;KA+GY,4BAAA,GAA+B,gBAAA,GAAmB,OAAA,CAAQ,wBAAA;;;;KAK1D,kBAAA,GAAqB,wBAAA;EApGrB;;;EAyGR,IAAA,GAAO,uBAAA;EApGP;;;EAyGA,IAAA;EApGW;AAMf;;;;EAqGI,kBAAA,GAAqB,4BAAA;AAAA;;;;;;KAQb,cAAA;EA7GwC;;;EAkHhD,IAAA,EAAM,uBAAA;EAxGN;;;EA6GA,KAAA;EA7G2C;AAM/C;;EA4GI,IAAA;AAAA;;;;KAUQ,cAAA;EA7FO;;;EAkGf,IAAA;EAlGc;;;EAuGd,IAAA;AAAA;;;;;KAOQ,kBAAA,GAAqB,wBAAA;EA9G7B;;;EAmHA,GAAA;AAAA;;;AApGJ;KA8GY,kBAAA;;;;EAKR,MAAA,GAAS,sBAAA;AAAA;;;;KAMD,UAAA,GAAa,wBAAA;EAlGb;;;;EAwGR,OAAA;EAxG0D;;;EA6G1D,OAAA;EA7G0D;;;EAkH1D,SAAA,EAAW,KAAA,CAAM,YAAA;EA7GT;;;EAkHR,QAAA,GAAW,kBAAA;EA7GJ;;;EAkHP,KAAA,EAAO,MAAA,CAAO,wBAAA,EAA0B,wBAAA;EAvHX;;;EA4H7B,KAAA,EAAO,KAAA,CAAM,sBAAA;EA3Gb;;;EAgHA,OAAA,EAAS,MAAA,CAAO,0BAAA,EAA4B,gBAAA;EAxGpC;;;EA6GR,IAAA,GAAO,MAAA,CAAO,wBAAA,EAA0B,cAAA;EAxGxC;;;EA6GA,YAAA,GAAe,MAAA,CAAO,+BAAA,EAAiC,qBAAA;EAnGnD;;AAUR;EA8FI,MAAA,EAAQ,MAAA,CAAO,yBAAA,EAA2B,eAAA;;;;EAK1C,OAAA,EAAS,MAAA,CAAO,0BAAA,EAA4B,gBAAA;EAlFlB;;;EAuF1B,cAAA,EAAgB,MAAA,CAAO,iCAAA,EAAmC,uBAAA;EAxElD;;;;EA8ER,OAAA,EAAS,MAAA,CAAO,0BAAA;EAnER;;;EAwER,SAAA,GAAY,MAAA,CAAO,4BAAA,EAA8B,kBAAA;EAxDhC;;;EA6DjB,SAAA,GAAY,MAAA,CAAO,4BAAA,EAA8B,kBAAA;EAnDT;;;EAwDxC,SAAA,GAAY,KAAA,CAAM,kBAAA;EA9CF;;;EAmDhB,KAAA,GAAQ,KAAA,CAAM,cAAA;EA9C0B;;;EAmDxC,SAAA;AAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../source/utilities.ts","../source/template.ts","../source/invitation.ts"],"mappings":";;;;;;AAgBA;;;;;;;;;;;;ACPA;KDOY,OAAA,MAAa,CAAA,OAAQ,CAAA;;;;;AAAjC;KCPY,QAAA;;;;KAKA,mBAAA;;;;cAKC,aAAA;EAAA;;;;;;;;;;;KAaD,YAAA,GAAe,OAAA,QAAe,aAAA;AAb1C;;;AAAA,cAkBa,yBAAA;EAAA;;;;;;;;;AALb;KAiBY,uBAAA,GAA0B,OAAA,QAAe,yBAAA;;;;cAKxC,sBAAA;EAAA;;;;;;;;KAUD,qBAAA,GAAwB,OAAA,QAAe,sBAAA;;;;;cAMtC,wBAAA;EAAA;;;;;;;;AANb;;;;AAAA,KAoBY,uBAAA,GAA0B,OAAA,QAAe,wBAAA;AAdrD;AAAA,KAqBY,wBAAA;;KAGA,0BAAA;;KAGA,yBAAA;;KAGA,0BAAA;;KAGA,iCAAA;;KAGA,0BAAA;;KAGA,+BAAA;;KAGA,4BAAA;;KAGA,4BAAA;AAxBZ;AAAA,KA2BY,wBAAA;;KAGA,0BAAA;;KAGA,oBAAA;;;;KASA,wBAAA;EApCA;;;EAyCR,IAAA;EAzCiC;AAGrC;;EA2CI,WAAA;EA3CkC;;AAGtC;EA6CI,IAAA;AAAA;;;AA1CJ;;;KAsDY,gBAAA;EAtD0B;AAGtC;;EAwDI,kBAAA,GAAqB,oBAAA;EAxDkB;;AAG3C;EA0DI,QAAA,GAAW,KAAA;;;;EAKX,SAAA,GAAY,KAAA,CAAM,MAAA,CAAO,4BAAA;EA5DW;;;EAiEpC,SAAA,GAAY,KAAA,CAAM,MAAA,CAAO,4BAAA;EA9DjB;;;EAmER,OAAA,GAAU,KAAA,CAAM,MAAA,CAAO,0BAAA;EAnES;AAGpC;;EAqEI,IAAA,GAAO,wBAAA;AAAA;;AAlEX;;KAwEY,sBAAA,GAAyB,gBAAA;EAxEL;;AAShC;EAoEI,MAAA,EAAQ,0BAAA;AAAA;;;;KAMA,sBAAA,GAAyB,gBAAA;EA3D7B;;AAYR;EAoDI,MAAA,EAAQ,0BAAA;AAAA;;;;KAMA,6BAAA,GAAgC,gBAAA;EA3C5B;;;EAgDZ,aAAA,EAAe,iCAAA;AAAA;;;;;KAWP,gCAAA;EArER;;;EA0EA,SAAA,GAAY,KAAA,CAAM,4BAAA;EAhElB;;;EAqEA,OAAA,GAAU,KAAA,CAAM,0BAAA;AAAA;;;;KAMR,oBAAA,GAAuB,OAAA,CAAQ,wBAAA;EAjE7B;;;;EAuEV,QAAA,GAAW,KAAA;EAlEoB;;AAMnC;EAiEI,YAAA,GAAe,gCAAA;AAAA;;;;;KAOP,+BAAA;EAnE0B;AAMtC;;EAkEI,GAAA;EA7DkC;;;EAkElC,GAAA;AAAA;;AA5DJ;;;KAmEY,kBAAA;EAnEgC;;;EAwExC,IAAA,EAAM,wBAAA;EAnE0C;AAWpD;;EA6DI,KAAA,EAAO,+BAAA;AAAA;;;;KAMC,4BAAA;EAzDO;;;EA8Df,SAAA,GAAY,KAAA,CAAM,4BAAA;EA9DlB;;;EAmEA,YAAA,GAAe,KAAA,CAAM,kBAAA;EAnEqB;AAM9C;;EAkEI,OAAA,GAAU,KAAA,CAAM,0BAAA;AAAA;;;;KAMR,gBAAA,GAAmB,wBAAA;EA7DoB;;;EAkE/C,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,oBAAA;EAvE9B;;;EA4EX,YAAA,GAAe,4BAAA;EAvEgC;AAOnD;;;;EAuEI,UAAA,GAAa,KAAA;EAtDL;;;;EA4DR,WAAA,GAAc,+BAAA;EAvDR;;;;;AAWV;EAoDI,IAAA,GAAO,wBAAA;AAAA;;;;KAUC,iCAAA;EA/CQ;;;EAoDhB,UAAA,GAAa,uBAAA;EA9Db;;;EAmEA,UAAA;AAAA;;;;KAMQ,eAAA;EA/DkC;;AAM9C;EA8DI,QAAA;;;;EAKA,MAAA;EA9DQ;;;EAmER,GAAA,GAAM,iCAAA;AAAA;;;;;KAOE,sBAAA;EA1EO;;;;;;EAkFf,QAAA,GAAW,QAAA;EAhEG;;;;;AAkBlB;EAsDI,cAAA,GAAiB,mBAAA;;;;;;;;AAtCrB;;;EAkDI,iBAAA;AAAA;;;;;KAWQ,eAAA;EAvCA;;;EA4CR,SAAA,GAAY,KAAA,CAAM,4BAAA;EApClB;;;EAyCA,OAAA,GAAU,KAAA,CAAM,0BAAA;AAAA;;;AAVpB;KAoBY,2BAAA,GAA8B,OAAA,CAAQ,wBAAA;;;;EAK9C,KAAA,GAAQ,eAAA;EAfE;;;EAoBV,OAAA,GAAU,KAAA,CAAM,sBAAA;EAzBJ;;;EA8BZ,OAAA,GAAU,OAAA,CAAQ,sBAAA;EAzBF;;;EA8BhB,UAAA;EApBmC;;;;;EA2BnC,OAAA;AAAA;;;;KAMQ,uBAAA,GAA0B,wBAAA;EAjCI;;;EAsCtC,WAAA,GAAc,qBAAA;EA5Bd;;;EAiCA,eAAA;EA5BU;;;EAiCV,iBAAA;EArBO;;AAMX;EAoBI,OAAA,GAAU,KAAA,CAAM,sBAAA;;;;EAKhB,KAAA,GAAQ,eAAA;EALE;;;EAUV,OAAA,GAAU,OAAA,CAAQ,sBAAA;EAiBH;;;EAZf,UAAA;EAYc;;;;;EALd,OAAA;EAtBA;;;EA2BA,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,2BAAA;AAAA;;;;KAUjC,eAAA,GAAkB,wBAAA;EAf1B;;;;;EAsBA,aAAA,GAAgB,QAAA;EAjBoD;AAUxE;;EAYI,KAAA,GAAQ,eAAA;EAZkB;;;;;EAmB1B,cAAA;EAnB0B;;;EAwB1B,eAAA;EAZQ;;;EAiBR,iBAAA,GAAoB,sBAAA;AAAA;;;AAaxB;;;;KAAY,gBAAA,GAAmB,IAAA,CAAK,uBAAA;EAKjB;;;EAAf,aAAA,EAAe,iCAAA;EAYQ;;;;;EALvB,aAAA,GAAgB,QAAA;EAAA;;;EAKhB,KAAA,GAAQ,eAAA;AAAA;AAUZ;;;AAAA,KAAY,0BAAA;EAKR;;;EAAA,KAAA,EAAO,yBAAA;EAKG;AAMd;;EANI,UAAA;AAAA;;;;KAMQ,2BAAA;EAUG;AAMf;;EAXI,MAAA,EAAQ,0BAAA;EAWwC;;;EANhD,WAAA;AAAA;;;;KAMQ,6BAAA,GAAgC,OAAA,CAAQ,wBAAA;EAAA;;;EAKhD,MAAA,GAAS,KAAA,CAAM,0BAAA;EAKf;;;EAAA,OAAA,GAAU,KAAA,CAAM,2BAAA;AAAA;AAMpB;;;AAAA,KAAY,qBAAA,GAAwB,wBAAA;EAiBlB;;;EAZd,OAAA;EAsBe;;;;;EAff,QAAA;EAPA;;;EAYA,MAAA,EAAQ,KAAA,CAAM,0BAAA;EAAA;;;EAKd,OAAA,EAAS,KAAA,CAAM,2BAAA;EAKf;;;EAAA,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,6BAAA;EAKzC;;;EAAA,UAAA;AAAA;;;;KAUQ,kBAAA,GAAqB,wBAAA;EAKvB;;;EAAN,IAAA,EAAM,uBAAA;EAUF;AAQR;;EAbI,KAAA;EAauC;;;EARvC,IAAA;AAAA;;;;;;KAQQ,4BAAA,GAA+B,gBAAA,GAAmB,OAAA,CAAQ,wBAAA;;;;KAK1D,kBAAA,GAAqB,wBAAA;EAiBR;;;EAZrB,IAAA,GAAO,uBAAA;EAAP;;;EAKA,IAAA;EAOqB;;;AAQzB;;EARI,kBAAA,GAAqB,4BAAA;AAAA;;;;;;KAQb,cAAA;EAyBA;;;EApBR,IAAA,EAAM,uBAAA;EA8BF;AAOR;;EAhCI,KAAA;EAgC6B;;AAejC;EA1CI,IAAA;AAAA;;;AAqDJ;KA3CY,cAAA;;;;EAKR,IAAA;EA2DW;;;EAtDX,IAAA;AAAA;;;;;KAOQ,kBAAA,GAAqB,wBAAA;EAmEW;;;EA9DxC,GAAA;AAAA;;;;KAUQ,kBAAA;EAmEoC;;;EA9D5C,MAAA,GAAS,sBAAA;AAAA;;;;KAMD,UAAA,GAAa,wBAAA;EAwET;;;;EAlEZ,OAAA;EA4EY;;;EAvEZ,OAAA;EA4Ea;;;EAvEb,SAAA,EAAW,KAAA,CAAM,YAAA;EAAjB;;;EAKA,QAAA,GAAW,kBAAA;EAAA;;;EAKX,KAAA,EAAO,MAAA,CAAO,wBAAA,EAA0B,wBAAA;EAAA;;;EAKxC,KAAA,EAAO,KAAA,CAAM,sBAAA;EAKb;;;EAAA,OAAA,EAAS,MAAA,CAAO,0BAAA,EAA4B,gBAAA;EAK5C;;;EAAA,IAAA,GAAO,MAAA,CAAO,wBAAA,EAA0B,cAAA;EAKxC;;;EAAA,YAAA,GAAe,MAAA,CAAO,+BAAA,EAAiC,qBAAA;EAKvD;;;EAAA,MAAA,EAAQ,MAAA,CAAO,yBAAA,EAA2B,eAAA;EAK1C;;;EAAA,OAAA,EAAS,MAAA,CAAO,0BAAA,EAA4B,gBAAA;EAK5C;;;EAAA,cAAA,EAAgB,MAAA,CAAO,iCAAA,EAAmC,uBAAA;EAM1D;;;;EAAA,OAAA,EAAS,MAAA,CAAO,0BAAA;EAKG;;;EAAnB,SAAA,GAAY,MAAA,CAAO,4BAAA,EAA8B,kBAAA;EAK9B;;;EAAnB,SAAA,GAAY,MAAA,CAAO,4BAAA,EAA8B,kBAAA;EAK/B;;;EAAlB,SAAA,GAAY,KAAA,CAAM,kBAAA;EAUlB;;;EALA,KAAA,GAAQ,KAAA,CAAM,cAAA;;;ACr4BlB;ED04BI,SAAA;AAAA;;;;AD14BJ;;KEAY,sBAAA;;;;KAKA,4BAAA;;;;KAKA,4BAAA;;ADjBZ;;KCsBY,iCAAA;;;ADjBZ;KCsBY,kCAAA;;;;KAKA,+BAAA;;;;;;;KAQA,qBAAA;;;;;;ADjBZ;KCyBY,qBAAA;;;;KAKA,2BAAA;;;;KAKA,8BAAA;;;;KAKA,+BAAA;ADvBZ;;;;;AAKA;;;;;;;;;AAUA;;;;;AAMA;;AArBA,KC8CY,2BAAA;EDjBF;;;ECsBN,kBAAA,EAAoB,oBAAA;;;;EAKpB,gBAAA,EAAkB,0BAAA;AAAA;;ADrBtB;;;;;AAOA;;;;;AAGA;;;;;AAGA;;;;;AAGA;;;;;AAGA;KCgCY,+BAAA;;;;EAKR,gBAAA,EAAkB,4BAAA;EDlCgB;;;;AAGtC;;;;;AAGA;;ECyCI,SAAA,EAAW,+BAAA;AAAA;;ADtCf;;KC4CY,2BAAA;EACR,SAAA,GAAY,oBAAA;EACZ,MAAA,GAAS,iBAAA;EACT,OAAA,GAAU,kBAAA;AAAA;;;;KAMF,wBAAA,GAA2B,2BAAA;EACnC,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,2BAAA;AAAA;;;AD7C7C;KCmDY,yBAAA;;;;AD1CZ;;;;;;;;;AA2BA;;;;;;;;;;;;;KC0CY,oBAAA;EDZD;;;ECiBP,kBAAA,EAAoB,4BAAA;ED1CC;;;EC+CrB,KAAA,EAAO,yBAAA;EDrCK;;;EC0CZ,cAAA,GAAiB,wBAAA;EDrCL;;;EC0CZ,UAAA,GAAa,+BAAA;AAAA;;;;;;;AD1BjB;;;;;;;;;AAWA;;;;;;;;;AAWA;KCgCY,iBAAA,GAAoB,OAAA,CAAQ,KAAA;;;;EAKpC,eAAA,GAAkB,yBAAA;EDhCH;;;ECqCf,gBAAA,GAAmB,iCAAA;ED1BqB;;;;ECgCxC,cAAA,GAAiB,wBAAA;EDtBP;;;EC2BV,UAAA,GAAa,+BAAA;AAAA;;;;;;;ADrBjB;;;;;;;;;;;;;;;;;AAkBA;;KC+BY,kBAAA,GAAqB,OAAA,CAAQ,MAAA;ED1BrC;;AAYJ;ECmBI,gBAAA,GAAmB,0BAAA;;;;EAKnB,gBAAA,GAAmB,kCAAA;EDdnB;;;ECmBA,gBAAA,GAAmB,0BAAA;EDbX;;;ECkBR,cAAA,GAAiB,wBAAA;EDbL;;;ECkBZ,UAAA,GAAa,+BAAA;AAAA;;;;;;;;;;;;;;ADFjB;;;;;KCuBY,sBAAA;EDlBA;;;ECuBR,kBAAA,GAAqB,8BAAA;EDGd;;;ECEP,mBAAA,GAAsB,+BAAA;ED5BtB;;;ECiCA,SAAA,GAAY,oBAAA;ED5BZ;;;ECiCA,MAAA,GAAS,iBAAA;EDpBT;;;ECyBA,OAAA,GAAU,kBAAA;AAAA;;ADPd;;;;KCeY,gBAAA;;;;;ADCZ;;;;;;;;;;AAsBA;;;;;KCFY,kBAAA;EDkBR;;;ECbA,gBAAA,EAAkB,4BAAA;EDyBD;AAWrB;;EC/BI,wBAAA,EAA0B,4BAAA;EDoCR;;;EC/BlB,gBAAA,EAAkB,4BAAA;EDoCH;;;EC/Bf,kBAAA,EAAoB,qBAAA;ED0BF;;;;ECpBlB,eAAA,GAAkB,2BAAA;EDyBwB;AAU9C;;EC9BI,IAAA,EAAM,sBAAA;ED8BwC;;;ECzB9C,SAAA,EAAW,qBAAA;EDmCD;;;EC9BV,kBAAA,EAAoB,qBAAA;EDmCH;;;EC9BjB,IAAA,GAAO,gBAAA;AAAA;;;;KAMN,iCAAA;EDwBS;;;ECnBV,eAAA,EAAiB,2BAAA;ED+BV;;AAMX;EChCI,kBAAA,EAAoB,qBAAA;;;;EAKpB,yBAAA,EAA2B,4BAAA;ED+CjB;;;;;ECxCV,kBAAA,EAAoB,qBAAA;AAAA;;;;KAMZ,uCAAA;EDmBM;;;ECdd,sBAAA,EAAwB,qBAAA;ED6Bd;;;ECxBV,6BAAA,EAA+B,4BAAA;EDkC/B;;;;;;EC1BA,sBAAA,EAAwB,qBAAA;AAAA;;;;ADqD5B;;;;;;;;;;;;KCnCY,6BAAA,GACN,iCAAA,IACC,iCAAA,GAAoC,uCAAA;;;;;;;;AD2E3C;;;;;;KC5DY,sBAAA;ED6EA;;;ECxER,KAAA,EAAO,yBAAA;EDuDyB;;;EClDhC,kBAAA,EAAoB,qBAAA;ED8DJ;;;ECzDhB,yBAAA,EAA2B,4BAAA;ED8DJ;AAU3B;;ECnEI,kBAAA,EAAoB,qBAAA;AAAA;;;;;;ADmFxB;;;;;;;;;AAgBA;;;;;;;;;KCzEY,kBAAA;EDmFO;;;;;EC5Ef,YAAA,GAAe,MAAA,CAAO,+BAAA,EAAiC,6BAAA;ED4EvD;;;ECvEA,IAAA,GAAO,MAAA,CAAO,wBAAA,EAA0B,sBAAA;AAAA;AD6E5C;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,KChDY,YAAA;EDgFE;;AAUd;ECrFI,oBAAA,EAAsB,sBAAA;;;;EAKtB,kBAAA,EAAoB,qBAAA;EDqFd;;;EChFN,kBAAA,EAAoB,oBAAA;ED0FhB;AAQR;;EC7FI,gBAAA,EAAkB,0BAAA;ED6FqB;;;ECxFvC,OAAA,EAAS,kBAAA;EDwFwD;;;ECnFjE,MAAA,GAAS,kBAAA;AAAA"}

package/dist/index.mjs

@@ -1 +1,46 @@
-export {  };
+//#region source/template.ts
+/**
+* Values for BCH VM versions that an XO template can declare support for.
+*/
+const BchVmVersions = {
+	BCH_2020_05: "BCH_2020_05",
+	BCH_2021_05: "BCH_2021_05",
+	BCH_2022_05: "BCH_2022_05",
+	BCH_2023_05: "BCH_2023_05",
+	BCH_2024_05: "BCH_2024_05",
+	BCH_2025_05: "BCH_2025_05",
+	BCH_2026_05: "BCH_2026_05"
+};
+/**
+* Values for NFT capability on template token fields.
+*/
+const XOTemplateNftCapabilities = {
+	NONE: "none",
+	MUTABLE: "mutable",
+	MINTING: "minting"
+};
+/**
+* Values for XO template locking script types.
+*/
+const XOTemplateLockingTypes = {
+	P2S: "p2s",
+	P2PKH: "p2pkh",
+	P2SH: "p2sh"
+};
+/**
+* Values for primitive types declared in an XO template.
+* Used by constants, variables, and data fields.
+*/
+const XOTemplatePrimitiveTypes = {
+	BOOLEAN: "boolean",
+	BYTES: "bytes",
+	INTEGER: "integer",
+	BIGINT: "bigint",
+	STRING: "string",
+	PRIVATE_KEY: "private_key",
+	PUBLIC_KEY: "public_key"
+};
+
+//#endregion
+export { BchVmVersions, XOTemplateLockingTypes, XOTemplateNftCapabilities, XOTemplatePrimitiveTypes };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../source/template.ts"],"sourcesContent":["import type { ValueOf } from './utilities.ts';\n\n// ============================================================\n// Base types\n// ============================================================\n\n/**\n * Type for satoshis.\n */\nexport type Satoshis = bigint;\n\n/**\n * A fungible token amount.\n */\nexport type FungibleTokenAmount = bigint;\n\n/**\n * Values for BCH VM versions that an XO template can declare support for.\n */\nexport const BchVmVersions = {\n    BCH_2020_05: 'BCH_2020_05',\n    BCH_2021_05: 'BCH_2021_05',\n    BCH_2022_05: 'BCH_2022_05',\n    BCH_2023_05: 'BCH_2023_05',\n    BCH_2024_05: 'BCH_2024_05',\n    BCH_2025_05: 'BCH_2025_05',\n    BCH_2026_05: 'BCH_2026_05',\n} as const;\n\n/**\n * The set of BCH VM versions that an XO template can declare support for.\n */\nexport type BchVmVersion = ValueOf<typeof BchVmVersions>;\n\n/**\n * Values for NFT capability on template token fields.\n */\nexport const XOTemplateNftCapabilities = {\n    NONE: 'none',\n    MUTABLE: 'mutable',\n    MINTING: 'minting',\n} as const;\n\n/**\n * The capability of a non-fungible token.\n * `minting` can create new NFTs of the same category.\n * `mutable` can update its own commitment data.\n * `none` means the commitment is immutable.\n */\nexport type XOTemplateNftCapability = ValueOf<typeof XOTemplateNftCapabilities>;\n\n/**\n * Values for XO template locking script types.\n */\nexport const XOTemplateLockingTypes = {\n    P2S: 'p2s',\n    P2PKH: 'p2pkh',\n    P2SH: 'p2sh',\n} as const;\n\n/**\n * The standard locking script types supported by XO.\n *\n */\nexport type XOTemplateLockingType = ValueOf<typeof XOTemplateLockingTypes>;\n\n/**\n * Values for primitive types declared in an XO template.\n * Used by constants, variables, and data fields.\n */\nexport const XOTemplatePrimitiveTypes = {\n    BOOLEAN: 'boolean',\n    BYTES: 'bytes',\n    INTEGER: 'integer',\n    BIGINT: 'bigint',\n    STRING: 'string',\n    PRIVATE_KEY: 'private_key',\n    PUBLIC_KEY: 'public_key',\n} as const;\n\n/**\n * The primitive types that can be declared in an XO template.\n * Used by constants, variables, and data fields.\n */\nexport type XOTemplatePrimitiveType = ValueOf<typeof XOTemplatePrimitiveTypes>;\n\n// ============================================================\n// Identifier Types\n// ============================================================\n\n/** Identifies a role defined in the template's roles. */\nexport type XOTemplateRoleIdentifier = string;\n\n/** Identifies an action defined in the template's actions. */\nexport type XOTemplateActionIdentifier = string;\n\n/** Identifies an input defined in the template's inputs. */\nexport type XOTemplateInputIdentifier = string;\n\n/** Identifies an output defined in the template's outputs. */\nexport type XOTemplateOutputIdentifier = string;\n\n/** Identifies a locking script defined in the template's lockingScripts. */\nexport type XOTemplateLockingScriptIdentifier = string;\n\n/** Identifies a script defined in the template's scripts. */\nexport type XOTemplateScriptIdentifier = string;\n\n/** Identifies a transaction defined in the template's transactions. */\nexport type XOTemplateTransactionIdentifier = string;\n\n/** Identifies a variable defined in the template's variables. */\nexport type XOTemplateVariableIdentifier = string;\n\n/** Identifies a constant defined in the template's constants. */\nexport type XOTemplateConstantIdentifier = string;\n\n/** Identifies a data field defined in the template's data. */\nexport type XOTemplateDataIdentifier = string;\n\n/** Identifies a secret defined in a role or action's secrets list. */\nexport type XOTemplateSecretIdentifier = string;\n\n/** Identifier for an XO template. */\nexport type XOTemplateIdentifier = string;\n\n// ============================================================\n// View Properties\n// ============================================================\n\n/**\n * Human-readable display properties shared by most template elements.\n */\nexport type XOTemplateViewProperties = {\n\n    /**\n     * A short human-readable label for this element.\n     */\n    name: string;\n\n    /**\n     * A human-readable explanation of what this element does and when it is relevant.\n     */\n    description: string;\n\n    /**\n     * An optional icon identifier.\n     */\n    icon?: string;\n};\n\n// ============================================================\n// Intents\n// ============================================================\n\n/**\n * The base intent structure. Describes the common data parameters shared by all intent types\n * regardless of what they target. An optional templateIdentifier allows the intent to reference\n * a target defined in a different template.\n */\nexport type XOTemplateIntent = {\n\n    /**\n     * Optional identifier for the template used in this intent. If not provided, uses the current template.\n     */\n    templateIdentifier?: XOTemplateIdentifier;\n\n    /**\n     * Identifiers for items to generate when this intent is resolved (e.g. keys or secrets).\n     */\n    generate?: Array<string>;\n\n    /**\n     * Variable values to apply when this intent is resolved.\n     */\n    variables?: Array<Record<XOTemplateVariableIdentifier, unknown>>;\n\n    /**\n     * Constant values to apply when this intent is resolved.\n     */\n    constants?: Array<Record<XOTemplateConstantIdentifier, unknown>>;\n\n    /**\n     * Secret values to apply when this intent is resolved.\n     */\n    secrets?: Array<Record<XOTemplateSecretIdentifier, unknown>>;\n\n    /**\n     * Optional identifier for the role used in this intent.\n     */\n    role?: XOTemplateRoleIdentifier;\n};\n\n/**\n * An intent that targets a specific action.\n */\nexport type XOTemplateActionIntent = XOTemplateIntent & {\n\n    /**\n     * The identifier for the intended action.\n     */\n    action: XOTemplateActionIdentifier;\n};\n\n/**\n * An intent that targets a specific output.\n */\nexport type XOTemplateOutputIntent = XOTemplateIntent & {\n\n    /**\n     * The identifier for the intended output.\n     */\n    output: XOTemplateOutputIdentifier;\n};\n\n/**\n * An intent that targets a specific locking script.\n */\nexport type XOTemplateLockingScriptIntent = XOTemplateIntent & {\n\n    /**\n     * The identifier for the intended locking script.\n     */\n    lockingScript: XOTemplateLockingScriptIdentifier;\n};\n\n// ============================================================\n// Actions\n// ============================================================\n\n/**\n * Requirements for a specific role within an action. Describes what data or secrets\n * the role must provide when participating.\n */\nexport type XOTemplateActionRoleRequirements = {\n\n    /**\n     * List of variable identifiers required for this role.\n     */\n    variables?: Array<XOTemplateVariableIdentifier>;\n\n    /**\n     * List of secret identifiers required for this role.\n     */\n    secrets?: Array<XOTemplateSecretIdentifier>;\n};\n\n/**\n * A role specific definition within an action.\n */\nexport type XOTemplateActionRole = Partial<XOTemplateViewProperties> & {\n\n    /**\n     * Identifiers for data items that should be generated for this role\n     * when participating in the action.\n     */\n    generate?: Array<string>;\n\n    /**\n     * The requirements for this role within this action.\n     */\n    requirements?: XOTemplateActionRoleRequirements;\n};\n\n/**\n * Slot configuration for a role. Declares how many participants of a given\n * role are needed to satisfy the action's requirements.\n */\nexport type XOTemplateRoleSlotsRequirements = {\n\n    /**\n     * Minimum number of participants required for this role.\n     */\n    min: number;\n\n    /**\n     * Maximum number of participants allowed for this role. Undefined means unlimited.\n     */\n    max?: number;\n};\n\n/**\n * A role entry in an action's requirements block.\n * Declares which role must participate and how many slots are needed.\n */\nexport type XOTemplateRoleSlot = {\n\n    /**\n     * The role identifier that this requirement applies to.\n     */\n    role: XOTemplateRoleIdentifier;\n\n    /**\n     * Slot configuration specifying how many participants of this role are required.\n     */\n    slots: XOTemplateRoleSlotsRequirements;\n};\n\n/**\n * Requirements for an action. Declares which roles must participate and what secrets must be available.\n */\nexport type XOTemplateActionRequirements = {\n\n    /**\n     * List of variable identifiers required for this action.\n     */\n    variables?: Array<XOTemplateVariableIdentifier>;\n\n    /**\n     * The participants required for this action.\n     */\n    participants?: Array<XOTemplateRoleSlot>;\n\n    /**\n     * The secrets required for this action.\n     */\n    secrets?: Array<XOTemplateSecretIdentifier>;\n};\n\n/**\n * An action within a template.\n */\nexport type XOTemplateAction = XOTemplateViewProperties & {\n\n    /**\n     * Specific context for each role participating in this action.\n     */\n    roles?: Record<XOTemplateRoleIdentifier, XOTemplateActionRole>;\n\n    /**\n     * The requirements for this action.\n     */\n    requirements?: XOTemplateActionRequirements;\n\n    /**\n     * Conditions that must be met for this action to be available.\n     *\n     * @todo More work needs to be done on this field.\n     */\n    conditions?: Array<string>;\n\n    /**\n     * The identifier of the transaction this action produces, referencing an entry\n     * in the template's transactions.\n     */\n    transaction?: XOTemplateTransactionIdentifier;\n\n    /**\n     * The identifier of the data field this action produces, referencing an entry\n     * in the template's data.\n     *\n     * @todo More work needs to be done on this field.\n     */\n    data?: XOTemplateDataIdentifier;\n};\n\n// ============================================================\n// Tokens & Amounts\n// ============================================================\n\n/**\n * Non-fungible token configuration within a token field.\n */\nexport type XOTemplateNonFungibleTokenDetails = {\n\n    /**\n     * The capability of the NFT. May be a known capability value or a CashASM expression resolving to a capability.\n     */\n    capability?: XOTemplateNftCapability | string;\n\n    /**\n     * The commitment data for the NFT, as a string or CashASM expression resolving to a commitment.\n     */\n    commitment?: string;\n};\n\n/**\n * Token configuration for outputs and inputs.\n */\nexport type XOTemplateToken = {\n\n    /**\n     * The category of the token, as a string or CashASM expression resolving to a category.\n     */\n    category?: string;\n\n    /**\n     * The amount of fungible tokens as a bigint, a CashASM expression resolving to a bigint, or null indicating no FT is present.\n     */\n    amount?: bigint | string | null;\n\n    /**\n     * Non-fungible token configuration. Null indicates no NFT is present.\n     */\n    nft?: XOTemplateNonFungibleTokenDetails | null;\n};\n\n/**\n * Asset amounts configuration. Used for balance tracking on locking scripts and their roles, and for omitting change amounts.\n * All fields are optional. Values may be literal amounts or CashASM expressions resolving to amounts.\n */\nexport type XOTemplateAssetAmounts = {\n\n    /**\n     * The satoshi amount.\n     * - `Satoshis`: A specific bigint amount.\n     * - `string`: A CashASM expression that resolves to the amount.\n     * - `true`: all, i.e. the entire amount\n     */\n    satoshis?: Satoshis | string | true;\n\n    /**\n     * The fungible token amount.\n     * - `FungibleTokenAmount`: A specific bigint amount.\n     * - `string`: A CashASM expression that resolves to the amount.\n     * - `true`: all, i.e. the entire amount\n     */\n    fungibleTokens?: FungibleTokenAmount | string | true;\n\n    /**\n     * Whether a non-fungible token is present (0 for absent, 1 for present),\n     * or a CashASM expression that evaluates to 0 or 1.\n     * - `true`: resolves to 1 if an NFT is present, or 0 if none is present. Use this when\n     *   the NFT is optional, to express that the NFT is estimated to be part of the balance\n     *   if present, or absent from it if not.\n     * - `0`: None, i.e. nothing is expected to be included\n     * - `1`: present and complete, as value > 1 does not make sense for non-fungible tokens\n     * - `string`: A CashASM expression that evaluates to 0 or 1.\n     */\n    nonfungibleTokens?: true | 0 | 1 | string;\n};\n\n// ============================================================\n// Shared State\n// ============================================================\n\n/**\n * State configuration shared by a locking script and its individual roles.\n * Declares which variables and secrets are tracked in the on-chain state for that participant.\n */\nexport type XOTemplateState = {\n\n    /**\n     * List of variable identifiers to track in state.\n     */\n    variables?: Array<XOTemplateVariableIdentifier>;\n\n    /**\n     * List of secret identifiers to track in state.\n     */\n    secrets?: Array<XOTemplateSecretIdentifier>;\n};\n\n// ============================================================\n// Locking Scripts\n// ============================================================\n\n/**\n * A role definition within a locking script.\n */\nexport type XOTemplateLockingScriptRole = Partial<XOTemplateViewProperties> & {\n\n    /**\n     * List of items to track as state for this role.\n     */\n    state?: XOTemplateState;\n\n    /**\n     * List of action references available to this role.\n     */\n    actions?: Array<XOTemplateActionIntent>;\n\n    /**\n     * Estimated ownership in the optional set of asset amounts specified.\n     */\n    balance?: Partial<XOTemplateAssetAmounts>;\n\n    /**\n     * Whether outputs locked to this script should be available for coin selection.\n     */\n    selectable?: boolean;\n\n    /**\n     * Privacy level for outputs locked to this script.\n     * - `number`: A numeric privacy level.\n     * - `string`: A CashASM expression that evaluates to a privacy level.\n     */\n    privacy?: number | string;\n};\n\n/**\n * A locking script definition in the template.\n */\nexport type XOTemplateLockingScript = XOTemplateViewProperties & {\n\n    /**\n     * The type of locking mechanism. Defaults to 'p2s' if not specified.\n     */\n    lockingType?: XOTemplateLockingType;\n\n    /**\n     * The locking script bytecode.\n     */\n    lockingBytecode: string;\n\n    /**\n     * Optional default unlocking bytecode when used in automatic coin selection.\n     */\n    unlockingBytecode?: string;\n\n    /**\n     * The actions available for this locking script.\n     */\n    actions?: Array<XOTemplateActionIntent>;\n\n    /**\n     * List of items to track as state for all participants.\n     */\n    state?: XOTemplateState;\n\n    /**\n     * Estimated ownership in the optional set of asset amounts specified.\n     */\n    balance?: Partial<XOTemplateAssetAmounts>;\n\n    /**\n     * Whether outputs locked to this script should be available for coin selection.\n     */\n    selectable?: boolean;\n\n    /**\n     * Privacy level for outputs locked to this script.\n     * - `number`: A numeric privacy level.\n     * - `string`: A CashASM expression that evaluates to a privacy level.\n     */\n    privacy?: number | string;\n\n    /**\n     * Specific context for each role participating in this locking script.\n     */\n    roles?: Record<XOTemplateRoleIdentifier, XOTemplateLockingScriptRole>;\n};\n\n// ============================================================\n// Inputs\n// ============================================================\n\n/**\n * An input definition in the template.\n */\nexport type XOTemplateInput = XOTemplateViewProperties & {\n\n    /**\n     * The amount of satoshis for this input.\n     * - `Satoshis`: A specific amount of satoshis.\n     * - `string`: A CashASM expression that resolves to the satoshi amount.\n     */\n    valueSatoshis?: Satoshis | string;\n\n    /**\n     * Token configuration for this input.\n     */\n    token?: XOTemplateToken | null;\n\n    /**\n     * The sequence number of this input.\n     * - `number`: A specific sequence number.\n     * - `string`: A CashASM expression that resolves to the sequence number.\n     */\n    sequenceNumber?: number | string;\n\n    /**\n     * Identifier of the unlocking script to use for the UTXO provided for this input.\n     */\n    unlockingScript?: string;\n\n    /**\n     * Amount of change that should be omitted from the automatic change handling. WARNING: Setting this can result in loss of funds!\n     */\n    omitChangeAmounts?: XOTemplateAssetAmounts;\n};\n\n// ============================================================\n// Outputs\n// ============================================================\n\n/**\n * An output definition in the template. Inherits all fields from `XOTemplateLockingScript`\n * except `lockingType`, `lockingBytecode` and `unlockingBytecode`: outputs reference a locking script by identifier\n * rather than defining one inline, so repeating any of these fields here would create an ambiguity\n * about which declaration takes precedence.\n */\nexport type XOTemplateOutput = Omit<XOTemplateLockingScript, 'lockingType' | 'lockingBytecode' | 'unlockingBytecode'> & {\n\n    /**\n     * Identifier of the locking script to use for this output.\n     */\n    lockingScript: XOTemplateLockingScriptIdentifier;\n\n    /**\n     * The amount of satoshis for this output.\n     * - `Satoshis`: A specific amount of satoshis.\n     * - `string`: A CashASM expression that resolves to the satoshi amount.\n     */\n    valueSatoshis?: Satoshis | string;\n\n    /**\n     * Token configuration for this output.\n     */\n    token?: XOTemplateToken | null;\n};\n\n// ============================================================\n// Transactions\n// ============================================================\n\n/**\n * Reference to an input in a transaction definition in the template.\n */\nexport type XOTemplateTransactionInput = {\n\n    /**\n     * The input definition identifier.\n     */\n    input: XOTemplateInputIdentifier;\n\n    /**\n     * Optional index of this input in the transaction.\n     */\n    inputIndex?: number;\n};\n\n/**\n * Reference to an output in a transaction definition in the template.\n */\nexport type XOTemplateTransactionOutput = {\n\n    /**\n     * The output definition identifier.\n     */\n    output: XOTemplateOutputIdentifier;\n\n    /**\n     * Optional index of this output in the transaction.\n     */\n    outputIndex?: number;\n};\n\n/**\n * Role-specific data for a transaction within a template.\n */\nexport type XOTemplateTransactionRoleData = Partial<XOTemplateViewProperties> & {\n\n    /**\n     * The inputs required for this role.\n     */\n    inputs?: Array<XOTemplateTransactionInput>;\n\n    /**\n     * The outputs required for this role.\n     */\n    outputs?: Array<XOTemplateTransactionOutput>;\n};\n\n/**\n * A transaction template definition.\n */\nexport type XOTemplateTransaction = XOTemplateViewProperties & {\n\n    /**\n     * The version of the transaction.\n     */\n    version?: number;\n\n    /**\n     * The locktime for this transaction.\n     * - `number`: A specific locktime value.\n     * - `string`: A CashASM expression that resolves to the locktime.\n     */\n    locktime?: number | string;\n\n    /**\n     * The inputs for this transaction.\n     */\n    inputs: Array<XOTemplateTransactionInput>;\n\n    /**\n     * The outputs for this transaction.\n     */\n    outputs: Array<XOTemplateTransactionOutput>;\n\n    /**\n     * Specific context for each role participating in this transaction.\n     */\n    roles?: Record<XOTemplateRoleIdentifier, XOTemplateTransactionRoleData>;\n\n    /**\n     * Whether this transaction can be composed with other transactions.\n     */\n    composable?: boolean;\n};\n\n// ============================================================\n// Template Data\n// ============================================================\n\n/**\n * A constant value definition in the template.\n */\nexport type XOTemplateConstant = XOTemplateViewProperties & {\n\n    /**\n     * The data type of this constant.\n     */\n    type: XOTemplatePrimitiveType;\n\n    /**\n     * The value of this constant.\n     */\n    value: unknown;\n\n    /**\n     * An optional hint to help apps and users understand what this constant represents.\n     */\n    hint?: string;\n};\n\n/**\n * An import default value intent. Extends the base intent with optional view\n * properties that the engine evaluates at runtime to produce human-readable output.\n * The engine overrides whatever values are set here when resolving the target for a participant.\n */\nexport type XOTemplateImportDefaultValue = XOTemplateIntent & Partial<XOTemplateViewProperties>;\n\n/**\n * A variable definition in the template.\n */\nexport type XOTemplateVariable = XOTemplateViewProperties & {\n\n    /**\n     * The data type of this variable.\n     */\n    type?: XOTemplatePrimitiveType;\n\n    /**\n     * A hint to help users understand what value to provide.\n     */\n    hint?: string;\n\n    /**\n     * A neutral intent that the engine uses to populate the default value for this variable.\n     * View properties (name, description, icon) may contain CashASM expressions that the\n     * engine evaluates at runtime to produce human-readable output.\n     */\n    importDefaultValue?: XOTemplateImportDefaultValue;\n};\n\n/**\n * A data field definition in the template.\n *\n * @todo More work needs to be done on this type.\n */\nexport type XOTemplateData = {\n\n    /**\n     * The data type of this data field.\n     */\n    type: XOTemplatePrimitiveType;\n\n    /**\n     * The value for this data field.\n     */\n    value: unknown;\n\n    /**\n     * An optional hint to help apps and users understand this data field.\n     */\n    hint?: string;\n};\n\n// ============================================================\n// Template Resources\n// ============================================================\n\n/**\n * An icon reference in the template.\n */\nexport type XOTemplateIcon = {\n\n    /**\n     * A name for this icon.\n     */\n    name: string;\n\n    /**\n     * The identifier of the icon.\n     */\n    hash: string;\n};\n\n/**\n * A resource reference attached to a template. Extends view properties with a URL\n * pointing to external documentation or tooling.\n */\nexport type XOTemplateResource = XOTemplateViewProperties & {\n\n    /**\n     * The URL for this resource.\n     */\n    url: string;\n};\n\n// ============================================================\n// Template\n// ============================================================\n\n/**\n * Default settings applied across the template when no explicit per-action overrides are given.\n */\nexport type XOTemplateDefaults = {\n\n    /**\n     * Instructions for how to construct automated change output.\n     */\n    change?: XOTemplateOutputIntent;\n};\n\n/**\n * The XO Template.\n */\nexport type XOTemplate = XOTemplateViewProperties & {\n\n    /**\n     * The URI that identifies the JSON Schema used by this template.\n     * This enables documentation, autocompletion, and validation in JSON documents.\n     */\n    $schema: string;\n\n    /**\n     * A string identifying the version of this template.\n     */\n    version?: string;\n\n    /**\n     * The BCH VM versions that this template supports. At least one version is required.\n     */\n    supported: Array<BchVmVersion>;\n\n    /**\n     * Optional default settings used in this template.\n     */\n    defaults?: XOTemplateDefaults;\n\n    /**\n     * The roles defined in this template.\n     */\n    roles: Record<XOTemplateRoleIdentifier, XOTemplateViewProperties>;\n\n    /**\n     * A list of entry points defining which actions are available at the start.\n     */\n    start: Array<XOTemplateActionIntent>;\n\n    /**\n     * The actions defined in this template.\n     */\n    actions: Record<XOTemplateActionIdentifier, XOTemplateAction>;\n\n    /**\n     * The data fields defined in this template.\n     */\n    data?: Record<XOTemplateDataIdentifier, XOTemplateData>;\n\n    /**\n     * The transaction templates defined in this template.\n     */\n    transactions?: Record<XOTemplateTransactionIdentifier, XOTemplateTransaction>;\n\n    /**\n     * The inputs defined in this template.\n     */\n    inputs: Record<XOTemplateInputIdentifier, XOTemplateInput>;\n\n    /**\n     * The outputs defined in this template.\n     */\n    outputs: Record<XOTemplateOutputIdentifier, XOTemplateOutput>;\n\n    /**\n     * The locking script templates defined in this template.\n     */\n    lockingScripts: Record<XOTemplateLockingScriptIdentifier, XOTemplateLockingScript>;\n\n    /**\n     * The scripts used in this template, The keys are identifiers of the scripts and\n     * the values are the bytecode or cashASM expressions.\n     */\n    scripts: Record<XOTemplateScriptIdentifier, string>;\n\n    /**\n     * The constants defined in this template.\n     */\n    constants?: Record<XOTemplateConstantIdentifier, XOTemplateConstant>;\n\n    /**\n     * The variables that must be provided for use in the template's scripts.\n     */\n    variables?: Record<XOTemplateVariableIdentifier, XOTemplateVariable>;\n\n    /**\n     * Resource references providing external documentation or tooling links.\n     */\n    resources?: Array<XOTemplateResource>;\n\n    /**\n     * The icons available for use throughout the template.\n     */\n    icons?: Array<XOTemplateIcon>;\n\n    /**\n     * The scenarios defined in this template.\n     */\n    scenarios?: unknown;\n};\n"],"mappings":";;;;AAmBA,MAAa,gBAAgB;CACzB,aAAa;CACb,aAAa;CACb,aAAa;CACb,aAAa;CACb,aAAa;CACb,aAAa;CACb,aAAa;CAChB;;;;AAUD,MAAa,4BAA4B;CACrC,MAAM;CACN,SAAS;CACT,SAAS;CACZ;;;;AAaD,MAAa,yBAAyB;CAClC,KAAK;CACL,OAAO;CACP,MAAM;CACT;;;;;AAYD,MAAa,2BAA2B;CACpC,SAAS;CACT,OAAO;CACP,SAAS;CACT,QAAQ;CACR,QAAQ;CACR,aAAa;CACb,YAAY;CACf"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@xo-cash/types",
-    "version": "0.0.1",
+    "version": "0.0.2-development.15414648562",
     "description": "XO type definitions and interfaces",
     "type": "module",
     "types": "./dist/index.d.mts",
@@ -44,6 +44,9 @@
     "dependencies": {
         "@bitauth/libauth": "^3.1.0-next.8"
     },
+    "overrides": {
+        "echarts": "6.1.0"
+    },
     "devDependencies": {
         "@chalp/eslint-airbnb": "^1.3.0",
         "@generalprotocols/cspell-dictionary": "^1.0.1",