Class Reference

Static ReadonlyREFERENCE_SIZE

bytes

• get bytes(): Uint8Array

  The bytes (a view; do not mutate).

  Returns Uint8Array

Staticcodec

• get codec(): ComponentCodec<Reference>

  Tagged-CBOR codec; decode also accepts the untagged form.

  Returns ComponentCodec<Reference>

Staticfrom

• from(data: Uint8Array): Reference

  Create a Reference from exactly 32 bytes.

  Parameters

  • data: Uint8Array

  Returns Reference

StaticfromDigest

• fromDigest(digest: Digest): Reference

  Create a Reference from a Digest's underlying bytes.

  Parameters

  • digest: Digest

  Returns Reference

StaticfromHex

• fromHex(hex: string): Reference

  Create a Reference from a 64-character hex string.

  Parameters

  • hex: string

  Returns Reference

Statichash

• hash(data: Uint8Array): Reference

  Create a Reference whose bytes are the SHA-256 digest of the input.

  Parameters

  • data: Uint8Array

  Returns Reference

  Deprecated

  Prefer Reference.fromDigest(Digest.fromImage(data)) for clarity, or Reference.from(data) if data is already 32 bytes that should be wrapped without hashing.

refHex

• refHex(): string

  The full 64-character lowercase hex of the reference.

  Returns string

refDataShort

• refDataShort(): Uint8Array

  The first 4 bytes of the reference.

  Returns Uint8Array

refHexShort

• refHexShort(): string

  The first 4 bytes of the reference, as 8 lowercase hex characters.

  Returns string

bytewordsIdentifier

• bytewordsIdentifier(prefix?: string): string

  The first 4 bytes as upper-case bytewords identifier.

  Parameters

  • Optionalprefix: string

    Optional prefix prepended with a single space.

  Returns string

bytemojiIdentifier

• bytemojiIdentifier(prefix?: string): string

  The first 4 bytes as upper-case bytemojis identifier.

  Parameters

  • Optionalprefix: string

    Optional prefix prepended with a single space.

  Returns string

toHex

• toHex(): string

  Backwards-compatible alias of refHex().

  Returns string

fullReference

• fullReference(): string

  Backwards-compatible alias of refHex().

  Returns string

toBase64

• toBase64(): string

  Returns the 32 raw bytes encoded as base64.

  Returns string

shortReference

• shortReference(format?: ReferenceEncodingFormat): string

  Returns a short representation of this reference in the requested format.

  Mirrors the legacy TS API; new code should prefer refHexShort, bytewordsIdentifier, or bytemojiIdentifier directly.

  Parameters

  • format: ReferenceEncodingFormat = "hex"

  Returns string

reference

• reference(): Reference

  A Reference to this Reference.

  Returns Reference

digest

• digest(): Digest

  SHA-256 of taggedCbor().toCborData().

  Digest::from_image(self.tagged_cbor().to_cbor_data()).

  Returns Digest

cborTags

• cborTags(): Tag[]

  The CBOR tags this type decodes from; the first one is used to encode.

  Returns Tag[]

untaggedCbor

• untaggedCbor(): Cbor

  Untagged CBOR — a single byte string of the 32 raw bytes.

  Returns Cbor

toCbor

• toCbor(): Cbor

  The tagged CBOR form.

  Returns Cbor

toUR

• toUR(): UR

  As a UR, typed by the first tag's name.

  Returns UR

StaticfromCbor

• fromCbor(cbor: Cbor): Reference

  Decode tagged or untagged CBOR.

  Parameters

  • cbor: Cbor

  Returns Reference

equals

• equals(other: Reference): boolean

  UR representation — ur:reference/..., untagged CBOR payload.

  Parameters

  • other: Reference

  Returns boolean

toString

• toString(): string

  Debug-style representation: Reference(<8-hex-prefix>).

  Returns string