AssetName overview

Table of contents

• arbitrary
  • arbitrary
• encoding
  • toBytes
  • toHex
• model
  • AssetName (class)
    • toJSON (method)
    • toString (method)
    • [Inspectable.NodeInspectSymbol] (method)
    • [Equal.symbol] (method)
    • [Hash.symbol] (method)
• parsing
  • fromBytes
  • fromHex
• predicates
  • isAssetName
• schemas
  • FromBytes
  • FromHex

arbitrary

arbitrary

FastCheck arbitrary for generating random AssetName instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<AssetName>

Added in v2.0.0

encoding

toBytes

Encode AssetName to bytes.

Signature

export declare const toBytes: (assetName: AssetName) => Uint8Array

Added in v2.0.0

toHex

Encode AssetName to hex string.

Signature

export declare const toHex: (assetName: AssetName) => string

Added in v2.0.0

model

AssetName (class)

Schema for AssetName representing a native asset identifier. Asset names are limited to 32 bytes (0-64 hex characters).

Signature

export declare class AssetName

Added in v2.0.0

toJSON (method)

Convert to JSON representation.

Signature

toJSON()

Added in v2.0.0

toString (method)

Convert to string representation.

Signature

toString(): string

Added in v2.0.0

[Inspectable.NodeInspectSymbol] (method)

Custom inspect for Node.js REPL.

Signature

[Inspectable.NodeInspectSymbol](): unknown

Added in v2.0.0

[Equal.symbol] (method)

Structural equality check.

Signature

[Equal.symbol](that: unknown): boolean

Added in v2.0.0

[Hash.symbol] (method)

Content-based hash for optimization of Equal.equals.

Signature

[Hash.symbol](): number

Added in v2.0.0

parsing

fromBytes

Parse AssetName from bytes.

Signature

export declare const fromBytes: (bytes: Uint8Array) => AssetName

Added in v2.0.0

fromHex

Parse AssetName from hex string.

Signature

export declare const fromHex: (hex: string) => AssetName

Added in v2.0.0

predicates

isAssetName

Check if the given value is a valid AssetName

Signature

export declare const isAssetName: (u: unknown, overrideOptions?: ParseOptions | number) => u is AssetName

Added in v2.0.0

schemas

FromBytes

Schema for encoding/decoding AssetName as bytes.

Signature

export declare const FromBytes: Schema.transform<
  Schema.SchemaClass<Uint8Array, Uint8Array, never>,
  Schema.SchemaClass<AssetName, AssetName, never>
>

Added in v2.0.0

FromHex

Schema for encoding/decoding AssetName as hex strings.

Signature

export declare const FromHex: Schema.transform<
  Schema.filter<Schema.Schema<Uint8Array, string, never>>,
  Schema.transform<Schema.SchemaClass<Uint8Array, Uint8Array, never>, Schema.SchemaClass<AssetName, AssetName, never>>
>

Added in v2.0.0