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:363

Bech32EncodeError (class)

Signature

export declare class Bech32EncodeError

Added in v2.0.0

Source: src/Ucs05.ts:355

models

AnyDisplay

Signature

export declare const AnyDisplay: S.Union<
  [
    S.Struct<{ _tag: S.tag<"CosmosDisplay">; address: S.filter<S.TemplateLiteral<`${string}1${string}`>> }>,
    S.Struct<{ _tag: S.tag<"EvmDisplay">; address: S.refine<`0x${string}`, S.Schema<string, string, never>> }>,
    S.Struct<{ _tag: S.tag<"SuiDisplay">; address: S.filter<typeof S.NonEmptyString> }>
  ]
>

Source: src/Ucs05.ts:239

Added in v2.0.0

AnyDisplay (type alias)

Signature

export type AnyDisplay = typeof AnyDisplay.Type

Source: src/Ucs05.ts:248

Added in v2.0.0

AnyDisplayFromString

Signature

export declare const AnyDisplayFromString: S.transformOrFail<
  typeof S.String,
  S.Union<
    [
      S.Struct<{ _tag: S.tag<"CosmosDisplay">; address: S.filter<S.TemplateLiteral<`${string}1${string}`>> }>,
      S.Struct<{ _tag: S.tag<"EvmDisplay">; address: S.refine<`0x${string}`, S.Schema<string, string, never>> }>,
      S.Struct<{ _tag: S.tag<"SuiDisplay">; address: S.filter<typeof S.NonEmptyString> }>
    ]
  >,
  never
>

Source: src/Ucs05.ts:254

Added in v2.0.0

AnyDisplayFromString (type alias)

Signature

export type AnyDisplayFromString = typeof AnyDisplayFromString.Type

Source: src/Ucs05.ts:275

Added in v2.0.0

AptosCanonical

Signature

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

Source: src/Ucs05.ts:180

Added in v2.0.0

AptosDisplay

Signature

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

Source: src/Ucs05.ts:185

Added in v2.0.0

AptosZkgm

Signature

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

Source: src/Ucs05.ts:190

Added in v2.0.0

Bech32

Signature

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

Source: src/Ucs05.ts:82

Added in v2.0.0

Bech32 (type alias)

Signature

export type Bech32 = typeof Bech32.Type

Source: src/Ucs05.ts:96

Added in v2.0.0

Bech32FromCanonicalBytesWithPrefix

Signature

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

Source: src/Ucs05.ts:371

Added in v2.0.0

CanonicalBytes

Signature

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

Source: src/Ucs05.ts:106

Added in v2.0.0

CanonicalBytes (type alias)

Signature

export type CanonicalBytes = typeof CanonicalBytes.Type

Source: src/Ucs05.ts:111

Added in v2.0.0

CosmosCanonical

Signature

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

Source: src/Ucs05.ts:118

Added in v2.0.0

CosmosCanonical (type alias)

Signature

export type CosmosCanonical = typeof CosmosCanonical.Type

Source: src/Ucs05.ts:123

Added in v2.0.0

CosmosDisplay

Signature

export declare const CosmosDisplay: S.Struct<{
  _tag: S.tag<"CosmosDisplay">
  address: S.filter<S.TemplateLiteral<`${string}1${string}`>>
}>

Source: src/Ucs05.ts:225

Added in v2.0.0

CosmosDisplay (type alias)

Signature

export type CosmosDisplay = typeof CosmosDisplay.Type

Source: src/Ucs05.ts:233

Added in v2.0.0

CosmosZkgm

Signature

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

Source: src/Ucs05.ts:129

Added in v2.0.0

CosmosZkgm (type alias)

Signature

export type CosmosZkgm = typeof CosmosZkgm.Type

Source: src/Ucs05.ts:134

Added in v2.0.0

ERC55

Signature

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

Source: src/Ucs05.ts:196

Added in v2.0.0

ERC55 (type alias)

Signature

export type ERC55 = typeof ERC55.Type

Source: src/Ucs05.ts:205

Added in v2.0.0

EvmCanonical

Signature

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

Source: src/Ucs05.ts:157

Added in v2.0.0

EvmCanonical (type alias)

Signature

export type EvmCanonical = typeof EvmCanonical.Type

Source: src/Ucs05.ts:162

Added in v2.0.0

EvmDisplay

Signature

export declare const EvmDisplay: S.Struct<{
  _tag: S.tag<"EvmDisplay">
  address: S.refine<`0x${string}`, S.Schema<string, string, never>>
}>

Source: src/Ucs05.ts:211

Added in v2.0.0

EvmDisplay (type alias)

Signature

export type EvmDisplay = typeof EvmDisplay.Type

Source: src/Ucs05.ts:219

Added in v2.0.0

EvmZkgm

Signature

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

Source: src/Ucs05.ts:168

Added in v2.0.0

EvmZkgm (type alias)

Signature

export type EvmZkgm = typeof EvmZkgm.Type

Source: src/Ucs05.ts:173

Added in v2.0.0

HRP

Signature

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

Source: src/Ucs05.ts:58

Added in v2.0.0

HRP (type alias)

Signature

export type HRP = typeof HRP.Type

Source: src/Ucs05.ts:76

Added in v2.0.0

SuiAddress

Signature

export declare const SuiAddress: S.filter<typeof S.NonEmptyString>

Source: src/Ucs05.ts:29

Added in v2.0.0

SuiAddress (type alias)

Signature

export type SuiAddress = typeof SuiAddress.Type

Source: src/Ucs05.ts:38

Added in v2.0.0

SuiDisplay

Signature

export declare const SuiDisplay: S.Struct<{ _tag: S.tag<"SuiDisplay">; address: S.filter<typeof S.NonEmptyString> }>

Source: src/Ucs05.ts:44

Added in v2.0.0

SuiDisplay (type alias)

Signature

export type SuiDisplay = typeof SuiDisplay.Type

Source: src/Ucs05.ts:52

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.TemplateLiteral<`${string}1${string}`>>,
    S.filter<typeof S.NonEmptyString>
  ]
>

Source: src/Ucs05.ts:344

Added in v2.0.0

ValidAddress (type alias)

Signature

export type ValidAddress = typeof ValidAddress.Type

Source: src/Ucs05.ts:349

Added in v2.0.0

Zkgm

Signature

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

Source: src/Ucs05.ts:281

Added in v2.0.0

Zkgm (type alias)

Signature

export type Zkgm = typeof Zkgm.Type

Source: src/Ucs05.ts:286

Added in v2.0.0

transformations

ZkgmFromAnyDisplay

Signature

export declare const ZkgmFromAnyDisplay: S.transform<
  S.Union<
    [
      S.Struct<{ _tag: S.tag<"CosmosDisplay">; address: S.filter<S.TemplateLiteral<`${string}1${string}`>> }>,
      S.Struct<{ _tag: S.tag<"EvmDisplay">; address: S.refine<`0x${string}`, S.Schema<string, string, never>> }>,
      S.Struct<{ _tag: S.tag<"SuiDisplay">; address: S.filter<typeof S.NonEmptyString> }>
    ]
  >,
  S.brand<S.TemplateLiteral<`0x${string}`>, "Zkgm">
>

Source: src/Ucs05.ts:292

Added in v2.0.0

anyDisplayToCanonical

Signature

export declare const anyDisplayToCanonical: (
  u:
    | { readonly _tag: "CosmosDisplay"; readonly address: `${string}1${string}` }
    | { readonly _tag: "EvmDisplay"; readonly address: `0x${string}` }
    | { readonly _tag: "SuiDisplay"; readonly address: string }
) => Unify<
  | never
  | ReturnType<
      | (({
          address
        }: {
          readonly _tag: "CosmosDisplay"
          readonly address: `${string}1${string}`
        }) => `0x${string}` & Brand<"CanonicalBytes">)
      | (({
          address
        }: {
          readonly _tag: "EvmDisplay"
          readonly address: `0x${string}`
        }) => `0x${string}` & Brand<"CanonicalBytes">)
      | (({
          address
        }: {
          readonly _tag: "SuiDisplay"
          readonly address: string
        }) => `0x${string}` & Brand<"CanonicalBytes">)
    >
>

Source: src/Ucs05.ts:324

Added in v2.0.0

utils

CosmosZkgmFromCanonicalBytesWithPrefix

Signature

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

Source: src/Ucs05.ts:145

Added in v2.0.0

anyDisplayToZkgm

Signature

export declare const anyDisplayToZkgm: (
  u:
    | { readonly _tag: "CosmosDisplay"; readonly address: `${string}1${string}` }
    | { readonly _tag: "EvmDisplay"; readonly address: `0x${string}` }
    | { readonly _tag: "SuiDisplay"; readonly address: string }
) => Unify<
  | never
  | ReturnType<
      | (({
          address
        }: {
          readonly _tag: "CosmosDisplay"
          readonly address: `${string}1${string}`
        }) => Effect.Effect<`0x${string}`, ParseResult.ParseError, never>)
      | (({
          address
        }: {
          readonly _tag: "EvmDisplay"
          readonly address: `0x${string}`
        }) => Effect.Effect<`0x${string}`, never, never>)
      | (({
          address
        }: {
          readonly _tag: "SuiDisplay"
          readonly address: string
        }) => Effect.Effect<`0x${string}`, ParseResult.ParseError, never>)
    >
>

Source: src/Ucs05.ts:312

Added in v2.0.0