Class ARID

Static ReadonlyARID_SIZE

Staticnew

• new(): ARID

  Create a new random ARID.

  Returns ARID

Staticrandom

• random(): ARID

  Create a new random ARID (alias for new()).

  Returns ARID

StaticfromData

• fromData(data: Uint8Array): ARID

  Restore an ARID from a fixed-size array of bytes.

  Parameters

  • data: Uint8Array

  Returns ARID

StaticfromDataRef

• fromDataRef(data: Uint8Array): ARID

  Create a new ARID from a reference to an array of bytes.

  Parameters

  • data: Uint8Array

  Returns ARID

Staticfrom

• from(data: Uint8Array): ARID

  Create an ARID from raw bytes (legacy alias).

  Parameters

  • data: Uint8Array

  Returns ARID

StaticfromHex

• fromHex(hex: string): ARID

  Create a new ARID from the given hexadecimal string.

  Parameters

  • hex: string

  Returns ARID

  Throws

  Error if the string is not exactly 64 hexadecimal digits.

data

• data(): Uint8Array

  Get the data of the ARID as an array of bytes.

  Returns Uint8Array

asBytes

• asBytes(): Uint8Array

  Get the data of the ARID as a byte slice.

  Returns Uint8Array

toData

• toData(): Uint8Array

  Get the raw ARID bytes as a copy.

  Returns Uint8Array

hex

• hex(): string

  The data as a hexadecimal string.

  Returns string

toHex

• toHex(): string

  Get hex string representation (alias for hex()).

  Returns string

toBase64

• toBase64(): string

  Get base64 representation.

  Returns string

shortDescription

• shortDescription(): string

  The first four bytes of the ARID as a hexadecimal string.

  Returns string

equals

• equals(other: ARID): boolean

  Compare with another ARID.

  Parameters

  • other: ARID

  Returns boolean

compare

• compare(other: ARID): number

  Compare ARIDs lexicographically.

  Parameters

  • other: ARID

  Returns number

toString

• toString(): string

  Get string representation.

  Returns string

cborTags

• cborTags(): Tag[]

  Returns the CBOR tags associated with ARID.

  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): ARID

  Creates an ARID by decoding it from untagged CBOR.

  Parameters

  • cbor: Cbor

  Returns ARID

fromTaggedCbor

• fromTaggedCbor(cbor: Cbor): ARID

  Creates an ARID by decoding it from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns ARID

StaticfromTaggedCbor

• fromTaggedCbor(cbor: Cbor): ARID

  Static method to decode from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns ARID

StaticfromTaggedCborData

• fromTaggedCborData(data: Uint8Array): ARID

  Static method to decode from tagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns ARID

StaticfromUntaggedCborData

• fromUntaggedCborData(data: Uint8Array): ARID

  Static method to decode from untagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns ARID

ur

• ur(): UR

  Returns the UR representation of the ARID. 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): ARID

  Creates an ARID from a UR.

  Parameters

  • ur: UR

  Returns ARID

StaticfromURString

• fromURString(urString: string): ARID

  Creates an ARID from a UR string.

  Parameters

  • urString: string

  Returns ARID