@xo-cash/types 0.0.6-development.16436855937 → 0.0.7-development.16733540562

package/dist/index.d.mts

@@ -671,6 +671,14 @@ type XOTemplateDefaults = {
    * Instructions for how to construct automated change output.
    */
   change?: XOTemplateOutputIntent;
+  /**
+   * Configure the default intent structure for creating receiving addresses / locking scripts.
+   */
+  address?: XOTemplateLockingScriptIntent;
+  /**
+   * Configure the default intent structure for creating receive outputs.
+   */
+  receive?: XOTemplateOutputIntent;
 };
 /**
  * The XO Template.
@@ -984,6 +992,41 @@ type XOInvitationInput = Partial<Input> & {
    */
   mergesWith?: XOInvitationMergesWithReference;
 };
+/**
+ * The token fields of an output.
+ */
+type OutputToken = NonNullable<Output['token']>;
+/**
+ * The NFT fields of an output.
+ */
+type OutputNft = NonNullable<OutputToken['nft']>;
+/**
+ * A commit may supply any subset of the following fields, hence not using the Output type or
+ * Output['token'] type.
+ */
+type XOInvitationToken = {
+  /**
+   * Fungible token amount. Omitted until a commit supplies it.
+   */
+  amount?: OutputToken['amount'];
+  /**
+   * Token category bytes. Omitted until a commit supplies them.
+   */
+  category?: OutputToken['category'];
+  /**
+   * NFT fields. Omitted when the output carries fungible tokens only.
+   */
+  nft?: {
+    /**
+     * NFT capability. Omitted until a commit supplies it.
+     */
+    capability?: OutputNft['capability'];
+    /**
+     * NFT commitment bytes. Omitted until a commit supplies them.
+     */
+    commitment?: OutputNft['commitment'];
+  };
+};
 /**
  * A transaction output provided in a commit.
  *
@@ -1009,7 +1052,11 @@ type XOInvitationInput = Partial<Input> & {
  * }
  * ```
  */
-type XOInvitationOutput = Partial<Output> & {
+type XOInvitationOutput = Omit<Partial<Output>, 'token'> & {
+  /**
+   * CashToken fields. Any field may be optional until a later commit supplies it.
+   */
+  token?: XOInvitationToken;
   /**
    * The identifier of this output.
    */
@@ -1313,5 +1360,5 @@ type XOInvitation = {
   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 };
+export { BchVmVersion, BchVmVersions, FungibleTokenAmount, OutputNft, OutputToken, Satoshis, ValueOf, XOInvitation, XOInvitationActionReference, XOInvitationCommit, XOInvitationCommitData, XOInvitationCommitDataItemIndex, XOInvitationCommitIdentifier, XOInvitationDataResult, XOInvitationEntityIdentifier, XOInvitationIdentifier, XOInvitationInput, XOInvitationMemo, XOInvitationMergesWithReference, XOInvitationOutput, XOInvitationRequirements, XOInvitationResult, XOInvitationRoleRequirement, XOInvitationSignature, XOInvitationTimestamp, XOInvitationToken, 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/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;;;;;;;;;;;;;;;;;;;;;;;;KA0BD,uBAAA,GAA0B,OAAA,QAAe,wBAAA;;KAOzC,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;;;;;;;EA6BnC,QAAA;EAdU;;;;;EAqBV,OAAA;AAAA;;;;KAMQ,uBAAA,GAA0B,wBAAA;EA3BxB;;;EAgCV,WAAA,GAAc,qBAAA;EAXd;;;EAgBA,eAAA;EAV+B;;;EAe/B,iBAAA;EAKgB;;;EAAhB,OAAA,GAAU,KAAA,CAAM,sBAAA;EAUN;;;EALV,KAAA,GAAQ,eAAA;EAsBM;;;EAjBd,OAAA,GAAU,OAAA,CAAQ,sBAAA;EAzBJ;;;EA8Bd,UAAA;EAfU;;;;;EAsBV,OAAA;EAZkB;;;EAiBlB,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,2BAAA;AAAA;;;;KAUjC,eAAA,GAAkB,wBAAA;EAAlB;;;;;EAOR,aAAA,GAAgB,QAAA;EAsBI;;;EAjBpB,KAAA,GAAQ,eAAA;EALR;;;;;EAYA,cAAA;EAUA;;;EALA,eAAA;EAkBQ;;;EAbR,iBAAA,GAAoB,sBAAA;AAAA;;;;;;;KAaZ,gBAAA,GAAmB,IAAA,CAAK,uBAAA;EAKhC;;;EAAA,aAAA,EAAe,iCAAA;EAYf;;;;AAUJ;EAfI,aAAA,GAAgB,QAAA;;;;EAKhB,KAAA,GAAQ,eAAA;AAAA;;;AA0BZ;KAhBY,0BAAA;;;;EAKR,KAAA,EAAO,yBAAA;EAqBP;;;EAhBA,UAAA;AAAA;;;;KAMQ,2BAAA;EAqBC;;;EAhBT,MAAA,EAAQ,0BAAA;EAqBO;;;EAhBf,WAAA;AAAA;;;;KAMQ,6BAAA,GAAgC,OAAA,CAAQ,wBAAA;EAUL;;AAM/C;EAXI,MAAA,GAAS,KAAA,CAAM,0BAAA;;;;EAKf,OAAA,GAAU,KAAA,CAAM,2BAAA;AAAA;;;;KAMR,qBAAA,GAAwB,wBAAA;EA2BlB;;;EAtBd,OAAA;EAOA;;;;;EAAA,QAAA;EAUe;;;EALf,MAAA,EAAQ,KAAA,CAAM,0BAAA;EAU2B;;;EALzC,OAAA,EAAS,KAAA,CAAM,2BAAA;EAoBP;;;EAfR,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,6BAAA;EAeZ;;;EAV7B,UAAA;AAAA;;;AAiCJ;KAvBY,kBAAA,GAAqB,wBAAA;;;;EAK7B,IAAA,EAAM,uBAAA;EAkB2D;;;EAbjE,KAAA;EAakE;;;EARlE,IAAA;AAAA;;;;;;KAQQ,4BAAA,GAA+B,gBAAA,GAAmB,OAAA,CAAQ,wBAAA;;;;KAK1D,kBAAA,GAAqB,wBAAA;EAiB7B;;;EAZA,IAAA,GAAO,uBAAA;EAoBC;;;EAfR,IAAA;EAoBA;;;;;EAbA,kBAAA,GAAqB,4BAAA;AAAA;;;;;AAkDzB;KA1CY,cAAA;;;;EAKR,IAAA,EAAM,uBAAA;EAoDoB;;;EA/C1B,KAAA;EA0DQ;;;EArDR,IAAA;AAAA;;;;KAUQ,cAAA;EAqED;;;EAhEP,IAAA;EA0E4C;;;EArE5C,IAAA;AAAA;;;;;KAOQ,kBAAA,GAAqB,wBAAA;EA6ErB;;;EAxER,GAAA;AAAA;;;;KAUQ,kBAAA;EAmFW;;;EA9EnB,MAAA,GAAS,sBAAA;AAAA;;;;KAMD,UAAA,GAAa,wBAAA;EAuFb;;;;EAjFR,OAAA;EAKA;;;EAAA,OAAA;EAUA;;;EALA,SAAA,EAAW,KAAA,CAAM,YAAA;EAUH;;;EALd,QAAA,GAAW,kBAAA;EAUE;;;EALb,KAAA,EAAO,MAAA,CAAO,wBAAA,EAA0B,wBAAA;EAUI;;;EAL5C,KAAA,EAAO,KAAA,CAAM,sBAAA;EAU2B;;;EALxC,OAAA,EAAS,MAAA,CAAO,0BAAA,EAA4B,gBAAA;EAUW;;;EALvD,IAAA,GAAO,MAAA,CAAO,wBAAA,EAA0B,cAAA;EAUE;;;EAL1C,YAAA,GAAe,MAAA,CAAO,+BAAA,EAAiC,qBAAA;EAUX;;;EAL5C,MAAA,EAAQ,MAAA,CAAO,yBAAA,EAA2B,eAAA;EAUgB;;;EAL1D,OAAA,EAAS,MAAA,CAAO,0BAAA,EAA4B,gBAAA;EAgB5C;;;EAXA,cAAA,EAAgB,MAAA,CAAO,iCAAA,EAAmC,uBAAA;EAgB1D;;;;EAVA,OAAA,EAAS,MAAA,CAAO,0BAAA;EAeJ;;;EAVZ,SAAA,GAAY,MAAA,CAAO,4BAAA,EAA8B,kBAAA;EAenC;;;EAVd,SAAA,GAAY,MAAA,CAAO,4BAAA,EAA8B,kBAAA;;;;EAKjD,SAAA,GAAY,KAAA,CAAM,kBAAA;ECr5BY;;;ED05B9B,KAAA,GAAQ,KAAA,CAAM,cAAA;ECr5BN;;;ED05BR,SAAA;AAAA;;;;AD/5BJ;;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;EDLF;;;ECUN,kBAAA,EAAoB,oBAAA;;;;EAKpB,gBAAA,EAAkB,0BAAA;AAAA;;;;;;;;;;;;;;ADTtB;;;;;AAOA;;;;;AAGA;;;;KC6BY,+BAAA;ED1BA;;;EC+BR,gBAAA,EAAkB,4BAAA;ED/Be;AAGrC;;;;;AAGA;;;;;ECsCI,SAAA,EAAW,+BAAA;AAAA;;;;KAMH,2BAAA;EACR,SAAA,GAAY,oBAAA;EACZ,MAAA,GAAS,iBAAA;EACT,OAAA,GAAU,kBAAA;AAAA;ADtCd;;;AAAA,KC4CY,wBAAA,GAA2B,2BAAA;EACnC,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,2BAAA;AAAA;;;;KAMjC,yBAAA;AD7CZ;;;;;AAGA;;;;;AAGA;;;;;AASA;;;;;;;;;AA2BA;AA1CA,KCwEY,oBAAA;;;;EAKR,kBAAA,EAAoB,4BAAA;EDpBF;;;ECyBlB,KAAA,EAAO,yBAAA;EDpBK;;;ECyBZ,cAAA,GAAiB,wBAAA;EDfV;;;ECoBP,UAAA,GAAa,+BAAA;AAAA;;;;;;;;;;;;;;;;;;;ADdjB;;;;;;;KC0CY,iBAAA,GAAoB,OAAA,CAAQ,KAAA;EDrCF;AAMtC;;ECoCI,eAAA,GAAkB,yBAAA;ED/BgB;;;ECoClC,gBAAA,GAAmB,iCAAA;EDpCe;;AAMtC;;ECoCI,cAAA,GAAiB,wBAAA;ED/B+B;;;ECoChD,UAAA,GAAa,+BAAA;AAAA;;ADzBjB;;;;;;;;;;;;;;;;;AAgBA;;;;;;;KCqCY,kBAAA,GAAqB,OAAA,CAAQ,MAAA;ED1BU;;;EC+B/C,gBAAA,GAAmB,0BAAA;EDpCR;;;ECyCX,gBAAA,GAAmB,kCAAA;EDpC4B;AAOnD;;ECkCI,gBAAA,GAAmB,0BAAA;ED7BnB;;AAYJ;ECsBI,cAAA,GAAiB,wBAAA;;;;EAKjB,UAAA,GAAa,+BAAA;AAAA;;;;ADXjB;;;;;;;;;;;;;;;KCgCY,sBAAA;EDtBa;;;EC2BrB,kBAAA,GAAqB,8BAAA;EDtBqB;;AAM9C;ECqBI,mBAAA,GAAsB,+BAAA;;;;EAKtB,SAAA,GAAY,oBAAA;EDrBJ;;;EC0BR,MAAA,GAAS,iBAAA;EDAF;;;ECKP,OAAA,GAAU,kBAAA;AAAA;;;;;;KAQF,gBAAA;;;;;;;;ADHZ;;;;;;;;;AAgBA;;;KCQY,kBAAA;EDHR;;;ECQA,gBAAA,EAAkB,4BAAA;EDEqB;;AAO3C;ECJI,wBAAA,EAA0B,4BAAA;;;;EAK1B,gBAAA,EAAkB,4BAAA;EDelB;;;ECVA,kBAAA,EAAoB,qBAAA;EDsBH;AAWrB;;;EC3BI,eAAA,GAAkB,2BAAA;EDgCN;;;EC3BZ,IAAA,EAAM,sBAAA;EDgCS;;;EC3Bf,SAAA,EAAW,qBAAA;ED2BX;;;ECtBA,kBAAA,EAAoB,qBAAA;EDsBsB;AAU9C;;EC3BI,IAAA,GAAO,gBAAA;AAAA;;;;KAMN,iCAAA;EDoCiB;;;EC/BlB,eAAA,EAAiB,2BAAA;EDgBqB;;;ECXtC,kBAAA,EAAoB,qBAAA;EDqBpB;;;EChBA,yBAAA,EAA2B,4BAAA;EDqBjB;;;;;ECdV,kBAAA,EAAoB,qBAAA;AAAA;ADyCxB;;;AAAA,KCnCY,uCAAA;EDwCM;;;ECnCd,sBAAA,EAAwB,qBAAA;ED4DN;;;ECvDlB,6BAAA,EAA+B,4BAAA;EDwEvB;;;;;;EChER,sBAAA,EAAwB,qBAAA;AAAA;;;;;;;;;;;;;;;;KAkBhB,6BAAA,GACR,iCAAA,IAAqC,iCAAA,GAAoC,uCAAA;ADuD7E;;;;;;;;;;;;;AAAA,KCxCY,sBAAA;ED2DR;;;ECtDA,KAAA,EAAO,yBAAA;EDgEmC;;AAa9C;ECxEI,kBAAA,EAAoB,qBAAA;;;;EAKpB,yBAAA,EAA2B,4BAAA;ED+EX;;;EC1EhB,kBAAA,EAAoB,qBAAA;AAAA;;;;;;;;;;ADyFxB;;;;;;;;;AAgBA;;;;;KC/EY,kBAAA;EDyFR;;;AAMJ;;ECxFI,YAAA,GAAe,MAAA,CAAO,+BAAA,EAAiC,6BAAA;EDwFP;;;ECnFhD,IAAA,GAAO,MAAA,CAAO,wBAAA,EAA0B,sBAAA;AAAA;;;;;;;;;;;;;;ADmG5C;;;;;;;;;;;;;KCtEY,YAAA;ED2ER;;;ECtEA,oBAAA,EAAsB,sBAAA;EDkFR;;;EC7Ed,kBAAA,EAAoB,qBAAA;EDuFpB;;;EClFA,kBAAA,EAAoB,oBAAA;EDuFpB;;;EClFA,gBAAA,EAAkB,0BAAA;ED4FQ;;;ECvF1B,OAAA,EAAS,kBAAA;ED4FT;;;ECvFA,MAAA,GAAS,kBAAA;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;;;;;;;;;;;;;;;;;;;;;;;;KA0BD,uBAAA,GAA0B,OAAA,QAAe,wBAAA;;KAOzC,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;;;;;;;EA6BnC,QAAA;EAdU;;;;;EAqBV,OAAA;AAAA;;;;KAMQ,uBAAA,GAA0B,wBAAA;EA3BxB;;;EAgCV,WAAA,GAAc,qBAAA;EAXd;;;EAgBA,eAAA;EAV+B;;;EAe/B,iBAAA;EAKgB;;;EAAhB,OAAA,GAAU,KAAA,CAAM,sBAAA;EAUN;;;EALV,KAAA,GAAQ,eAAA;EAsBM;;;EAjBd,OAAA,GAAU,OAAA,CAAQ,sBAAA;EAzBJ;;;EA8Bd,UAAA;EAfU;;;;;EAsBV,OAAA;EAZkB;;;EAiBlB,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,2BAAA;AAAA;;;;KAUjC,eAAA,GAAkB,wBAAA;EAAlB;;;;;EAOR,aAAA,GAAgB,QAAA;EAsBI;;;EAjBpB,KAAA,GAAQ,eAAA;EALR;;;;;EAYA,cAAA;EAUA;;;EALA,eAAA;EAkBQ;;;EAbR,iBAAA,GAAoB,sBAAA;AAAA;;;;;;;KAaZ,gBAAA,GAAmB,IAAA,CAAK,uBAAA;EAKhC;;;EAAA,aAAA,EAAe,iCAAA;EAYf;;;;AAUJ;EAfI,aAAA,GAAgB,QAAA;;;;EAKhB,KAAA,GAAQ,eAAA;AAAA;;;AA0BZ;KAhBY,0BAAA;;;;EAKR,KAAA,EAAO,yBAAA;EAqBP;;;EAhBA,UAAA;AAAA;;;;KAMQ,2BAAA;EAqBC;;;EAhBT,MAAA,EAAQ,0BAAA;EAqBO;;;EAhBf,WAAA;AAAA;;;;KAMQ,6BAAA,GAAgC,OAAA,CAAQ,wBAAA;EAUL;;AAM/C;EAXI,MAAA,GAAS,KAAA,CAAM,0BAAA;;;;EAKf,OAAA,GAAU,KAAA,CAAM,2BAAA;AAAA;;;;KAMR,qBAAA,GAAwB,wBAAA;EA2BlB;;;EAtBd,OAAA;EAOA;;;;;EAAA,QAAA;EAUe;;;EALf,MAAA,EAAQ,KAAA,CAAM,0BAAA;EAU2B;;;EALzC,OAAA,EAAS,KAAA,CAAM,2BAAA;EAoBP;;;EAfR,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,6BAAA;EAeZ;;;EAV7B,UAAA;AAAA;;;AAiCJ;KAvBY,kBAAA,GAAqB,wBAAA;;;;EAK7B,IAAA,EAAM,uBAAA;EAkB2D;;;EAbjE,KAAA;EAakE;;;EARlE,IAAA;AAAA;;;;;;KAQQ,4BAAA,GAA+B,gBAAA,GAAmB,OAAA,CAAQ,wBAAA;;;;KAK1D,kBAAA,GAAqB,wBAAA;EAiB7B;;;EAZA,IAAA,GAAO,uBAAA;EAoBC;;;EAfR,IAAA;EAoBA;;;;;EAbA,kBAAA,GAAqB,4BAAA;AAAA;;;;;AAkDzB;KA1CY,cAAA;;;;EAKR,IAAA,EAAM,uBAAA;EAoDoB;;;EA/C1B,KAAA;EA8DU;;;EAzDV,IAAA;AAAA;;;;KAUQ,cAAA;EA+CwB;;AAMpC;EAhDI,IAAA;;;;EAKA,IAAA;AAAA;;;;;KAOQ,kBAAA,GAAqB,wBAAA;EAwEb;;;EAnEhB,GAAA;AAAA;;;;KAUQ,kBAAA;EAwEO;;;EAnEf,MAAA,GAAS,sBAAA;EAwEmC;;;EAnE5C,OAAA,GAAU,6BAAA;EAwEM;;;EAnEhB,OAAA,GAAU,sBAAA;AAAA;;;;KAMF,UAAA,GAAa,wBAAA;EAkFH;;;;EA5ElB,OAAA;EAiFa;;;EA5Eb,OAAA;EAKA;;;EAAA,SAAA,EAAW,KAAA,CAAM,YAAA;EAKN;;;EAAX,QAAA,GAAW,kBAAA;EAK6B;;;EAAxC,KAAA,EAAO,MAAA,CAAO,wBAAA,EAA0B,wBAAA;EAUxC;;;EALA,KAAA,EAAO,KAAA,CAAM,sBAAA;EAUb;;;EALA,OAAA,EAAS,MAAA,CAAO,0BAAA,EAA4B,gBAAA;EAU5C;;;EALA,IAAA,GAAO,MAAA,CAAO,wBAAA,EAA0B,cAAA;EAUxC;;;EALA,YAAA,GAAe,MAAA,CAAO,+BAAA,EAAiC,qBAAA;EAUvD;;;EALA,MAAA,EAAQ,MAAA,CAAO,yBAAA,EAA2B,eAAA;EAU1C;;;EALA,OAAA,EAAS,MAAA,CAAO,0BAAA,EAA4B,gBAAA;EAW5C;;;EANA,cAAA,EAAgB,MAAA,CAAO,iCAAA,EAAmC,uBAAA;EAW9C;;;;EALZ,OAAA,EAAS,MAAA,CAAO,0BAAA;EAUG;;;EALnB,SAAA,GAAY,MAAA,CAAO,4BAAA,EAA8B,kBAAA;EAU/B;;;EALlB,SAAA,GAAY,MAAA,CAAO,4BAAA,EAA8B,kBAAA;EAejD;;;EAVA,SAAA,GAAY,KAAA,CAAM,kBAAA;;;AC/5BtB;EDo6BI,KAAA,GAAQ,KAAA,CAAM,cAAA;;;;EAKd,SAAA;AAAA;;;;ADz6BJ;;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;EDLF;;;ECUN,kBAAA,EAAoB,oBAAA;;;;EAKpB,gBAAA,EAAkB,0BAAA;AAAA;;;;;;;;;;;;;;ADTtB;;;;;AAOA;;;;;AAGA;;;;KC6BY,+BAAA;ED1BA;;;EC+BR,gBAAA,EAAkB,4BAAA;ED/Be;AAGrC;;;;;AAGA;;;;;ECsCI,SAAA,EAAW,+BAAA;AAAA;;;;KAMH,2BAAA;EACR,SAAA,GAAY,oBAAA;EACZ,MAAA,GAAS,iBAAA;EACT,OAAA,GAAU,kBAAA;AAAA;ADtCd;;;AAAA,KC4CY,wBAAA,GAA2B,2BAAA;EACnC,KAAA,GAAQ,MAAA,CAAO,wBAAA,EAA0B,2BAAA;AAAA;;;;KAMjC,yBAAA;AD7CZ;;;;;AAGA;;;;;AAGA;;;;;AASA;;;;;;;;;AA2BA;AA1CA,KCwEY,oBAAA;;;;EAKR,kBAAA,EAAoB,4BAAA;EDpBF;;;ECyBlB,KAAA,EAAO,yBAAA;EDpBK;;;ECyBZ,cAAA,GAAiB,wBAAA;EDfV;;;ECoBP,UAAA,GAAa,+BAAA;AAAA;;;;;;;;;;;;;;;;;;;ADdjB;;;;;;;KC0CY,iBAAA,GAAoB,OAAA,CAAQ,KAAA;EDrCF;AAMtC;;ECoCI,eAAA,GAAkB,yBAAA;ED/BgB;;;ECoClC,gBAAA,GAAmB,iCAAA;EDpCe;;AAMtC;;ECoCI,cAAA,GAAiB,wBAAA;ED/B+B;;;ECoChD,UAAA,GAAa,+BAAA;AAAA;;ADzBjB;;KC+BY,WAAA,GAAc,WAAA,CAAY,MAAA;;;;KAK1B,SAAA,GAAY,WAAA,CAAY,WAAA;;;;;KAMxB,iBAAA;EDhCR;;;ECqCA,MAAA,GAAS,WAAA;EDrCiC;AAM9C;;ECoCI,QAAA,GAAW,WAAA;EDpC4B;;;ECyCvC,GAAA;ID9B+C;;;ICmC3C,UAAA,GAAa,SAAA;IDxCjB;;;IC6CI,UAAA,GAAa,SAAA;EAAA;AAAA;ADjCrB;;;;;AAiBA;;;;;;;;;;AAgBA;;;;;;;;;;AAjCA,KC8DY,kBAAA,GAAqB,IAAA,CAAK,OAAA,CAAQ,MAAA;EDxB1C;;;EC6BA,KAAA,GAAQ,iBAAA;EDxBO;;;EC6Bf,gBAAA,GAAmB,0BAAA;EDxBH;;;EC6BhB,gBAAA,GAAmB,kCAAA;EDvBK;;;EC4BxB,gBAAA,GAAmB,0BAAA;EDvBsB;;;EC4BzC,cAAA,GAAiB,wBAAA;EDVH;;;ECed,UAAA,GAAa,+BAAA;AAAA;;;;;;;;;;;;;;;ADGjB;;;;KCkBY,sBAAA;EDbK;;;ECkBb,kBAAA,GAAqB,8BAAA;EDPb;;;ECYR,mBAAA,GAAsB,+BAAA;EDPtB;;;ECYA,SAAA,GAAY,oBAAA;EDF2B;;AAO3C;ECAI,MAAA,GAAS,iBAAA;;;;EAKT,OAAA,GAAU,kBAAA;AAAA;;;;;ADkCd;KC1BY,gBAAA;;;;;;;;;;;;;;;;AD8CZ;;;;KCzBY,kBAAA;ED8BA;;;ECzBR,gBAAA,EAAkB,4BAAA;EDmCR;;;EC9BV,wBAAA,EAA0B,4BAAA;EDeoB;;;ECV9C,gBAAA,EAAkB,4BAAA;EDoBR;;;ECfV,kBAAA,EAAoB,qBAAA;EDoBF;;;;ECdlB,eAAA,GAAkB,2BAAA;EDmCX;AAMX;;ECpCI,IAAA,EAAM,sBAAA;EDoC4B;;;EC/BlC,SAAA,EAAW,qBAAA;EDwDH;;;ECnDR,kBAAA,EAAoB,qBAAA;EDyEqB;;;ECpEzC,IAAA,GAAO,gBAAA;AAAA;;;;KAMN,iCAAA;EDmCD;;;EC9BA,eAAA,EAAiB,2BAAA;EDmCT;;;EC9BR,kBAAA,EAAoB,qBAAA;EDwCpB;;;ECnCA,yBAAA,EAA2B,4BAAA;ED+CZ;;;;AAUnB;EClDI,kBAAA,EAAoB,qBAAA;AAAA;;;;KAMZ,uCAAA;EDyEkC;;;ECpE1C,sBAAA,EAAwB,qBAAA;ED8CR;;;ECzChB,6BAAA,EAA+B,4BAAA;ED0D/B;;;;;AAkBJ;ECpEI,sBAAA,EAAwB,qBAAA;AAAA;;;;;;;;;;;;;;;;KAkBhB,6BAAA,GACR,iCAAA,IAAqC,iCAAA,GAAoC,uCAAA;;AD4E7E;;;;;;;;;AAgBA;;;KC7EY,sBAAA;EDkFR;;;EC7EA,KAAA,EAAO,yBAAA;EDkFI;AAMf;;ECnFI,kBAAA,EAAoB,qBAAA;EDmF4B;;;EC9EhD,yBAAA,EAA2B,4BAAA;EDwFX;;;ECnFhB,kBAAA,EAAoB,qBAAA;AAAA;;;;;;;;;;ADyFxB;;;;;;;;;;;;;;KC/DY,kBAAA;ED2ER;;;;;ECpEA,YAAA,GAAe,MAAA,CAAO,+BAAA,EAAiC,6BAAA;ED8ExC;;;ECzEf,IAAA,GAAO,MAAA,CAAO,wBAAA,EAA0B,sBAAA;AAAA;;;;AD6F5C;;;;;;;;;;;AAuBA;;;;;;;;;;;;KCvFY,YAAA;ED4FA;;;ECvFR,oBAAA,EAAsB,sBAAA;ED4Ff;;;ECvFP,kBAAA,EAAoB,qBAAA;EDkFS;;;EC7E7B,kBAAA,EAAoB,oBAAA;ED8FpB;;;ECzFA,gBAAA,EAAkB,0BAAA;EDiGV;;;EC5FR,OAAA,EAAS,kBAAA;EDiGT;;;EC5FA,MAAA,GAAS,kBAAA;AAAA"}

package/dist/index.mjs.map

@@ -1 +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    EXTENDED_PUBLIC_KEY: 'extended_public_key',\n    SATOSHIS: 'satoshis',\n    FUNGIBLE_TOKEN_AMOUNT: 'token_amount',\n    NON_FUNGIBLE_TOKEN_CAPABILITY: 'token_capability',\n    NON_FUNGIBLE_TOKEN_COMMITMENT: 'token_commitment',\n    TIMESTAMP: 'timestamp',\n    TOKEN_CATEGORY: 'token_category',\n    NFT_COMMITMENT: 'nft_commitment',\n    LOCKING_SCRIPT: 'locking_script',\n    TRANSACTION_HASH: 'transaction_hash',\n    TEMPLATE_IDENTIFIER: 'template_identifier',\n    SCHNORR_SIGNATURE: 'signature',\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     * Whether this output or locking script should be tracked by the engine.\n     * When omitted, the engine treats this field as true.\n     * - `true`: Include it.\n     * - `false`: Exclude it.\n     * - `string`: A CashASM expression that evaluates to a boolean relevance value.\n     */\n    relevant?: boolean | string;\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?: unknown;\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?: unknown;\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?: unknown;\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;CACZ,qBAAqB;CACrB,UAAU;CACV,uBAAuB;CACvB,+BAA+B;CAC/B,+BAA+B;CAC/B,WAAW;CACX,gBAAgB;CAChB,gBAAgB;CAChB,gBAAgB;CAChB,kBAAkB;CAClB,qBAAqB;CACrB,mBAAmB;CACtB"}
+{"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    EXTENDED_PUBLIC_KEY: 'extended_public_key',\n    SATOSHIS: 'satoshis',\n    FUNGIBLE_TOKEN_AMOUNT: 'token_amount',\n    NON_FUNGIBLE_TOKEN_CAPABILITY: 'token_capability',\n    NON_FUNGIBLE_TOKEN_COMMITMENT: 'token_commitment',\n    TIMESTAMP: 'timestamp',\n    TOKEN_CATEGORY: 'token_category',\n    NFT_COMMITMENT: 'nft_commitment',\n    LOCKING_SCRIPT: 'locking_script',\n    TRANSACTION_HASH: 'transaction_hash',\n    TEMPLATE_IDENTIFIER: 'template_identifier',\n    SCHNORR_SIGNATURE: 'signature',\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     * Whether this output or locking script should be tracked by the engine.\n     * When omitted, the engine treats this field as true.\n     * - `true`: Include it.\n     * - `false`: Exclude it.\n     * - `string`: A CashASM expression that evaluates to a boolean relevance value.\n     */\n    relevant?: boolean | string;\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?: unknown;\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?: unknown;\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?: unknown;\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     * Configure the default intent structure for creating receiving addresses / locking scripts.\n     */\n    address?: XOTemplateLockingScriptIntent;\n\n    /**\n     * Configure the default intent structure for creating receive outputs.\n     */\n    receive?: 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;CACZ,qBAAqB;CACrB,UAAU;CACV,uBAAuB;CACvB,+BAA+B;CAC/B,+BAA+B;CAC/B,WAAW;CACX,gBAAgB;CAChB,gBAAgB;CAChB,gBAAgB;CAChB,kBAAkB;CAClB,qBAAqB;CACrB,mBAAmB;CACtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@xo-cash/types",
-    "version": "0.0.6-development.16436855937",
+    "version": "0.0.7-development.16733540562",
     "description": "XO type definitions and interfaces",
     "type": "module",
     "types": "./dist/index.d.mts",