Class XID

Static ReadonlyXID_SIZE

StaticfromData

• fromData(data: Uint8Array): XID

  Create a new XID from data.

  Parameters

  • data: Uint8Array

  Returns XID

StaticfromDataRef

• fromDataRef(data: Uint8Array): XID

  Create a new XID from data (validates length).

  Returns error if the data is not the correct length.

  Parameters

  • data: Uint8Array

  Returns XID

Staticfrom

• from(data: Uint8Array): XID

  Create an XID from raw bytes (legacy alias).

  Parameters

  • data: Uint8Array

  Returns XID

StaticfromHex

• fromHex(hex: string): XID

  Create an XID from hex string (64 hex characters).

  Parameters

  • hex: string

  Returns XID

Staticrandom

• random(): XID

  Generate a random XID (for testing purposes).

  Note: In practice, XIDs should be created from the SHA-256 hash of a public signing key's CBOR encoding.

  Returns XID

data

• data(): Uint8Array

  Return the data of the XID.

  Returns Uint8Array

asBytes

• asBytes(): Uint8Array

  Get the data of the XID as a byte slice.

  Returns Uint8Array

toData

• toData(): Uint8Array

  Get a copy of the raw XID bytes.

  Returns Uint8Array

toHex

• toHex(): string

  Get hex string representation (lowercase, matching Rust implementation).

  Returns string

toBase64

• toBase64(): string

  Get base64 representation.

  Returns string

shortDescription

• shortDescription(): string

  Get short description (first 4 bytes) as hex.

  Returns string

shortReference

• shortReference(): string

  Get short reference (first 4 bytes) as hex (alias for shortDescription).

  Returns string

bytewordsIdentifier

• bytewordsIdentifier(prefix?: boolean): string

  Get the first four bytes of the XID as upper-case ByteWords.

  Parameters

  • Optionalprefix: boolean

    If true, prepends the XID prefix "🅧 "

  Returns string

  Space-separated uppercase bytewords, e.g., "🅧 URGE DICE GURU IRIS"

bytemojisIdentifier

• bytemojisIdentifier(prefix?: boolean): string

  Get the first four bytes of the XID as Bytemoji.

  Parameters

  • Optionalprefix: boolean

    If true, prepends the XID prefix "🅧 "

  Returns string

  Space-separated emojis, e.g., "🅧 🐻 😻 🍞 💐"

equals

• equals(other: XID): boolean

  Compare with another XID.

  Parameters

  • other: XID

  Returns boolean

toString

• toString(): string

  Get string representation.

  Returns string

cborTags

• cborTags(): Tag[]

  Returns the CBOR tags associated with XID.

  Returns Tag[]

untaggedCbor

• untaggedCbor(): Cbor

  Returns the untagged CBOR encoding (as a byte string).

  Returns Cbor

taggedCbor

• taggedCbor(): Cbor

  Returns the tagged CBOR encoding.

  Returns Cbor

taggedCborData

• taggedCborData(): Uint8Array

  Returns the tagged value in CBOR binary representation.

  Returns Uint8Array

fromUntaggedCbor

• fromUntaggedCbor(cbor: Cbor): XID

  Creates a XID by decoding it from untagged CBOR.

  Parameters

  • cbor: Cbor

  Returns XID

fromTaggedCbor

• fromTaggedCbor(cbor: Cbor): XID

  Creates a XID by decoding it from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns XID

StaticfromTaggedCbor

• fromTaggedCbor(cbor: Cbor): XID

  Static method to decode from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns XID

StaticfromTaggedCborData

• fromTaggedCborData(data: Uint8Array): XID

  Static method to decode from tagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns XID

StaticfromUntaggedCborData

• fromUntaggedCborData(data: Uint8Array): XID

  Static method to decode from untagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns XID

ur

• ur(): UR

  Returns the UR representation of the XID. Note: URs use untagged CBOR since the type is conveyed by the UR type itself.

  Returns UR

urString

• urString(): string

  Returns the UR string representation.

  Returns string

StaticfromUR

• fromUR(ur: UR): XID

  Creates a XID from a UR.

  Parameters

  • ur: UR

  Returns XID

StaticfromURString

• fromURString(urString: string): XID

  Creates a XID from a UR string.

  Parameters

  • urString: string

  Returns XID