Evolution SDK
Modules

PoolMetadata.ts

PoolMetadata overview

Table of contents

conversion

fromCBORBytes

Convert CBOR bytes to PoolMetadata (unsafe)

Signature

export declare const fromCBORBytes: (bytes: Uint8Array, options?: CBOR.CodecOptions) => PoolMetadata

Added in v2.0.0

fromCBORHex

Convert CBOR hex string to PoolMetadata (unsafe)

Signature

export declare const fromCBORHex: (hex: string, options?: CBOR.CodecOptions) => PoolMetadata

Added in v2.0.0

toCBORBytes

Convert PoolMetadata to CBOR bytes (unsafe)

Signature

export declare const toCBORBytes: (poolMetadata: PoolMetadata, options?: CBOR.CodecOptions) => any

Added in v2.0.0

toCBORHex

Convert PoolMetadata to CBOR hex string (unsafe)

Signature

export declare const toCBORHex: (poolMetadata: PoolMetadata, options?: CBOR.CodecOptions) => string

Added in v2.0.0

model

PoolMetadata (class)

Schema for PoolMetadata representing pool metadata information. pool_metadata = [url, bytes]

Signature

export declare class PoolMetadata

Added in v2.0.0

toJSON (method)

Convert to JSON-serializable object.

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)

Hash code generation.

Signature

[Hash.symbol](): number

Added in v2.0.0

schemas

FromCBORBytes

CBOR bytes transformation schema for PoolMetadata. Transforms between Uint8Array and PoolMetadata using CBOR encoding.

Signature

export declare const FromCBORBytes: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.transformOrFail<
    typeof Schema.Uint8ArrayFromSelf,
    Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
    never
  >,
  Schema.transform<
    Schema.Tuple2<typeof Schema.String, typeof Schema.Uint8ArrayFromSelf>,
    Schema.SchemaClass<PoolMetadata, PoolMetadata, never>
  >
>

Added in v2.0.0

FromCBORHex

CBOR hex transformation schema for PoolMetadata. Transforms between hex string and PoolMetadata using CBOR encoding.

Signature

export declare const FromCBORHex: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.Schema<Uint8Array, string, never>,
  Schema.transform<
    Schema.transformOrFail<
      typeof Schema.Uint8ArrayFromSelf,
      Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
      never
    >,
    Schema.transform<
      Schema.Tuple2<typeof Schema.String, typeof Schema.Uint8ArrayFromSelf>,
      Schema.SchemaClass<PoolMetadata, PoolMetadata, never>
    >
  >
>

Added in v2.0.0

FromCDDL

CDDL schema for PoolMetadata as defined in the specification: pool_metadata = [url, bytes]

Transforms between CBOR tuple structure and PoolMetadata model.

Signature

export declare const FromCDDL: Schema.transform<
  Schema.Tuple2<typeof Schema.String, typeof Schema.Uint8ArrayFromSelf>,
  Schema.SchemaClass<PoolMetadata, PoolMetadata, never>
>

Added in v2.0.0

testing

arbitrary

FastCheck arbitrary for generating random PoolMetadata instances

Signature

export declare const arbitrary: FastCheck.Arbitrary<PoolMetadata>

Added in v2.0.0

PoolKeyHash.ts

Previous Page

PoolParams.ts

Next Page

On this page

PoolMetadata overviewconversionfromCBORBytesfromCBORHextoCBORBytestoCBORHexmodelPoolMetadata (class)toJSON (method)toString (method)[Inspectable.NodeInspectSymbol] (method)[Equal.symbol] (method)[Hash.symbol] (method)schemasFromCBORBytesFromCBORHexFromCDDLtestingarbitrary