Class Anchor

An anchor is a pair of:

a URL to a JSON payload of metadata.
a hash of the contents of the metadata URL.

The on-chain rules will not check either the URL or the hash. Client applications should, however, perform the usual sanity checks when fetching content from the provided URL.

Hierarchy

Anchor

Index

Constructors

constructor

new Anchor(url: string, dataHash: Hash32ByteBase16): Serialization.Anchor
Initializes a new instance of the Anchor class.
Parameters
- url: string
  
  The URL to a JSON payload of metadata.
- dataHash: Hash32ByteBase16
  
  The hash of the contents of the metadata URL.
Returns Serialization.Anchor
- Defined in packages/core/src/Serialization/Common/Anchor.ts:29

Properties

`Private` #dataHash

#dataHash: Hash32ByteBase16

`Private` #originalBytes

#originalBytes: undefined | HexBlob = undefined

`Private` #url

#url: string

Methods

dataHash

dataHash(): Hash32ByteBase16
Gets the hash of the contents of the metadata URL.

Returns
The hash of the contents.

Returns Hash32ByteBase16
- Defined in packages/core/src/Serialization/Common/Anchor.ts:135

setDataHash

setDataHash(dataHash: Hash32ByteBase16): void
Sets the hash of the contents of the metadata URL.
Parameters
- dataHash: Hash32ByteBase16
  
  The hash of the contents.
Returns void
- Defined in packages/core/src/Serialization/Common/Anchor.ts:144

setUrl

setUrl(url: string): void
Sets the URL to a JSON payload of metadata.
Parameters
- url: string
  
  The URL to a JSON payload of metadata.
Returns void
- Defined in packages/core/src/Serialization/Common/Anchor.ts:125

toCbor

toCbor(): HexBlob
Serializes an Anchor into CBOR format.

Returns
The Anchor in CBOR format.

Returns HexBlob
- Defined in packages/core/src/Serialization/Common/Anchor.ts:45

toCore

toCore(): Cardano.Anchor
Creates a Core Anchor object from the current Anchor object.

Returns
The Core Anchor object.

Returns Cardano.Anchor
- Defined in packages/core/src/Serialization/Common/Anchor.ts:95

url

url(): string
Gets the URL to a JSON payload of metadata.

Returns
The URL to a JSON payload of metadata.

Returns string
- Defined in packages/core/src/Serialization/Common/Anchor.ts:116

`Static` fromCbor

fromCbor(cbor: HexBlob): Serialization.Anchor
Deserializes the Anchor from a CBOR byte array.

Returns
The new Anchor instance.
Parameters
- cbor: HexBlob
  
  The CBOR encoded Anchor object.
Returns Serialization.Anchor
- Defined in packages/core/src/Serialization/Common/Anchor.ts:68

`Static` fromCore

fromCore(anchor: Cardano.Anchor): Serialization.Anchor
Creates a Anchor object from the given Core Anchor object.
Parameters
- anchor: Cardano.Anchor
  
  core Anchor object.
Returns Serialization.Anchor
- Defined in packages/core/src/Serialization/Common/Anchor.ts:107

Class Anchor

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

dataHash: Hash32ByteBase16

Returns Serialization.Anchor

Properties

Private #dataHash

Private #originalBytes

Private #url

Methods

dataHash

Returns

Returns Hash32ByteBase16

setDataHash

Parameters

dataHash: Hash32ByteBase16

Returns void

setUrl

Parameters

url: string

Returns void

toCbor

Returns

Returns HexBlob

toCore

Returns

Returns Cardano.Anchor

url

Returns

Returns string

Static fromCbor

Returns

Parameters

cbor: HexBlob

Returns Serialization.Anchor

Static fromCore

Parameters

anchor: Cardano.Anchor

Returns Serialization.Anchor

Settings

Member Visibility

Theme

`Private` #dataHash

`Private` #originalBytes

`Private` #url

`Static` fromCbor

`Static` fromCore