Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: core/AddressStructure.ts
nav_order: 3
title: core/Address.ts
nav_order: 1
parent: Modules
---

## AddressStructure overview
## Address overview

Added in v1.0.0

Expand All @@ -17,7 +17,7 @@ Added in v1.0.0
- [Functions](#functions)
- [fromBech32](#frombech32)
- [Schema](#schema)
- [AddressStructure (class)](#addressstructure-class)
- [Address (class)](#address-class)
- [toString (method)](#tostring-method)
- [[Symbol.for("nodejs.util.inspect.custom")] (method)](#symbolfornodejsutilinspectcustom-method)
- [Transformations](#transformations)
Expand All @@ -30,7 +30,7 @@ Added in v1.0.0
- [hasStakingCredential](#hasstakingcredential)
- [isEnterprise](#isenterprise)
- [utils](#utils-1)
- [AddressStructureError (class)](#addressstructureerror-class)
- [AddressError (class)](#addresserror-class)
- [Either (namespace)](#either-namespace)
- [fromBytes](#frombytes-1)
- [fromHex](#fromhex-1)
Expand All @@ -49,7 +49,7 @@ FastCheck arbitrary generator for testing
**Signature**

```ts
export declare const arbitrary: FastCheck.Arbitrary<AddressStructure>
export declare const arbitrary: FastCheck.Arbitrary<Address>
```

Added in v1.0.0
Expand All @@ -63,19 +63,19 @@ Sync functions using Function module utilities
**Signature**

```ts
export declare const fromBech32: (input: string) => AddressStructure
export declare const fromBech32: (input: string) => Address
```

Added in v1.0.0

# Schema

## AddressStructure (class)
## Address (class)

**Signature**

```ts
export declare class AddressStructure
export declare class Address
```

Added in v1.0.0
Expand Down Expand Up @@ -107,7 +107,7 @@ Transform from Bech32 string to AddressStructure
```ts
export declare const FromBech32: Schema.transformOrFail<
typeof Schema.String,
Schema.SchemaClass<AddressStructure, AddressStructure, never>,
Schema.SchemaClass<Address, Address, never>,
never
>
```
Expand All @@ -124,7 +124,7 @@ Handles both BaseAddress (57 bytes) and EnterpriseAddress (29 bytes)
```ts
export declare const FromBytes: Schema.transformOrFail<
Schema.Union<[Schema.filter<typeof Schema.Uint8ArrayFromSelf>, Schema.filter<typeof Schema.Uint8ArrayFromSelf>]>,
Schema.SchemaClass<AddressStructure, AddressStructure, never>,
Schema.SchemaClass<Address, Address, never>,
never
>
```
Expand All @@ -142,7 +142,7 @@ export declare const FromHex: Schema.transform<
Schema.transform<Schema.Schema<string, string, never>, Schema.Schema<Uint8Array, Uint8Array, never>>,
Schema.transformOrFail<
Schema.Union<[Schema.filter<typeof Schema.Uint8ArrayFromSelf>, Schema.filter<typeof Schema.Uint8ArrayFromSelf>]>,
Schema.SchemaClass<AddressStructure, AddressStructure, never>,
Schema.SchemaClass<Address, Address, never>,
never
>
>
Expand All @@ -159,7 +159,7 @@ Check if two AddressStructure instances are equal.
**Signature**

```ts
export declare const equals: (a: AddressStructure, b: AddressStructure) => boolean
export declare const equals: (a: Address, b: Address) => boolean
```

Added in v1.0.0
Expand All @@ -171,7 +171,7 @@ Get network ID from AddressStructure
**Signature**

```ts
export declare const getNetworkId: (address: AddressStructure) => NetworkId.NetworkId
export declare const getNetworkId: (address: Address) => NetworkId.NetworkId
```

Added in v1.0.0
Expand All @@ -183,7 +183,7 @@ Check if AddressStructure has staking credential (BaseAddress-like)
**Signature**

```ts
export declare const hasStakingCredential: (address: AddressStructure) => boolean
export declare const hasStakingCredential: (address: Address) => boolean
```

Added in v1.0.0
Expand All @@ -195,19 +195,19 @@ Check if AddressStructure is enterprise-like (no staking credential)
**Signature**

```ts
export declare const isEnterprise: (address: AddressStructure) => boolean
export declare const isEnterprise: (address: Address) => boolean
```

Added in v1.0.0

# utils

## AddressStructureError (class)
## AddressError (class)

**Signature**

```ts
export declare class AddressStructureError
export declare class AddressError
```

## Either (namespace)
Expand All @@ -217,37 +217,37 @@ export declare class AddressStructureError
**Signature**

```ts
export declare const fromBytes: (input: any) => AddressStructure
export declare const fromBytes: (input: any) => Address
```

## fromHex

**Signature**

```ts
export declare const fromHex: (input: string) => AddressStructure
export declare const fromHex: (input: string) => Address
```

## toBech32

**Signature**

```ts
export declare const toBech32: (input: AddressStructure) => string
export declare const toBech32: (input: Address) => string
```

## toBytes

**Signature**

```ts
export declare const toBytes: (input: AddressStructure) => any
export declare const toBytes: (input: Address) => any
```

## toHex

**Signature**

```ts
export declare const toHex: (input: AddressStructure) => string
export declare const toHex: (input: Address) => string
```
6 changes: 3 additions & 3 deletions docs/content/docs/modules/core/AddressEras.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ parent: Modules
- [model](#model)
- [AddressEras](#addresseras)
- [AddressEras (type alias)](#addresseras-type-alias)
- [AddressError (class)](#addresserror-class)
- [AddressErasError (class)](#addresseraserror-class)
- [parsing](#parsing)
- [fromBech32](#frombech32)
- [fromBytes](#frombytes)
Expand Down Expand Up @@ -156,14 +156,14 @@ export type AddressEras = typeof AddressEras.Type

Added in v2.0.0

## AddressError (class)
## AddressErasError (class)

Error thrown when address operations fail

**Signature**

```ts
export declare class AddressError
export declare class AddressErasError
```

Added in v2.0.0
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/AddressTag.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/AddressTag.ts
nav_order: 4
nav_order: 3
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Anchor.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Anchor.ts
nav_order: 5
nav_order: 4
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/AssetName.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/AssetName.ts
nav_order: 6
nav_order: 5
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/AuxiliaryData.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/AuxiliaryData.ts
nav_order: 7
nav_order: 6
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/AuxiliaryDataHash.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/AuxiliaryDataHash.ts
nav_order: 8
nav_order: 7
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/BaseAddress.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/BaseAddress.ts
nav_order: 9
nav_order: 8
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bech32.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bech32.ts
nav_order: 10
nav_order: 9
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/BigInt.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/BigInt.ts
nav_order: 11
nav_order: 10
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bip32PrivateKey.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bip32PrivateKey.ts
nav_order: 12
nav_order: 11
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bip32PublicKey.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bip32PublicKey.ts
nav_order: 13
nav_order: 12
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Block.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Block.ts
nav_order: 14
nav_order: 13
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/BlockBodyHash.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/BlockBodyHash.ts
nav_order: 15
nav_order: 14
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/BlockHeaderHash.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/BlockHeaderHash.ts
nav_order: 16
nav_order: 15
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/BootstrapWitness.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/BootstrapWitness.ts
nav_order: 17
nav_order: 16
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/BoundedBytes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/BoundedBytes.ts
nav_order: 18
nav_order: 17
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/ByronAddress.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/ByronAddress.ts
nav_order: 19
nav_order: 18
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bytes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bytes.ts
nav_order: 20
nav_order: 19
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bytes128.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bytes128.ts
nav_order: 21
nav_order: 20
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bytes16.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bytes16.ts
nav_order: 22
nav_order: 21
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bytes29.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bytes29.ts
nav_order: 23
nav_order: 22
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bytes32.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bytes32.ts
nav_order: 24
nav_order: 23
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bytes4.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bytes4.ts
nav_order: 25
nav_order: 24
parent: Modules
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/modules/core/Bytes448.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: core/Bytes448.ts
nav_order: 26
nav_order: 25
parent: Modules
---

Expand Down
Loading
Loading