@unicitylabs/sphere-sdk 0.17.2-dev.1 → 0.17.2-dev.3

package/dist/modules/payments-v2/index.cjs

@@ -36,6 +36,7 @@ __export(payments_v2_exports, {
   HEARTBEAT_CAP_MS: () => HEARTBEAT_CAP_MS,
   HEARTBEAT_SEED_MS: () => HEARTBEAT_SEED_MS,
   MAX_RESELECT: () => MAX_RESELECT,
+  NFT_DOCUMENT_MEDIA_TYPE: () => NFT_DOCUMENT_MEDIA_TYPE,
   NFT_LINK_TAG: () => NFT_LINK_TAG,
   NFT_MAX_PAYLOAD_BYTES: () => NFT_MAX_PAYLOAD_BYTES,
   NFT_MEDIA_TAG: () => NFT_MEDIA_TAG,
@@ -45,7 +46,9 @@ __export(payments_v2_exports, {
   STORE_KEYS: () => STORE_KEYS,
   createScopedKV: () => createScopedKV,
   encodeNftContent: () => encodeNftContent,
+  isNftDocumentLink: () => isNftDocumentLink,
   isRetryableAckError: () => isRetryableAckError,
+  parseNftDocument: () => parseNftDocument,
   parseNftPayload: () => parseNftPayload,
   supportsDeterministicMint: () => supportsDeterministicMint,
   sweepSupersededState: () => sweepSupersededState,
@@ -509,7 +512,8 @@ var NFT_MEDIA_TAG = 39053n;
 var NFT_LINK_TAG = 39054n;
 var NFT_SIGNED_TAG = 39055n;
 var NFT_FORMAT_VERSION = 1n;
-var METADATA_ARITY = 8;
+var NFT_DOCUMENT_MEDIA_TYPE = "application/vnd.unicity.nft+cbor";
+var METADATA_ARITY = 9;
 var MEDIA_ARITY = 3;
 var LINK_ARITY = 4;
 var SIGNED_ARITY = 4;
@@ -517,11 +521,15 @@ var CREATOR_BYTES = 33;
 var SIGNATURE_BYTES = 65;
 var MAX_URI_LENGTH = 2048;
 var LINK_SCHEMES = ["https://", "ipfs://", "ar://"];
+var SIGNED_DOMAIN = new TextEncoder().encode("UNICITY_NFT_SIGNED");
 var MEDIA_TYPE_PATTERN = /^[a-z0-9][a-z0-9!#$&^_.+-]{0,126}\/[a-z0-9][a-z0-9!#$&^_.+-]{0,126}$/;
 var SHA256_HEX_PATTERN = /^[0-9a-f]{64}$/i;
+var COLLECTION_ID_PATTERN = /^(?:[0-9a-f]{2}){1,64}$/i;
 var LONE_SURROGATE = /\p{Cs}/u;
 var CBOR_MAJOR_TYPE_MASK = 224;
 var ATTRIBUTE_VALUE_RULE = "must be non-empty text or an integer within \xB1(2^53 \u2212 1) \u2014 write decimals and larger numbers as text";
+var COLLECTION_ID_RULE = "must be null or 1\u201364 bytes as even-length hex (2\u2013128 characters)";
+var DOCUMENT_AS_MEDIA_RULE = `must not be ${NFT_DOCUMENT_MEDIA_TYPE}: a document link is a token's content, never media`;
 var UTF8 = new TextDecoder("utf-8", { fatal: true, ignoreBOM: true });
 function refuse(field, rule, cause) {
   return new SphereError(`Invalid NFT ${field}: ${rule}`, "VALIDATION_ERROR", cause);
@@ -533,6 +541,7 @@ var fieldName = (prefix, name) => prefix === "" ? name : `${prefix}.${name}`;
 var isText = (value) => typeof value === "string" && value.length > 0 && !LONE_SURROGATE.test(value);
 var isBytes2 = (value, length) => value instanceof Uint8Array && (length === void 0 ? value.length > 0 : value.length === length);
 var isMediaType = (value) => typeof value === "string" && MEDIA_TYPE_PATTERN.test(value);
+var isCollectionId = (value) => typeof value === "string" && COLLECTION_ID_PATTERN.test(value);
 var isAttributeValue = (value) => typeof value === "number" ? Number.isSafeInteger(value) : isText(value);
 function hasSpaceOrControl(value) {
   for (let i = 0; i < value.length; i++) {
@@ -575,8 +584,9 @@ function checkLink(prefix, link) {
 function checkMediaRef(field, ref) {
   if (ref === null) return;
   if (ref?.kind === "media") return checkMedia(field, ref);
-  if (ref?.kind === "link") return checkLink(field, ref);
-  throw refuse(field, "must be an NftMedia, an NftLink or null");
+  if (ref?.kind !== "link") throw refuse(field, "must be an NftMedia, an NftLink or null");
+  checkLink(field, ref);
+  ensure(!isNftDocumentLink(ref), fieldName(field, "media_type"), DOCUMENT_AS_MEDIA_RULE);
 }
 function checkAttributes(attributes) {
   ensure(Array.isArray(attributes), "attributes", "must be an array \u2014 [] when there are none");
@@ -593,6 +603,7 @@ function checkMetadata(metadata) {
   checkOptionalText("external_url", metadata.external_url);
   checkAttributes(metadata.attributes);
   checkOptionalText("collection", metadata.collection);
+  ensure(metadata.collection_id === null || isCollectionId(metadata.collection_id), "collection_id", COLLECTION_ID_RULE);
 }
 function checkContent(content) {
   switch (content?.kind) {
@@ -650,6 +661,7 @@ function arrayCbor(items) {
   }
   return out;
 }
+var optionalHexBytes = (value) => import_CborSerializer.CborSerializer.encodeNullable(value, (hex) => import_CborSerializer.CborSerializer.encodeByteString(import_HexConverter.HexConverter.decode(hex.toLowerCase())));
 function metadataCbor(metadata) {
   return versioned(
     NFT_METADATA_TAG,
@@ -659,7 +671,8 @@ function metadataCbor(metadata) {
     mediaRefCbor(metadata.animation_url),
     optionalText(metadata.external_url),
     arrayCbor(metadata.attributes.map(attributeCbor)),
-    optionalText(metadata.collection)
+    optionalText(metadata.collection),
+    optionalHexBytes(metadata.collection_id)
   );
 }
 function encodeNftContent(content) {
@@ -700,13 +713,14 @@ function decodeMedia(body) {
   const [, mediaType, bytes] = versionedFields(body, MEDIA_ARITY);
   return { kind: "media", media_type: decodeText(mediaType), bytes: import_CborDeserializer.CborDeserializer.decodeByteString(bytes) };
 }
+var decodeHex = (item) => import_HexConverter.HexConverter.encode(import_CborDeserializer.CborDeserializer.decodeByteString(item));
 function decodeLink(body) {
   const [, mediaType, uri, digest] = versionedFields(body, LINK_ARITY);
   return {
     kind: "link",
     media_type: decodeText(mediaType),
     uri: decodeText(uri),
-    sha256: import_HexConverter.HexConverter.encode(import_CborDeserializer.CborDeserializer.decodeByteString(digest))
+    sha256: decodeHex(digest)
   };
 }
 function decodeMetadata(body) {
@@ -719,7 +733,8 @@ function decodeMetadata(body) {
     animation_url: decodeMediaRef("animation_url", fields[4]),
     external_url: decodeOptionalText(fields[5]),
     attributes: decodeAttributes(fields[6]),
-    collection: decodeOptionalText(fields[7])
+    collection: decodeOptionalText(fields[7]),
+    collection_id: import_CborDeserializer.CborDeserializer.decodeNullable(fields[8], decodeHex)
   };
 }
 var MEDIA_REF_DECODERS = /* @__PURE__ */ new Map([
@@ -731,6 +746,10 @@ var UNSIGNED_DECODERS = /* @__PURE__ */ new Map([
   [NFT_MEDIA_TAG, decodeMedia],
   [NFT_LINK_TAG, decodeLink]
 ]);
+var DOCUMENT_DECODERS = /* @__PURE__ */ new Map([
+  [NFT_METADATA_TAG, decodeMetadata],
+  [NFT_MEDIA_TAG, decodeMedia]
+]);
 function decodeBody(decoders, field, tag, body) {
   const decode = decoders.get(tag);
   if (decode === void 0) throw refuse(field, `tag ${tag} is not allowed here`);
@@ -765,6 +784,18 @@ function parseNftPayload(data) {
     return null;
   }
 }
+function parseNftDocument(bytes) {
+  try {
+    const document = decodeItem(DOCUMENT_DECODERS, "document", bytes);
+    checkContent(document);
+    return document;
+  } catch {
+    return null;
+  }
+}
+function isNftDocumentLink(content) {
+  return content?.kind === "link" && content.media_type === NFT_DOCUMENT_MEDIA_TYPE;
+}
 function verifyNftLinkContent(link, bytes) {
   return import_HexConverter.HexConverter.encode(sha256(bytes)) === link.sha256.toLowerCase();
 }
@@ -5793,6 +5824,7 @@ var PaymentsFacade = class {
   HEARTBEAT_CAP_MS,
   HEARTBEAT_SEED_MS,
   MAX_RESELECT,
+  NFT_DOCUMENT_MEDIA_TYPE,
   NFT_LINK_TAG,
   NFT_MAX_PAYLOAD_BYTES,
   NFT_MEDIA_TAG,
@@ -5802,7 +5834,9 @@ var PaymentsFacade = class {
   STORE_KEYS,
   createScopedKV,
   encodeNftContent,
+  isNftDocumentLink,
   isRetryableAckError,
+  parseNftDocument,
   parseNftPayload,
   supportsDeterministicMint,
   sweepSupersededState,