Ucs05.ts

This module handles interaction with the UCS05 standard.

Added in v2.0.0

errors

Bech32DecodeError (class)

Signature

export declare class Bech32DecodeError

Added in v2.0.0

Source: src/Ucs05.ts:213

Bech32EncodeError (class)

Signature

export declare class Bech32EncodeError

Added in v2.0.0

Source: src/Ucs05.ts:205

models

AddressAptosCanonical

Signature

export declare const AddressAptosCanonical: S.brand<
  S.brand<S.TemplateLiteral<`0x${string}`>, "CanonicalBytes">,
  "AddressAptosCanonical"
>

Source: src/Ucs05.ts:161

Added in v2.0.0

AddressAptosDisplay

Signature

export declare const AddressAptosDisplay: S.brand<
  S.brand<S.TemplateLiteral<`0x${string}`>, "CanonicalBytes">,
  "AddressAptosCanonical"
>

Source: src/Ucs05.ts:166

Added in v2.0.0

AddressAptosZkgm

Signature

export declare const AddressAptosZkgm: S.brand<
  S.brand<S.TemplateLiteral<`0x${string}`>, "CanonicalBytes">,
  "AddressAptosCanonical"
>

Source: src/Ucs05.ts:171

Added in v2.0.0

AddressCanonicalBytes

Signature

export declare const AddressCanonicalBytes: S.brand<S.TemplateLiteral<`0x${string}`>, "CanonicalBytes">

Source: src/Ucs05.ts:65

Added in v2.0.0

AddressCanonicalBytes (type alias)

Signature

export type AddressCanonicalBytes = typeof AddressCanonicalBytes.Type

Source: src/Ucs05.ts:70

Added in v2.0.0

AddressCosmosCanonical

Signature

export declare const AddressCosmosCanonical: S.brand<
  S.brand<S.TemplateLiteral<`0x${string}`>, "CanonicalBytes">,
  "AddressCosmosCanonical"
>

Source: src/Ucs05.ts:77

Added in v2.0.0

AddressCosmosCanonical (type alias)

Signature

export type AddressCosmosCanonical = typeof AddressCosmosCanonical.Type

Source: src/Ucs05.ts:82

Added in v2.0.0

AddressCosmosDisplay

Signature

export declare const AddressCosmosDisplay: S.brand<
  S.filter<S.brand<S.TemplateLiteral<`${string}1${string}`>, "Bech32">>,
  "AddressCosmosDisplay"
>

Source: src/Ucs05.ts:88

Added in v2.0.0

AddressCosmosDisplay (type alias)

Signature

export type AddressCosmosDisplay = typeof AddressCosmosDisplay.Type

Source: src/Ucs05.ts:93

Added in v2.0.0

AddressCosmosZkgm

Signature

export declare const AddressCosmosZkgm: S.brand<S.TemplateLiteral<`0x${string}`>, "AddressCosmosZkgm">

Source: src/Ucs05.ts:99

Added in v2.0.0

AddressCosmosZkgm (type alias)

Signature

export type AddressCosmosZkgm = typeof AddressCosmosZkgm.Type

Source: src/Ucs05.ts:104

Added in v2.0.0

AddressEvmCanonical

Signature

export declare const AddressEvmCanonical: S.brand<
  S.brand<S.TemplateLiteral<`0x${string}`>, "CanonicalBytes">,
  "AddressEvmCanonical"
>

Source: src/Ucs05.ts:127

Added in v2.0.0

AddressEvmCanonical (type alias)

Signature

export type AddressEvmCanonical = typeof AddressEvmCanonical.Type

Source: src/Ucs05.ts:132

Added in v2.0.0

AddressEvmDisplay

Signature

export declare const AddressEvmDisplay: S.brand<S.TemplateLiteral<`0x${string}`>, "AddressEvmDisplay">

Source: src/Ucs05.ts:138

Added in v2.0.0

AddressEvmDisplay (type alias)

Signature

export type AddressEvmDisplay = typeof AddressEvmDisplay.Type

Source: src/Ucs05.ts:143

Added in v2.0.0

AddressEvmZkgm

Signature

export declare const AddressEvmZkgm: S.brand<
  S.brand<S.brand<S.TemplateLiteral<`0x${string}`>, "CanonicalBytes">, "AddressEvmCanonical">,
  "AddressEvmZkgm"
>

Source: src/Ucs05.ts:149

Added in v2.0.0

AddressEvmZkgm (type alias)

Signature

export type AddressEvmZkgm = typeof AddressEvmZkgm.Type

Source: src/Ucs05.ts:154

Added in v2.0.0

Bech32

Signature

export declare const Bech32: S.filter<S.brand<S.TemplateLiteral<`${string}1${string}`>, "Bech32">>

Source: src/Ucs05.ts:40

Added in v2.0.0

Bech32 (type alias)

Signature

export type Bech32 = typeof Bech32.Type

Source: src/Ucs05.ts:55

Added in v2.0.0

Bech32FromAddressCanonicalBytesWithPrefix

Signature

export declare const Bech32FromAddressCanonicalBytesWithPrefix: (
  prefix: HRP,
  options?: { validateHrp: boolean }
) => S.transformOrFail<
  S.brand<S.TemplateLiteral<`0x${string}`>, "CanonicalBytes">,
  S.filter<S.brand<S.TemplateLiteral<`${string}1${string}`>, "Bech32">>,
  never
>

Source: src/Ucs05.ts:221

Added in v2.0.0

ERC55

Signature

export declare const ERC55: S.refine<`0x${string}`, S.Schema<string, string, never>>

Source: src/Ucs05.ts:177

Added in v2.0.0

ERC55 (type alias)

Signature

export type ERC55 = typeof ERC55.Type

Source: src/Ucs05.ts:186

Added in v2.0.0

HRP

Signature

export declare const HRP: S.filter<S.filter<typeof S.String>>

Source: src/Ucs05.ts:16

Added in v2.0.0

HRP (type alias)

Signature

export type HRP = typeof HRP.Type

Source: src/Ucs05.ts:34

Added in v2.0.0

ValidAddress

Union of possible valid address schemas.

Signature

export declare const ValidAddress: S.Union<
  [
    S.refine<`0x${string}`, S.Schema<string, string, never>>,
    S.filter<S.brand<S.TemplateLiteral<`${string}1${string}`>, "Bech32">>
  ]
>

Source: src/Ucs05.ts:194

Added in v2.0.0

ValidAddress (type alias)

Signature

export type ValidAddress = typeof ValidAddress.Type

Source: src/Ucs05.ts:199

Added in v2.0.0

utils

AddressCosmosZkgmFromAddressCanonicalBytesWithPrefix

Signature

export declare const AddressCosmosZkgmFromAddressCanonicalBytesWithPrefix: (
  prefix: string
) => S.transform<
  S.transform<
    S.transformOrFail<
      S.brand<S.TemplateLiteral<`0x${string}`>, "CanonicalBytes">,
      S.filter<S.brand<S.TemplateLiteral<`${string}1${string}`>, "Bech32">>,
      never
    >,
    S.transform<typeof S.String, S.TemplateLiteral<`0x${string}`>>
  >,
  S.brand<S.TemplateLiteral<`0x${string}`>, "AddressCosmosZkgm">
>

Source: src/Ucs05.ts:115

Added in v2.0.0