Evolution SDK
Modules

AddressEras.ts

AddressEras overview

Table of contents

arbitrary

arbitrary

FastCheck arbitrary for Address instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<
  | RewardAccount.RewardAccount
  | BaseAddress.BaseAddress
  | EnterpriseAddress.EnterpriseAddress
  | PointerAddress.PointerAddress
>

Added in v2.0.0

encoding

toBech32

Convert an Address to Bech32 string.

Signature

export declare const toBech32: (
  a:
    | RewardAccount.RewardAccount
    | BaseAddress.BaseAddress
    | EnterpriseAddress.EnterpriseAddress
    | PointerAddress.PointerAddress
    | ByronAddress.ByronAddress,
  overrideOptions?: ParseOptions
) => string

Added in v2.0.0

toBytes

Convert an Address to bytes.

Signature

export declare const toBytes: (
  a:
    | RewardAccount.RewardAccount
    | BaseAddress.BaseAddress
    | EnterpriseAddress.EnterpriseAddress
    | PointerAddress.PointerAddress
    | ByronAddress.ByronAddress,
  overrideOptions?: ParseOptions
) => any

Added in v2.0.0

toHex

Convert an Address to hex string.

Signature

export declare const toHex: (
  a:
    | RewardAccount.RewardAccount
    | BaseAddress.BaseAddress
    | EnterpriseAddress.EnterpriseAddress
    | PointerAddress.PointerAddress
    | ByronAddress.ByronAddress,
  overrideOptions?: ParseOptions
) => string

Added in v2.0.0

model

AddressEras

Union type representing all possible address types.

Signature

export declare const AddressEras: Schema.Union<
  [
    typeof BaseAddress.BaseAddress,
    typeof EnterpriseAddress.EnterpriseAddress,
    typeof PointerAddress.PointerAddress,
    typeof RewardAccount.RewardAccount,
    typeof ByronAddress.ByronAddress
  ]
>

Added in v2.0.0

AddressEras (type alias)

Type representing an address.

Signature

export type AddressEras = typeof AddressEras.Type

Added in v2.0.0

parsing

fromBech32

Parse an Address from Bech32 string.

Signature

export declare const fromBech32: (
  i: string,
  overrideOptions?: ParseOptions
) =>
  | RewardAccount.RewardAccount
  | BaseAddress.BaseAddress
  | EnterpriseAddress.EnterpriseAddress
  | PointerAddress.PointerAddress
  | ByronAddress.ByronAddress

Added in v2.0.0

fromBytes

Parse an Address from bytes.

Signature

export declare const fromBytes: (
  i: any,
  overrideOptions?: ParseOptions
) =>
  | RewardAccount.RewardAccount
  | BaseAddress.BaseAddress
  | EnterpriseAddress.EnterpriseAddress
  | PointerAddress.PointerAddress
  | ByronAddress.ByronAddress

Added in v2.0.0

fromHex

Parse an Address from hex string.

Signature

export declare const fromHex: (
  i: string,
  overrideOptions?: ParseOptions
) =>
  | RewardAccount.RewardAccount
  | BaseAddress.BaseAddress
  | EnterpriseAddress.EnterpriseAddress
  | PointerAddress.PointerAddress
  | ByronAddress.ByronAddress

Added in v2.0.0

schema

FromBech32

Schema for encoding/decoding addresses as Bech32 strings.

Signature

export declare const FromBech32: Schema.transformOrFail<
  typeof Schema.String,
  Schema.SchemaClass<
    | RewardAccount.RewardAccount
    | BaseAddress.BaseAddress
    | EnterpriseAddress.EnterpriseAddress
    | PointerAddress.PointerAddress
    | ByronAddress.ByronAddress,
    | RewardAccount.RewardAccount
    | BaseAddress.BaseAddress
    | EnterpriseAddress.EnterpriseAddress
    | PointerAddress.PointerAddress
    | ByronAddress.ByronAddress,
    never
  >,
  never
>

Added in v2.0.0

FromBytes

Schema for encoding/decoding addresses as bytes.

Signature

export declare const FromBytes: Schema.transformOrFail<
  typeof Schema.Uint8ArrayFromSelf,
  Schema.SchemaClass<
    | RewardAccount.RewardAccount
    | BaseAddress.BaseAddress
    | EnterpriseAddress.EnterpriseAddress
    | PointerAddress.PointerAddress
    | ByronAddress.ByronAddress,
    | RewardAccount.RewardAccount
    | BaseAddress.BaseAddress
    | EnterpriseAddress.EnterpriseAddress
    | PointerAddress.PointerAddress
    | ByronAddress.ByronAddress,
    never
  >,
  never
>

Added in v2.0.0

FromHex

Schema for encoding/decoding addresses as hex strings.

Signature

export declare const FromHex: Schema.transform<
  Schema.Schema<Uint8Array, string, never>,
  Schema.transformOrFail<
    typeof Schema.Uint8ArrayFromSelf,
    Schema.SchemaClass<
      | RewardAccount.RewardAccount
      | BaseAddress.BaseAddress
      | EnterpriseAddress.EnterpriseAddress
      | PointerAddress.PointerAddress
      | ByronAddress.ByronAddress,
      | RewardAccount.RewardAccount
      | BaseAddress.BaseAddress
      | EnterpriseAddress.EnterpriseAddress
      | PointerAddress.PointerAddress
      | ByronAddress.ByronAddress,
      never
    >,
    never
  >
>

Added in v2.0.0

utils

isAddress

Signature

export declare const isAddress: (
  u: unknown,
  overrideOptions?: ParseOptions | number
) => u is
  | RewardAccount.RewardAccount
  | BaseAddress.BaseAddress
  | EnterpriseAddress.EnterpriseAddress
  | PointerAddress.PointerAddress
  | ByronAddress.ByronAddress

Address.ts

Previous Page

AddressTag.ts

Next Page

On this page

AddressEras overviewarbitraryarbitraryencodingtoBech32toBytestoHexmodelAddressErasAddressEras (type alias)parsingfromBech32fromBytesfromHexschemaFromBech32FromBytesFromHexutilsisAddress