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

package/dist/index.d.cts

@@ -86,6 +86,8 @@ declare const NFT_METADATA_TAG = 39052n;
 declare const NFT_MEDIA_TAG = 39053n;
 declare const NFT_LINK_TAG = 39054n;
 declare const NFT_SIGNED_TAG = 39055n;
+/** The media type of an NftLink that points at a metadata document instead of a media file. */
+declare const NFT_DOCUMENT_MEDIA_TYPE = "application/vnd.unicity.nft+cbor";
 /** An inline file. */
 interface NftMedia {
     readonly kind: 'media';
@@ -115,6 +117,8 @@ interface NftMetadata {
     readonly external_url: string | null;
     readonly attributes: readonly NftAttribute[];
     readonly collection: string | null;
+    /** The collection the item claims: 1–64 bytes as even-length hex (decoded lowercase). Never verified here. */
+    readonly collection_id: string | null;
 }
 type NftContent = NftMetadata | NftMedia | NftLink;
 type NftSignatureStatus = 'unsigned' | 'valid' | 'invalid';
@@ -127,10 +131,27 @@ interface ParsedNft {
         readonly signature: Uint8Array;
     } | null;
 }
+/** What an NftSigned signature binds besides its payload, exactly as the token's mint records it. */
+interface NftSignatureContext {
+    /** The network identifier α (`NetworkId.id`). */
+    readonly networkId: number | bigint;
+    /** The genesis recipient predicate, as `EncodedPredicate.toCBOR()` bytes. */
+    readonly recipientPredicate: Uint8Array;
+    /** The 32 raw token id bytes. */
+    readonly tokenId: Uint8Array;
+    readonly tokenType: Uint8Array;
+}
 /** Encode one unsigned item. Throws SphereError('…', 'VALIDATION_ERROR') naming the offending field. */
 declare function encodeNftContent(content: NftContent): Uint8Array;
 /** Structural parse of a genesis payload. NEVER throws; null = not a recognised NFT. */
 declare function parseNftPayload(data: Uint8Array | null): ParsedNft | null;
+/**
+ * Parse the file a document link points at: exactly one NftMetadata or NftMedia item.
+ * NEVER throws; null = not a document. Check the bytes with verifyNftLinkContent first.
+ */
+declare function parseNftDocument(bytes: Uint8Array): NftMetadata | NftMedia | null;
+/** Is this an NftLink to a metadata document ({@link NFT_DOCUMENT_MEDIA_TYPE}), resolved with parseNftDocument? */
+declare function isNftDocumentLink(content: NftContent): boolean;
 /** Does `bytes` match the link's sha256? Pure, sync. */
 declare function verifyNftLinkContent(link: NftLink, bytes: Uint8Array): boolean;
 
@@ -4894,4 +4915,4 @@ declare function normalizeAddress(address: string): string;
  */
 declare function addressesMatch(a: string, b: string): boolean;
 
-export { AUTH_CHALLENGE_PREFIX, type AddressInfo, type AddressType, type AggregatorEvent, type AggregatorEventCallback, type AggregatorEventType, type AggregatorProvider, type Asset, type BaseProvider, type BroadcastHandler, type BroadcastMessage, COIN_TYPES, ChallengeTemplateError, type CheckNetworkHealthOptions, CoinGeckoPriceProvider, type CoinlessToken, CommunicationsModule, type CommunicationsModuleConfig, type CommunicationsModuleDependencies, type ComposingIndicator, type ConversationPage, type CreateGroupOptions, DEFAULT_AGGREGATOR_TIMEOUT, DEFAULT_DERIVATION_PATH, DEFAULT_GROUP_RELAYS, DEFAULT_MARKET_API_URL, DEFAULT_NOSTR_RELAYS, type DecryptionProgressCallback, type DerivationMode, type DirectMessage, type DiscoverAddressProgress, type DiscoverAddressesOptions, type DiscoverAddressesResult, type DiscoveredAddress, type EncryptedData, FIELD_ENCRYPTION_HKDF_INFO, FIELD_ENVELOPE_MAX_BYTES, FIELD_ENVELOPE_NONCE_BYTES, FIELD_ENVELOPE_PREFIX, type FullIdentity, type GetConversationPageOptions, GroupChatModule, type GroupChatModuleConfig, type GroupChatModuleDependencies, type GroupData, type GroupMemberData, type GroupMessageData, GroupRole, GroupVisibility, type HealthCheckFn, type HistoryRecord, type Identity, type IdentityConfig, type IncomingBroadcast, type IncomingMessage, type IncomingTransfer, type InitProgress, type InitProgressCallback, type InitProgressStep, type IntentStatus, type IntentType, LIMITS, type LegacyFileParseResult, type LegacyFileParsedData, type LegacyFileType, type LogHandler, type LogLevel, type LoggerConfig, type MarketIntent, MarketModule, type MarketModuleConfig, type MarketModuleDependencies, type MessageHandler, type MintNftRequest, NETWORKS, NFT_LINK_TAG, NFT_MAX_PAYLOAD_BYTES, NFT_MEDIA_TAG, NFT_METADATA_TAG, NFT_SIGNED_TAG, NIP29_KINDS, NOSTR_EVENT_KINDS, type NetworkHealthResult, type NetworkType, type NftAttribute, type NftContent, type NftLink, type NftMedia, type NftMediaRef, type NftMetadata, type NftSignatureStatus, type NftView, type OracleEvent, type OracleEventCallback, type OracleEventType, type OracleProvider, type ParsedAddress, PartialSendConflictError, type PeerInfo, type PostIntentRequest, type PostIntentResult, type PricePlatform, type PriceProvider, type PriceProviderConfig, type ProviderMetadata, type ProviderRole, type ProviderStatus, type ProviderStatusInfo, type RegistryNetwork, SIGN_MESSAGE_PREFIX, STORAGE_KEYS_ADDRESS, STORAGE_KEYS_GLOBAL, STORAGE_PREFIX, type SearchFilters, type SearchIntentResult, type SearchOptions, type SearchResult, type ServiceHealthResult, Sphere, type SphereCreateOptions, SphereError, type SphereErrorCode, type SphereEventHandler, type SphereEventMap, type SphereEventType, type SphereImportOptions, type SphereInitOptions, type SphereInitResult, type SphereLoadOptions, type SphereStatus, type StorageProvider, TEST_NOSTR_RELAYS, TIMEOUTS, type Token, type TokenDefinition, type TokenIcon, type TokenPrice, TokenRegistry, type TokenStatus, type TokenTransferDetail, type TrackedAddress, type TrackedAddressEntry, type HistoryRecord as TransactionHistoryEntry, type TransferRequest, type TransferResult, type TransferStatus, type TransportEvent, type TransportEventCallback, type TransportEventType, type TransportProvider, type WalletApiTransportConfig, type WalletInfo, type WalletJSON, type WalletJSONExportOptions, type WalletSource, addressesMatch, assertFieldEnvelopeShape, base58Decode, base58Encode, bytesToHex, checkNetworkHealth, coinIdsMatch, createCommunicationsModule, createGroupChatModule, createKeyPair, createMarketModule, createPriceProvider, createSphere, decrypt, decryptField, decryptFieldBytes, decryptJson, decryptMnemonic, decryptSimple, decryptTextFormatKey, decryptWithSalt, deriveAddressInfo, deriveChildKey, deriveFieldEncryptionKey, deriveKeyAtPath, doubleSha256, encodeNftContent, encrypt, encryptField, encryptFieldBytes, encryptMnemonic, encryptSimple, extractFromText, findPattern, formatAmount, generateAddressFromMasterKey, generateMasterKey, generateMnemonic, getAddressId, getAddressStorageKey, getCoinIdByName, getCoinIdBySymbol, getPublicKey, getTokenDecimals, getTokenDefinition, getTokenIconUrl, getTokenName, getTokenSymbol, hash160, hashSignMessage, hexToBytes, identityFromMnemonicSync, initSphere, isKnownToken, isPossiblyCommittedSendOutcome, isSphereError, isTextWalletEncrypted, isValidAddress, isValidDirectAddress, isValidNametag, isValidPrivateKey, isWalletTextFormat, loadSphere, logger, mnemonicToSeedSync, normalizeAddress, normalizeCoinId, parseAddress, parseAndDecryptWalletText, parseNftPayload, parseTokenAmount, parseWalletText, randomBytes, randomHex, randomUUID, recoverPubkeyFromSignature, ripemd160, safeParseTokenAmount, sha256, signMessage, sleep, sphereExists, toHumanReadable, validateMnemonic, verifyChallengeTemplate, verifyNftLinkContent, verifySignedMessage };
+export { AUTH_CHALLENGE_PREFIX, type AddressInfo, type AddressType, type AggregatorEvent, type AggregatorEventCallback, type AggregatorEventType, type AggregatorProvider, type Asset, type BaseProvider, type BroadcastHandler, type BroadcastMessage, COIN_TYPES, ChallengeTemplateError, type CheckNetworkHealthOptions, CoinGeckoPriceProvider, type CoinlessToken, CommunicationsModule, type CommunicationsModuleConfig, type CommunicationsModuleDependencies, type ComposingIndicator, type ConversationPage, type CreateGroupOptions, DEFAULT_AGGREGATOR_TIMEOUT, DEFAULT_DERIVATION_PATH, DEFAULT_GROUP_RELAYS, DEFAULT_MARKET_API_URL, DEFAULT_NOSTR_RELAYS, type DecryptionProgressCallback, type DerivationMode, type DirectMessage, type DiscoverAddressProgress, type DiscoverAddressesOptions, type DiscoverAddressesResult, type DiscoveredAddress, type EncryptedData, FIELD_ENCRYPTION_HKDF_INFO, FIELD_ENVELOPE_MAX_BYTES, FIELD_ENVELOPE_NONCE_BYTES, FIELD_ENVELOPE_PREFIX, type FullIdentity, type GetConversationPageOptions, GroupChatModule, type GroupChatModuleConfig, type GroupChatModuleDependencies, type GroupData, type GroupMemberData, type GroupMessageData, GroupRole, GroupVisibility, type HealthCheckFn, type HistoryRecord, type Identity, type IdentityConfig, type IncomingBroadcast, type IncomingMessage, type IncomingTransfer, type InitProgress, type InitProgressCallback, type InitProgressStep, type IntentStatus, type IntentType, LIMITS, type LegacyFileParseResult, type LegacyFileParsedData, type LegacyFileType, type LogHandler, type LogLevel, type LoggerConfig, type MarketIntent, MarketModule, type MarketModuleConfig, type MarketModuleDependencies, type MessageHandler, type MintNftRequest, NETWORKS, NFT_DOCUMENT_MEDIA_TYPE, NFT_LINK_TAG, NFT_MAX_PAYLOAD_BYTES, NFT_MEDIA_TAG, NFT_METADATA_TAG, NFT_SIGNED_TAG, NIP29_KINDS, NOSTR_EVENT_KINDS, type NetworkHealthResult, type NetworkType, type NftAttribute, type NftContent, type NftLink, type NftMedia, type NftMediaRef, type NftMetadata, type NftSignatureContext, type NftSignatureStatus, type NftView, type OracleEvent, type OracleEventCallback, type OracleEventType, type OracleProvider, type ParsedAddress, PartialSendConflictError, type PeerInfo, type PostIntentRequest, type PostIntentResult, type PricePlatform, type PriceProvider, type PriceProviderConfig, type ProviderMetadata, type ProviderRole, type ProviderStatus, type ProviderStatusInfo, type RegistryNetwork, SIGN_MESSAGE_PREFIX, STORAGE_KEYS_ADDRESS, STORAGE_KEYS_GLOBAL, STORAGE_PREFIX, type SearchFilters, type SearchIntentResult, type SearchOptions, type SearchResult, type ServiceHealthResult, Sphere, type SphereCreateOptions, SphereError, type SphereErrorCode, type SphereEventHandler, type SphereEventMap, type SphereEventType, type SphereImportOptions, type SphereInitOptions, type SphereInitResult, type SphereLoadOptions, type SphereStatus, type StorageProvider, TEST_NOSTR_RELAYS, TIMEOUTS, type Token, type TokenDefinition, type TokenIcon, type TokenPrice, TokenRegistry, type TokenStatus, type TokenTransferDetail, type TrackedAddress, type TrackedAddressEntry, type HistoryRecord as TransactionHistoryEntry, type TransferRequest, type TransferResult, type TransferStatus, type TransportEvent, type TransportEventCallback, type TransportEventType, type TransportProvider, type WalletApiTransportConfig, type WalletInfo, type WalletJSON, type WalletJSONExportOptions, type WalletSource, addressesMatch, assertFieldEnvelopeShape, base58Decode, base58Encode, bytesToHex, checkNetworkHealth, coinIdsMatch, createCommunicationsModule, createGroupChatModule, createKeyPair, createMarketModule, createPriceProvider, createSphere, decrypt, decryptField, decryptFieldBytes, decryptJson, decryptMnemonic, decryptSimple, decryptTextFormatKey, decryptWithSalt, deriveAddressInfo, deriveChildKey, deriveFieldEncryptionKey, deriveKeyAtPath, doubleSha256, encodeNftContent, encrypt, encryptField, encryptFieldBytes, encryptMnemonic, encryptSimple, extractFromText, findPattern, formatAmount, generateAddressFromMasterKey, generateMasterKey, generateMnemonic, getAddressId, getAddressStorageKey, getCoinIdByName, getCoinIdBySymbol, getPublicKey, getTokenDecimals, getTokenDefinition, getTokenIconUrl, getTokenName, getTokenSymbol, hash160, hashSignMessage, hexToBytes, identityFromMnemonicSync, initSphere, isKnownToken, isNftDocumentLink, isPossiblyCommittedSendOutcome, isSphereError, isTextWalletEncrypted, isValidAddress, isValidDirectAddress, isValidNametag, isValidPrivateKey, isWalletTextFormat, loadSphere, logger, mnemonicToSeedSync, normalizeAddress, normalizeCoinId, parseAddress, parseAndDecryptWalletText, parseNftDocument, parseNftPayload, parseTokenAmount, parseWalletText, randomBytes, randomHex, randomUUID, recoverPubkeyFromSignature, ripemd160, safeParseTokenAmount, sha256, signMessage, sleep, sphereExists, toHumanReadable, validateMnemonic, verifyChallengeTemplate, verifyNftLinkContent, verifySignedMessage };

package/dist/index.d.ts

@@ -86,6 +86,8 @@ declare const NFT_METADATA_TAG = 39052n;
 declare const NFT_MEDIA_TAG = 39053n;
 declare const NFT_LINK_TAG = 39054n;
 declare const NFT_SIGNED_TAG = 39055n;
+/** The media type of an NftLink that points at a metadata document instead of a media file. */
+declare const NFT_DOCUMENT_MEDIA_TYPE = "application/vnd.unicity.nft+cbor";
 /** An inline file. */
 interface NftMedia {
     readonly kind: 'media';
@@ -115,6 +117,8 @@ interface NftMetadata {
     readonly external_url: string | null;
     readonly attributes: readonly NftAttribute[];
     readonly collection: string | null;
+    /** The collection the item claims: 1–64 bytes as even-length hex (decoded lowercase). Never verified here. */
+    readonly collection_id: string | null;
 }
 type NftContent = NftMetadata | NftMedia | NftLink;
 type NftSignatureStatus = 'unsigned' | 'valid' | 'invalid';
@@ -127,10 +131,27 @@ interface ParsedNft {
         readonly signature: Uint8Array;
     } | null;
 }
+/** What an NftSigned signature binds besides its payload, exactly as the token's mint records it. */
+interface NftSignatureContext {
+    /** The network identifier α (`NetworkId.id`). */
+    readonly networkId: number | bigint;
+    /** The genesis recipient predicate, as `EncodedPredicate.toCBOR()` bytes. */
+    readonly recipientPredicate: Uint8Array;
+    /** The 32 raw token id bytes. */
+    readonly tokenId: Uint8Array;
+    readonly tokenType: Uint8Array;
+}
 /** Encode one unsigned item. Throws SphereError('…', 'VALIDATION_ERROR') naming the offending field. */
 declare function encodeNftContent(content: NftContent): Uint8Array;
 /** Structural parse of a genesis payload. NEVER throws; null = not a recognised NFT. */
 declare function parseNftPayload(data: Uint8Array | null): ParsedNft | null;
+/**
+ * Parse the file a document link points at: exactly one NftMetadata or NftMedia item.
+ * NEVER throws; null = not a document. Check the bytes with verifyNftLinkContent first.
+ */
+declare function parseNftDocument(bytes: Uint8Array): NftMetadata | NftMedia | null;
+/** Is this an NftLink to a metadata document ({@link NFT_DOCUMENT_MEDIA_TYPE}), resolved with parseNftDocument? */
+declare function isNftDocumentLink(content: NftContent): boolean;
 /** Does `bytes` match the link's sha256? Pure, sync. */
 declare function verifyNftLinkContent(link: NftLink, bytes: Uint8Array): boolean;
 
@@ -4894,4 +4915,4 @@ declare function normalizeAddress(address: string): string;
  */
 declare function addressesMatch(a: string, b: string): boolean;
 
-export { AUTH_CHALLENGE_PREFIX, type AddressInfo, type AddressType, type AggregatorEvent, type AggregatorEventCallback, type AggregatorEventType, type AggregatorProvider, type Asset, type BaseProvider, type BroadcastHandler, type BroadcastMessage, COIN_TYPES, ChallengeTemplateError, type CheckNetworkHealthOptions, CoinGeckoPriceProvider, type CoinlessToken, CommunicationsModule, type CommunicationsModuleConfig, type CommunicationsModuleDependencies, type ComposingIndicator, type ConversationPage, type CreateGroupOptions, DEFAULT_AGGREGATOR_TIMEOUT, DEFAULT_DERIVATION_PATH, DEFAULT_GROUP_RELAYS, DEFAULT_MARKET_API_URL, DEFAULT_NOSTR_RELAYS, type DecryptionProgressCallback, type DerivationMode, type DirectMessage, type DiscoverAddressProgress, type DiscoverAddressesOptions, type DiscoverAddressesResult, type DiscoveredAddress, type EncryptedData, FIELD_ENCRYPTION_HKDF_INFO, FIELD_ENVELOPE_MAX_BYTES, FIELD_ENVELOPE_NONCE_BYTES, FIELD_ENVELOPE_PREFIX, type FullIdentity, type GetConversationPageOptions, GroupChatModule, type GroupChatModuleConfig, type GroupChatModuleDependencies, type GroupData, type GroupMemberData, type GroupMessageData, GroupRole, GroupVisibility, type HealthCheckFn, type HistoryRecord, type Identity, type IdentityConfig, type IncomingBroadcast, type IncomingMessage, type IncomingTransfer, type InitProgress, type InitProgressCallback, type InitProgressStep, type IntentStatus, type IntentType, LIMITS, type LegacyFileParseResult, type LegacyFileParsedData, type LegacyFileType, type LogHandler, type LogLevel, type LoggerConfig, type MarketIntent, MarketModule, type MarketModuleConfig, type MarketModuleDependencies, type MessageHandler, type MintNftRequest, NETWORKS, NFT_LINK_TAG, NFT_MAX_PAYLOAD_BYTES, NFT_MEDIA_TAG, NFT_METADATA_TAG, NFT_SIGNED_TAG, NIP29_KINDS, NOSTR_EVENT_KINDS, type NetworkHealthResult, type NetworkType, type NftAttribute, type NftContent, type NftLink, type NftMedia, type NftMediaRef, type NftMetadata, type NftSignatureStatus, type NftView, type OracleEvent, type OracleEventCallback, type OracleEventType, type OracleProvider, type ParsedAddress, PartialSendConflictError, type PeerInfo, type PostIntentRequest, type PostIntentResult, type PricePlatform, type PriceProvider, type PriceProviderConfig, type ProviderMetadata, type ProviderRole, type ProviderStatus, type ProviderStatusInfo, type RegistryNetwork, SIGN_MESSAGE_PREFIX, STORAGE_KEYS_ADDRESS, STORAGE_KEYS_GLOBAL, STORAGE_PREFIX, type SearchFilters, type SearchIntentResult, type SearchOptions, type SearchResult, type ServiceHealthResult, Sphere, type SphereCreateOptions, SphereError, type SphereErrorCode, type SphereEventHandler, type SphereEventMap, type SphereEventType, type SphereImportOptions, type SphereInitOptions, type SphereInitResult, type SphereLoadOptions, type SphereStatus, type StorageProvider, TEST_NOSTR_RELAYS, TIMEOUTS, type Token, type TokenDefinition, type TokenIcon, type TokenPrice, TokenRegistry, type TokenStatus, type TokenTransferDetail, type TrackedAddress, type TrackedAddressEntry, type HistoryRecord as TransactionHistoryEntry, type TransferRequest, type TransferResult, type TransferStatus, type TransportEvent, type TransportEventCallback, type TransportEventType, type TransportProvider, type WalletApiTransportConfig, type WalletInfo, type WalletJSON, type WalletJSONExportOptions, type WalletSource, addressesMatch, assertFieldEnvelopeShape, base58Decode, base58Encode, bytesToHex, checkNetworkHealth, coinIdsMatch, createCommunicationsModule, createGroupChatModule, createKeyPair, createMarketModule, createPriceProvider, createSphere, decrypt, decryptField, decryptFieldBytes, decryptJson, decryptMnemonic, decryptSimple, decryptTextFormatKey, decryptWithSalt, deriveAddressInfo, deriveChildKey, deriveFieldEncryptionKey, deriveKeyAtPath, doubleSha256, encodeNftContent, encrypt, encryptField, encryptFieldBytes, encryptMnemonic, encryptSimple, extractFromText, findPattern, formatAmount, generateAddressFromMasterKey, generateMasterKey, generateMnemonic, getAddressId, getAddressStorageKey, getCoinIdByName, getCoinIdBySymbol, getPublicKey, getTokenDecimals, getTokenDefinition, getTokenIconUrl, getTokenName, getTokenSymbol, hash160, hashSignMessage, hexToBytes, identityFromMnemonicSync, initSphere, isKnownToken, isPossiblyCommittedSendOutcome, isSphereError, isTextWalletEncrypted, isValidAddress, isValidDirectAddress, isValidNametag, isValidPrivateKey, isWalletTextFormat, loadSphere, logger, mnemonicToSeedSync, normalizeAddress, normalizeCoinId, parseAddress, parseAndDecryptWalletText, parseNftPayload, parseTokenAmount, parseWalletText, randomBytes, randomHex, randomUUID, recoverPubkeyFromSignature, ripemd160, safeParseTokenAmount, sha256, signMessage, sleep, sphereExists, toHumanReadable, validateMnemonic, verifyChallengeTemplate, verifyNftLinkContent, verifySignedMessage };
+export { AUTH_CHALLENGE_PREFIX, type AddressInfo, type AddressType, type AggregatorEvent, type AggregatorEventCallback, type AggregatorEventType, type AggregatorProvider, type Asset, type BaseProvider, type BroadcastHandler, type BroadcastMessage, COIN_TYPES, ChallengeTemplateError, type CheckNetworkHealthOptions, CoinGeckoPriceProvider, type CoinlessToken, CommunicationsModule, type CommunicationsModuleConfig, type CommunicationsModuleDependencies, type ComposingIndicator, type ConversationPage, type CreateGroupOptions, DEFAULT_AGGREGATOR_TIMEOUT, DEFAULT_DERIVATION_PATH, DEFAULT_GROUP_RELAYS, DEFAULT_MARKET_API_URL, DEFAULT_NOSTR_RELAYS, type DecryptionProgressCallback, type DerivationMode, type DirectMessage, type DiscoverAddressProgress, type DiscoverAddressesOptions, type DiscoverAddressesResult, type DiscoveredAddress, type EncryptedData, FIELD_ENCRYPTION_HKDF_INFO, FIELD_ENVELOPE_MAX_BYTES, FIELD_ENVELOPE_NONCE_BYTES, FIELD_ENVELOPE_PREFIX, type FullIdentity, type GetConversationPageOptions, GroupChatModule, type GroupChatModuleConfig, type GroupChatModuleDependencies, type GroupData, type GroupMemberData, type GroupMessageData, GroupRole, GroupVisibility, type HealthCheckFn, type HistoryRecord, type Identity, type IdentityConfig, type IncomingBroadcast, type IncomingMessage, type IncomingTransfer, type InitProgress, type InitProgressCallback, type InitProgressStep, type IntentStatus, type IntentType, LIMITS, type LegacyFileParseResult, type LegacyFileParsedData, type LegacyFileType, type LogHandler, type LogLevel, type LoggerConfig, type MarketIntent, MarketModule, type MarketModuleConfig, type MarketModuleDependencies, type MessageHandler, type MintNftRequest, NETWORKS, NFT_DOCUMENT_MEDIA_TYPE, NFT_LINK_TAG, NFT_MAX_PAYLOAD_BYTES, NFT_MEDIA_TAG, NFT_METADATA_TAG, NFT_SIGNED_TAG, NIP29_KINDS, NOSTR_EVENT_KINDS, type NetworkHealthResult, type NetworkType, type NftAttribute, type NftContent, type NftLink, type NftMedia, type NftMediaRef, type NftMetadata, type NftSignatureContext, type NftSignatureStatus, type NftView, type OracleEvent, type OracleEventCallback, type OracleEventType, type OracleProvider, type ParsedAddress, PartialSendConflictError, type PeerInfo, type PostIntentRequest, type PostIntentResult, type PricePlatform, type PriceProvider, type PriceProviderConfig, type ProviderMetadata, type ProviderRole, type ProviderStatus, type ProviderStatusInfo, type RegistryNetwork, SIGN_MESSAGE_PREFIX, STORAGE_KEYS_ADDRESS, STORAGE_KEYS_GLOBAL, STORAGE_PREFIX, type SearchFilters, type SearchIntentResult, type SearchOptions, type SearchResult, type ServiceHealthResult, Sphere, type SphereCreateOptions, SphereError, type SphereErrorCode, type SphereEventHandler, type SphereEventMap, type SphereEventType, type SphereImportOptions, type SphereInitOptions, type SphereInitResult, type SphereLoadOptions, type SphereStatus, type StorageProvider, TEST_NOSTR_RELAYS, TIMEOUTS, type Token, type TokenDefinition, type TokenIcon, type TokenPrice, TokenRegistry, type TokenStatus, type TokenTransferDetail, type TrackedAddress, type TrackedAddressEntry, type HistoryRecord as TransactionHistoryEntry, type TransferRequest, type TransferResult, type TransferStatus, type TransportEvent, type TransportEventCallback, type TransportEventType, type TransportProvider, type WalletApiTransportConfig, type WalletInfo, type WalletJSON, type WalletJSONExportOptions, type WalletSource, addressesMatch, assertFieldEnvelopeShape, base58Decode, base58Encode, bytesToHex, checkNetworkHealth, coinIdsMatch, createCommunicationsModule, createGroupChatModule, createKeyPair, createMarketModule, createPriceProvider, createSphere, decrypt, decryptField, decryptFieldBytes, decryptJson, decryptMnemonic, decryptSimple, decryptTextFormatKey, decryptWithSalt, deriveAddressInfo, deriveChildKey, deriveFieldEncryptionKey, deriveKeyAtPath, doubleSha256, encodeNftContent, encrypt, encryptField, encryptFieldBytes, encryptMnemonic, encryptSimple, extractFromText, findPattern, formatAmount, generateAddressFromMasterKey, generateMasterKey, generateMnemonic, getAddressId, getAddressStorageKey, getCoinIdByName, getCoinIdBySymbol, getPublicKey, getTokenDecimals, getTokenDefinition, getTokenIconUrl, getTokenName, getTokenSymbol, hash160, hashSignMessage, hexToBytes, identityFromMnemonicSync, initSphere, isKnownToken, isNftDocumentLink, isPossiblyCommittedSendOutcome, isSphereError, isTextWalletEncrypted, isValidAddress, isValidDirectAddress, isValidNametag, isValidPrivateKey, isWalletTextFormat, loadSphere, logger, mnemonicToSeedSync, normalizeAddress, normalizeCoinId, parseAddress, parseAndDecryptWalletText, parseNftDocument, parseNftPayload, parseTokenAmount, parseWalletText, randomBytes, randomHex, randomUUID, recoverPubkeyFromSignature, ripemd160, safeParseTokenAmount, sha256, signMessage, sleep, sphereExists, toHumanReadable, validateMnemonic, verifyChallengeTemplate, verifyNftLinkContent, verifySignedMessage };

package/dist/index.js

@@ -9802,7 +9802,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;
@@ -9810,12 +9811,15 @@ var CREATOR_BYTES = 33;
 var SIGNATURE_BYTES = 65;
 var MAX_URI_LENGTH = 2048;
 var LINK_SCHEMES = ["https://", "ipfs://", "ar://"];
-var SIGNED_DOMAIN = "NftSigned";
+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);
@@ -9827,6 +9831,7 @@ var fieldName = (prefix, name) => prefix === "" ? name : `${prefix}.${name}`;
 var isText = (value) => typeof value === "string" && value.length > 0 && !LONE_SURROGATE.test(value);
 var isBytes3 = (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++) {
@@ -9869,8 +9874,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");
@@ -9887,6 +9893,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) {
@@ -9944,6 +9951,7 @@ function arrayCbor(items) {
   }
   return out;
 }
+var optionalHexBytes = (value) => CborSerializer.encodeNullable(value, (hex) => CborSerializer.encodeByteString(HexConverter.decode(hex.toLowerCase())));
 function metadataCbor(metadata) {
   return versioned(
     NFT_METADATA_TAG,
@@ -9953,7 +9961,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) {
@@ -10011,13 +10020,14 @@ function decodeMedia(body) {
   const [, mediaType, bytes] = versionedFields(body, MEDIA_ARITY);
   return { kind: "media", media_type: decodeText(mediaType), bytes: CborDeserializer.decodeByteString(bytes) };
 }
+var decodeHex = (item) => HexConverter.encode(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: HexConverter.encode(CborDeserializer.decodeByteString(digest))
+    sha256: decodeHex(digest)
   };
 }
 function decodeMetadata(body) {
@@ -10030,7 +10040,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: CborDeserializer.decodeNullable(fields[8], decodeHex)
   };
 }
 var MEDIA_REF_DECODERS = /* @__PURE__ */ new Map([
@@ -10042,6 +10053,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`);
@@ -10076,20 +10091,35 @@ function parseNftPayload(data) {
     return null;
   }
 }
-function nftSignedDigest(tokenIdCbor, recipientPredicateCbor, payload) {
+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 nftSignedDigest(context, payload) {
   const preimage = CborSerializer.encodeArray(
-    CborSerializer.encodeTextString(SIGNED_DOMAIN),
-    tokenIdCbor,
-    recipientPredicateCbor,
+    CborSerializer.encodeByteString(SIGNED_DOMAIN),
+    CborSerializer.encodeUnsignedInteger(NFT_FORMAT_VERSION),
+    CborSerializer.encodeUnsignedInteger(NetworkId.fromId(context.networkId).id),
+    CborSerializer.encodeByteString(context.recipientPredicate),
+    CborSerializer.encodeByteString(context.tokenId),
+    CborSerializer.encodeByteString(context.tokenType),
     CborSerializer.encodeByteString(payload)
   );
   return new DataHasher(HashAlgorithm.SHA256).update(preimage).digest();
 }
-async function verifyNftSignature(signed, tokenIdCbor, recipientPredicateCbor) {
+async function verifyNftSignature(signed, context) {
   try {
     if (!SigningService.isPublicKeyValid(signed.creator)) return "invalid";
     const signature = Signature.decode(signed.signature);
-    const digest = await nftSignedDigest(tokenIdCbor, recipientPredicateCbor, signed.payload);
+    const digest = await nftSignedDigest(context, signed.payload);
     return await SigningService.verifyWithPublicKey(digest, signature, signed.creator) ? "valid" : "invalid";
   } catch {
     return "invalid";
@@ -10223,8 +10253,8 @@ function assertMintableData(data) {
 function nftRecipientCbor(pubkey) {
   return EncodedPredicate.fromPredicate(SignaturePredicate.create(pubkey)).toCBOR();
 }
-async function signPayload(deps, payload, tokenId, recipientPubkey) {
-  const digest = await nftSignedDigest(tokenId.toCBOR(), nftRecipientCbor(recipientPubkey), payload);
+async function signPayload(deps, payload, context) {
+  const digest = await nftSignedDigest(context, payload);
   const signature = await deps.signingService.sign(digest);
   return encodeNftSigned(deps.signingService.publicKey, payload, signature.encode());
 }
@@ -10233,31 +10263,41 @@ async function planNftMint(deps, params) {
   const tokenType = new TokenType(params.tokenType).bytes;
   const salt = TokenSalt.generate();
   const tokenId = await TokenId.fromSalt(deps.networkId, salt);
-  const data = params.sign ? await signPayload(deps, payload, tokenId, params.recipientPubkey) : payload;
+  const data = params.sign ? await signPayload(deps, payload, {
+    networkId: deps.networkId.id,
+    recipientPredicate: nftRecipientCbor(params.recipientPubkey),
+    tokenId: tokenId.bytes,
+    tokenType
+  }) : payload;
   assertMintableData(data);
   return { data, salt: salt.toBytes(), tokenType, tokenId: HexConverter.encode(tokenId.bytes) };
 }
-async function verifyAgainst(signed, tokenIdCbor, genesisRecipientCbor) {
+async function verifyAgainst(signed, genesisContext) {
   try {
-    return await verifyNftSignature(signed, tokenIdCbor, genesisRecipientCbor());
+    return await verifyNftSignature(signed, genesisContext());
   } catch {
     return "invalid";
   }
 }
-async function readNftData(data, tokenIdCbor, genesisRecipientCbor) {
+async function readNftData(data, genesisContext) {
   const parsed = parseNftPayload(data);
   if (parsed === null) return null;
   if (parsed.signed === null) return { content: parsed.content, creator: null, signature: "unsigned" };
   return {
     content: parsed.content,
     creator: HexConverter.encode(parsed.signed.creator),
-    signature: await verifyAgainst(parsed.signed, tokenIdCbor, genesisRecipientCbor)
+    signature: await verifyAgainst(parsed.signed, genesisContext)
   };
 }
 async function readTokenNft(token) {
   try {
     const { genesis } = token.sdkToken;
-    return await readNftData(genesis.data, genesis.tokenId.toCBOR(), () => genesis.recipient.toCBOR());
+    return await readNftData(genesis.data, () => ({
+      networkId: genesis.networkId.id,
+      recipientPredicate: genesis.recipient.toCBOR(),
+      tokenId: genesis.tokenId.bytes,
+      tokenType: genesis.tokenType.bytes
+    }));
   } catch {
     return null;
   }
@@ -20725,6 +20765,7 @@ export {
   LIMITS,
   MarketModule,
   NETWORKS,
+  NFT_DOCUMENT_MEDIA_TYPE,
   NFT_LINK_TAG,
   NFT_MAX_PAYLOAD_BYTES,
   NFT_MEDIA_TAG,
@@ -20803,6 +20844,7 @@ export {
   identityFromMnemonicSync,
   initSphere,
   isKnownToken,
+  isNftDocumentLink,
   isPhoneNumber2 as isPhoneNumber,
   isPossiblyCommittedSendOutcome,
   isSphereError,
@@ -20820,6 +20862,7 @@ export {
   normalizeNametag2 as normalizeNametag,
   parseAddress,
   parseAndDecryptWalletText,
+  parseNftDocument,
   parseNftPayload,
   parseTokenAmount,
   parseWalletText,