Skip to main content

Class: Reference

Defined in: core-sdk/src/bytes/reference.ts:27

A Swarm chunk/manifest reference: 32 bytes for an unencrypted address, or 64 bytes (address || decryption key) for an encrypted one. Also accepts a "bah5..." CID string, decoding it to the underlying reference bytes.

Extends​

Constructors​

Constructor​

new Reference(bytes): Reference

Defined in: core-sdk/src/bytes/reference.ts:30

Parameters​

bytes​

string | Uint8Array<ArrayBufferLike> | Bytes

Returns​

Reference

Overrides​

Bytes.constructor

Properties​

length​

readonly length: number

Defined in: core-sdk/src/bytes/bytes.ts:19

Inherited from​

Bytes.length

LENGTH​

readonly static LENGTH: 32 = 32

Defined in: core-sdk/src/bytes/reference.ts:28

Methods​

equals()​

equals(other): boolean

Defined in: core-sdk/src/bytes/bytes.ts:166

Byte-wise equality against another Bytes instance, raw bytes, or hex string.

Parameters​

other​

string | Uint8Array<ArrayBufferLike> | Bytes

Returns​

boolean

Inherited from​

Bytes.equals

offset()​

offset(index): Uint8Array

Defined in: core-sdk/src/bytes/bytes.ts:110

Returns a copy of the bytes from index to the end.

Parameters​

index​

number

Returns​

Uint8Array

Inherited from​

Bytes.offset

represent()​

represent(): string

Defined in: core-sdk/src/bytes/bytes.ts:173

Human-readable representation, used by debuggers/loggers. Same as toHex.

Returns​

string

Inherited from​

Bytes.represent

toBase32()​

toBase32(): string

Defined in: core-sdk/src/bytes/bytes.ts:138

Encodes as a padded base32 string.

Returns​

string

Inherited from​

Bytes.toBase32

toBase64()​

toBase64(): string

Defined in: core-sdk/src/bytes/bytes.ts:131

Encodes as a padded base64 string.

Returns​

string

Inherited from​

Bytes.toBase64

toCid()​

toCid(type): string

Defined in: core-sdk/src/bytes/reference.ts:41

Encodes the reference as a "bah5..." CID string of the given type.

Parameters​

type​

"manifest" | "feed"

Returns​

string

toHex()​

toHex(): string

Defined in: core-sdk/src/bytes/bytes.ts:124

Encodes as a lowercase hex string, with no 0x prefix.

Returns​

string

Inherited from​

Bytes.toHex

toJSON()​

toJSON(): unknown

Defined in: core-sdk/src/bytes/bytes.ts:159

Decodes the bytes as UTF-8 JSON.

Returns​

unknown

Inherited from​

Bytes.toJSON

toString()​

toString(): string

Defined in: core-sdk/src/bytes/bytes.ts:145

Same as toHex.

Returns​

string

Inherited from​

Bytes.toString

toUint8Array()​

toUint8Array(): Uint8Array

Defined in: core-sdk/src/bytes/bytes.ts:117

Returns a copy of the underlying bytes.

Returns​

Uint8Array

Inherited from​

Bytes.toUint8Array

toUtf8()​

toUtf8(): string

Defined in: core-sdk/src/bytes/bytes.ts:152

Decodes the bytes as UTF-8 text.

Returns​

string

Inherited from​

Bytes.toUtf8

concat()​

static concat(...arrays): Uint8Array

Defined in: core-sdk/src/bytes/bytes.ts:75

Concatenates any number of byte arrays (or Bytes instances) into one new array.

Parameters​

arrays​

...(Uint8Array<ArrayBufferLike> | Bytes)[]

Returns​

Uint8Array

Inherited from​

Bytes.concat

fromSlice()​

static fromSlice(bytes, start, length?): Bytes

Defined in: core-sdk/src/bytes/bytes.ts:100

Wraps a slice of bytes starting at start, running to the end unless length is given.

Parameters​

bytes​

Uint8Array

start​

number

length?​

number

Returns​

Bytes

Inherited from​

Bytes.fromSlice

fromUtf8()​

static fromUtf8(utf8): Bytes

Defined in: core-sdk/src/bytes/bytes.ts:92

Wraps the UTF-8 encoding of a string.

Parameters​

utf8​

string

Returns​

Bytes

Inherited from​

Bytes.fromUtf8

isValid()​

static isValid(value): boolean

Defined in: core-sdk/src/bytes/reference.ts:57

Returns whether value parses as a valid Reference (raw hex, 32/64-byte bytes, or a "bah5..." CID string).

Parameters​

value​

string

Returns​

boolean

keccak256()​

static keccak256(bytes): Bytes

Defined in: core-sdk/src/bytes/bytes.ts:68

Hashes bytes with keccak256 and wraps the 32-byte digest.

Parameters​

bytes​

string | ArrayBuffer | Uint8Array<ArrayBufferLike> | Bytes

Returns​

Bytes

Inherited from​

Bytes.keccak256

💬 Get Help