@bsv/sdk 1.4.2 → 1.4.4

package/dist/types/src/registry/types/index.d.ts

@@ -1,9 +1,7 @@
-import { PubKeyHex } from '../../wallet/index.js';
+import { BEEF, PubKeyHex, WalletProtocol } from '../../wallet/index.js';
 /**
- * Determines which category of registry item we are working with.
- * - "basket" corresponds to BasketMap
- * - "protocol" corresponds to ProtoMap
- * - "certificate"  corresponds to CertMap
+ * We unify the registry “type” to these three strings everywhere:
+ *   'basket' | 'protocol' | 'certificate'
  */
 export type DefinitionType = 'basket' | 'protocol' | 'certificate';
 /**
@@ -16,7 +14,7 @@ export interface CertificateFieldDescriptor {
     fieldIcon: string;
 }
 /**
- * Registry data for a Basket-style record (BasketMap).
+ * Registry data for a Basket-style record.
  */
 export interface BasketDefinitionData {
     definitionType: 'basket';
@@ -28,12 +26,11 @@ export interface BasketDefinitionData {
     registryOperator?: PubKeyHex;
 }
 /**
- * Registry data for a Proto-style record (ProtoMap).
+ * Registry data for a Protocol-style record.
  */
 export interface ProtocolDefinitionData {
     definitionType: 'protocol';
-    protocolID: string;
-    securityLevel: 0 | 1 | 2;
+    protocolID: WalletProtocol;
     name: string;
     iconURL: string;
     description: string;
@@ -41,7 +38,7 @@ export interface ProtocolDefinitionData {
     registryOperator?: PubKeyHex;
 }
 /**
- * Registry data for a Cert-style record (CertMap).
+ * Registry data for a Certificate-style record.
  */
 export interface CertificateDefinitionData {
     definitionType: 'certificate';
@@ -53,34 +50,64 @@ export interface CertificateDefinitionData {
     fields: Record<string, CertificateFieldDescriptor>;
     registryOperator?: PubKeyHex;
 }
+/**
+ * Union of all possible definition data objects.
+ */
 export type DefinitionData = BasketDefinitionData | ProtocolDefinitionData | CertificateDefinitionData;
+/**
+ * Common info for the on-chain token/UTXO that points to a registry entry.
+ */
 export interface TokenData {
     txid: string;
     outputIndex: number;
     satoshis: number;
     lockingScript: string;
+    beef: BEEF;
 }
+/**
+ * A registry record is a combination of the typed definition data
+ * plus the on-chain token data for the UTXO holding it.
+ */
 export type RegistryRecord = DefinitionData & TokenData;
-interface BasketMapQuery {
+/**
+ * When searching for basket definitions, we can filter by:
+ *  - basketID
+ *  - registryOperators
+ *  - name
+ */
+export interface BasketQuery {
     basketID?: string;
     registryOperators?: string[];
     name?: string;
 }
-interface ProtoMapQuery {
+/**
+ * When searching for protocol definitions, we can filter by:
+ *  - name
+ *  - registryOperators
+ *  - protocolID
+ */
+export interface ProtocolQuery {
     name?: string;
     registryOperators?: string[];
-    protocolID?: string;
-    securityLevel?: number;
+    protocolID?: WalletProtocol;
 }
-interface CertMapQuery {
+/**
+ * When searching for certificate definitions, we can filter by:
+ *  - type
+ *  - name
+ *  - registryOperators
+ */
+export interface CertificateQuery {
     type?: string;
     name?: string;
     registryOperators?: string[];
 }
+/**
+ * A lookup-service mapping of queries by each definition type.
+ */
 export interface RegistryQueryMapping {
-    basket: BasketMapQuery;
-    protocol: ProtoMapQuery;
-    certificate: CertMapQuery;
+    basket: BasketQuery;
+    protocol: ProtocolQuery;
+    certificate: CertificateQuery;
 }
-export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/registry/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/registry/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEjD;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAA;AAElE;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAA;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,cAAc,EAAE,QAAQ,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,CAAC,EAAE,SAAS,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,cAAc,EAAE,UAAU,CAAA;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,CAAC,EAAE,SAAS,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,aAAa,CAAA;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;IAClD,gBAAgB,CAAC,EAAE,SAAS,CAAA;CAC7B;AAED,MAAM,MAAM,cAAc,GACtB,oBAAoB,GACpB,sBAAsB,GACtB,yBAAyB,CAAA;AAE7B,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG,SAAS,CAAA;AAIvD,UAAU,cAAc;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,UAAU,aAAa;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,UAAU,YAAY;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,cAAc,CAAA;IACtB,QAAQ,EAAE,aAAa,CAAA;IACvB,WAAW,EAAE,YAAY,CAAA;CAC1B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/registry/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAEvE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAA;AAElE;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAA;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,cAAc,EAAE,QAAQ,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,CAAC,EAAE,SAAS,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,cAAc,EAAE,UAAU,CAAA;IAC1B,UAAU,EAAE,cAAc,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,CAAC,EAAE,SAAS,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,aAAa,CAAA;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,MAAM,CAAA;IACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;IAClD,gBAAgB,CAAC,EAAE,SAAS,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,oBAAoB,GACpB,sBAAsB,GACtB,yBAAyB,CAAA;AAE7B;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,IAAI,CAAA;CACX;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG,SAAS,CAAA;AAMvD;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,UAAU,CAAC,EAAE,cAAc,CAAA;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,WAAW,CAAA;IACnB,QAAQ,EAAE,aAAa,CAAA;IACvB,WAAW,EAAE,gBAAgB,CAAA;CAC9B"}