-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class ResolveAddressError
Hierarchy
--
-
- ErrorBase<ResolveAddressErrorName>
-
-
-
- ResolveAddressError
- Index
-
-
-
-
-
-
-
Constructors
-Properties
-Methods
-Constructors
-constructor
--
-
- new
Resolve Address Error(__namedParameters): ResolveAddressError
- -
---
Parameters
--
-
-
-
__namedParameters: {
-
cause?: any;
message: string;
name: ResolveAddressErrorName;
}-
-
-
-
Optionalcause?: any
- -
-
message: string
- -
-
name: ResolveAddressErrorName
-
-
Returns ResolveAddressError
-
-
Properties
-cause
-cause: any
message
-message: string
name
-Optional stack
-stack?: string
Static Optional prepare
-prepare
-
-
Type declaration
--
-
-
-
-
-
- (err, stackTraces): any -
-
---
Parameters
--
-
-
-
err: Error
- -
-
stackTraces: CallSite[]
Returns any
- -
-
Static stack
-stack
Methods
-Static capture
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Class ResolveAddressError
Hierarchy
- ErrorBase<ResolveAddressErrorName>
- ResolveAddressError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Resolve Address Error(__namedParameters): ResolveAddressError Parameters
- __namedParameters: {
cause?: any;
message: string;
name: ResolveAddressErrorName;
}Optionalcause?: anymessage: string
name: ResolveAddressErrorName
Returns ResolveAddressError
- __namedParameters: {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class ResolveDomainError
Hierarchy
--
-
- ErrorBase<ResolveDomainErrorName>
-
-
-
- ResolveDomainError
- Index
-
-
-
-
-
-
-
Constructors
-Properties
-Methods
-Constructors
-constructor
--
-
- new
Resolve Domain Error(__namedParameters): ResolveDomainError
- -
---
Parameters
--
-
-
-
__namedParameters: {
-
cause?: any;
message: string;
name: ResolveDomainErrorName;
}-
-
-
-
Optionalcause?: any
- -
-
message: string
- -
-
name: ResolveDomainErrorName
-
-
Returns ResolveDomainError
-
-
Properties
-cause
-cause: any
message
-message: string
name
-Optional stack
-stack?: string
Static Optional prepare
-prepare
-
-
Type declaration
--
-
-
-
-
-
- (err, stackTraces): any -
-
--
Optional override for formatting stack traces
---Parameters
--
-
-
-
err: Error
- -
-
stackTraces: CallSite[]
Returns any
- -
-
Static stack
-stack
Methods
-Static capture
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Class ResolveDomainError
Hierarchy
- ErrorBase<ResolveDomainErrorName>
- ResolveDomainError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Resolve Domain Error(__namedParameters): ResolveDomainError Parameters
- __namedParameters: {
cause?: any;
message: string;
name: ResolveDomainErrorName;
}Optionalcause?: anymessage: string
name: ResolveDomainErrorName
Returns ResolveDomainError
- __namedParameters: {
-
-
-
-
-
-
-
-
-
-
-
-
-Fee
-
-
-Merkle
-
-
-Name
-
-
-
-
-
-
-
-
-Enumeration ContractId
Contracts IDs & Addresses
-
- Index
-
-
-
Enumeration Members
-Enumeration Members
-Fee
-Fee
Merkle
-Merkle
Name
-Name
Registry
-Registry: "azns_registry"
Router
-Router: "azns_router"
-
-
\ No newline at end of file
+Generated using TypeDoc
Enumeration ContractId
Contracts IDs & Addresses
+ Index
Enumeration Members
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Enumeration SupportedChainId
Supported Chains
+ Index
Enumeration Members
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
diff --git a/docs/functions/_azns_resolver_core.getContract.html b/docs/functions/_azns_resolver_core.getContract.html
index 52c19d4..dca1daa 100644
--- a/docs/functions/_azns_resolver_core.getContract.html
+++ b/docs/functions/_azns_resolver_core.getContract.html
@@ -1,91 +1,2 @@
-
-
-
-
-
-
-
-
-Function getContract
-
-
- get
Contract(api, chainId, contractId, customContractAddresses?): Promise<{
abi: any;
address: string;
contract: ContractPromise;
}>
- -
--
Determines contract details based on chain & identifier, then returns a
-ContractPromiseinstance.--Parameters
--
-
-
-
api: ApiPromise
- -
-
chainId: SupportedChainId
- -
-
contractId: ContractId
- -
-
OptionalcustomContractAddresses: ContractAddresses
Returns Promise<{
-
abi: any;
address: string;
contract: ContractPromise;
}> -
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function getContract
Determines contract details based on chain & identifier, then returns a ContractPromise instance.
- get
Contract(api, chainId, contractId, customContractAddresses?): Promise<{
abi: any;
address: string;
contract: ContractPromise;
}> Parameters
- api: ApiPromise
- chainId: SupportedChainId
- contractId: ContractId
OptionalcustomContractAddresses: ContractAddresses
Returns Promise<{
abi: any;
address: string;
contract: ContractPromise;
}>
-
-
-
-
-
-
-
-Function getContractAbi
-
-
- get
Contract Abi(contractId): Promise<any>
- -
--
Imports & returns metadata.json (abi) for a given contract.
---Parameters
--
-
-
-
contractId: ContractId
Returns Promise<any>
- -
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function getContractAbi
Imports & returns metadata.json (abi) for a given contract.
+- get
Contract Abi(contractId): Promise<any> Parameters
- contractId: ContractId
Returns Promise<any>
-
diff --git a/docs/functions/_azns_resolver_core.getSupportedTLDs.html b/docs/functions/_azns_resolver_core.getSupportedTLDs.html
index d0c9310..0ed0390 100644
--- a/docs/functions/_azns_resolver_core.getSupportedTLDs.html
+++ b/docs/functions/_azns_resolver_core.getSupportedTLDs.html
@@ -1,85 +1,2 @@
-
-
-
-
-
-Function getContractAddress
-
-
- get
Contract Address(chainId, contractId, customContractAddresses?): undefined | string
- -
-
Returns contract address for a given chain & contract. +
getContractAddress | AZERO.ID – Resolver --Function getContractAddress
-Returns contract address for a given chain & contract. If
-customContractAddressesare provided, they will overwrite of the default ones. NOTE: To use the localdevelopmentnetwork,customContractAddressesmust be provided.--Parameters
--
-
-
-
chainId: SupportedChainId
- -
-
contractId: ContractId
- -
-
OptionalcustomContractAddresses: ContractAddresses
Returns undefined | string
--- \ No newline at end of file +Generated using TypeDoc
-
-
- get
Contract Address(chainId, contractId, customContractAddresses?): undefined | string Parameters
- chainId: SupportedChainId
- contractId: ContractId
OptionalcustomContractAddresses: ContractAddresses
Returns undefined | string
-
-
-
-
-
-
-
-Function getSupportedTLDs
-
-
- get
SupportedTLDs(chainId): SupportedTLD[]
- -
--
Returns supported TLDs for a given chain.
---Parameters
--
-
-
-
chainId: SupportedChainId
Returns SupportedTLD[]
- -
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function getSupportedTLDs
Returns supported TLDs for a given chain.
+- get
SupportedTLDs(chainId): SupportedTLD[] Parameters
- chainId: SupportedChainId
Returns SupportedTLD[]
-
-
-
-
-
-
-
-Function resolveAddressToDomain
-
-
- resolve
Address To Domain(address, options?): Promise<{
allPrimaryDomains: string[];
error: undefined;
primaryDomain: null | string;
} | {
allPrimaryDomains: undefined;
error: ResolveAddressError;
primaryDomain: undefined;
}>
- -
--
Resolves a given address to the assigned primary domain(s). -NOTE: When an address holds primary domains within multiple TLDs, - all primary domains will be returned. This case is currently not possible, - so
-allPrimaryDomainswill always return an array with 0 or 1 primary domain.--Parameters
--
-
-
-
address: string
--Address to resolve (e.g.
-5EFJEY4DG2FnzcuCZpnRjjzT4x7heeEXuoYy1yAoUmshEhAP)
- -
-
-Optionaloptions: Partial<ResolveAddressOptions>-Options (see
-ResolveOptionsdefinition)
Returns Promise<{
allPrimaryDomains: string[];
error: undefined;
primaryDomain: null | string;
} | {
allPrimaryDomains: undefined;
error: ResolveAddressError;
primaryDomain: undefined;
}>Primary domain(s) as string (null, if no primary domain found) or error
- - -
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function resolveAddressToDomain
Resolves a given address to the assigned primary domain(s).
+NOTE: When an address holds primary domains within multiple registries (TLDs),
+all primary domains will be returned. This case is currently not possible,
+so allPrimaryDomains will always return an array with 0 or 1 primary domain.
- resolve
Address To Domain(address, options?): Promise<{
allPrimaryDomains: string[];
error: undefined;
primaryDomain: null | string;
} | {
allPrimaryDomains: undefined;
error: ResolveAddressError;
primaryDomain: undefined;
}> Parameters
- address: string
Address to resolve (e.g.
+5EFJEY4DG2FnzcuCZpnRjjzT4x7heeEXuoYy1yAoUmshEhAP) Optionaloptions: Partial<ResolveAddressOptions>Options (see
+ResolveOptionsdefinition)
Returns Promise<{
allPrimaryDomains: string[];
error: undefined;
primaryDomain: null | string;
} | {
allPrimaryDomains: undefined;
error: ResolveAddressError;
primaryDomain: undefined;
}>Primary domain(s) as string (null, if no primary domain found) or error
+- address: string
-
-
-
-
-
-
-
-Function resolveDomainToAddress
-
-
- resolve
Domain To Address(domain, options?): Promise<{
address: null | string;
error: undefined;
} | {
address: undefined;
error: ResolveDomainError;
}>
- -
--
Resolves a given domain to the assigned address.
---Parameters
--
-
-
-
domain: string
--Domain to resolve (e.g.
-domains.azero)
- -
-
-Optionaloptions: Partial<ResolveDomainOptions>-Options (see
-ResolveDomainOptionsdefinition)
Returns Promise<{
address: null | string;
error: undefined;
} | {
address: undefined;
error: ResolveDomainError;
}>Address as string (null, if domain not found) or error
- - -
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function resolveDomainToAddress
Resolves a given domain to the assigned address.
+- resolve
Domain To Address(domain, options?): Promise<{
address: null | string;
error: undefined;
} | {
address: undefined;
error: ResolveDomainError;
}> Parameters
- domain: string
Domain to resolve (e.g.
+domains.azero) Optionaloptions: Partial<ResolveDomainOptions>Options (see
+ResolveDomainOptionsdefinition)
Returns Promise<{
address: null | string;
error: undefined;
} | {
address: undefined;
error: ResolveDomainError;
}>Address as string (null, if domain not found) or error
+- domain: string
-
-
-
-
-
-
-
-Function sanitizeDomain
-
-
- sanitize
Domain(value?, options?): string
- -
---
Parameters
--
-
-
-
Optionalvalue: string
- -
-
Optionaloptions: SanitizeDomainOptions
Returns string
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function sanitizeDomain
- sanitize
Domain(value?, options?): string Parameters
Optionalvalue: stringOptionaloptions: SanitizeDomainOptions
Returns string
-
diff --git a/docs/functions/_azns_resolver_react.useResolveDomainToAddress.html b/docs/functions/_azns_resolver_react.useResolveDomainToAddress.html
index d2999cc..00cd3b3 100644
--- a/docs/functions/_azns_resolver_react.useResolveDomainToAddress.html
+++ b/docs/functions/_azns_resolver_react.useResolveDomainToAddress.html
@@ -1,73 +1,3 @@
-
-
-
-
-
-Function useResolveAddressToDomain
-
-
- use
Resolve Address To Domain(address, options?): {
allPrimaryDomains: undefined | string[];
error: undefined | ResolveAddressError;
hasError: boolean;
isLoading: boolean;
primaryDomain: undefined | null | string;
}
- -
-
Resolves a given address to the assigned primary domain(s). +
useResolveAddressToDomain | AZERO.ID – Resolver --Function useResolveAddressToDomain
-Resolves a given address to the assigned primary domain(s). See
-resolveAddressToDomainfrom@azns/resolver-corefor more details.--Parameters
--
-
-
-
address: undefined | string
- -
-
Optionaloptions: Partial<ResolveAddressOptions>
Returns {
-
allPrimaryDomains: undefined | string[];
error: undefined | ResolveAddressError;
hasError: boolean;
isLoading: boolean;
primaryDomain: undefined | null | string;
}-
-
-
-
all
Primary Domains: undefined | string[]
- -
-
error: undefined | ResolveAddressError
- -
-
has
Error: boolean
- -
-
is
Loading: boolean
- -
-
primary
Domain: undefined | null | string
-- \ No newline at end of file +Generated using TypeDoc
-
-
- use
Resolve Address To Domain(address, options?): {
allPrimaryDomains: undefined | string[];
error: undefined | ResolveAddressError;
hasError: boolean;
isLoading: boolean;
primaryDomain: undefined | null | string;
} Parameters
- address: undefined | string
Optionaloptions: Partial<ResolveAddressOptions>
Returns {
allPrimaryDomains: undefined | string[];
error: undefined | ResolveAddressError;
hasError: boolean;
isLoading: boolean;
primaryDomain: undefined | null | string;
}all
Primary Domains: undefined | string[] error: undefined | ResolveAddressError
has
Error: boolean is
Loading: boolean primary
Domain: undefined | null | string
-
diff --git a/docs/index.html b/docs/index.html
index 18ffa1b..73f5ec4 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,100 +1,25 @@
-
-
-
-
-
-Function useResolveDomainToAddress
-
-
- use
Resolve Domain To Address(domain, options?): {
address: undefined | null | string;
error: undefined | ResolveDomainError;
hasError: boolean;
isLoading: boolean;
}
- -
-
Resolves a given domain to the assigned address. +
useResolveDomainToAddress | AZERO.ID – Resolver --Function useResolveDomainToAddress
-Resolves a given domain to the assigned address. See
-resolveDomainToAddressfrom@azns/resolver-corefor more details.--Parameters
--
-
-
-
domain: undefined | string
- -
-
Optionaloptions: Partial<ResolveDomainOptions>
Returns {
-
address: undefined | null | string;
error: undefined | ResolveDomainError;
hasError: boolean;
isLoading: boolean;
}-
-
-
-
address: undefined | null | string
- -
-
error: undefined | ResolveDomainError
- -
-
has
Error: boolean
- -
-
is
Loading: boolean
-- \ No newline at end of file +Generated using TypeDoc
-
-
- use
Resolve Domain To Address(domain, options?): {
address: undefined | null | string;
error: undefined | ResolveDomainError;
hasError: boolean;
isLoading: boolean;
} Parameters
- domain: undefined | string
Optionaloptions: Partial<ResolveDomainOptions>
Returns {
address: undefined | null | string;
error: undefined | ResolveDomainError;
hasError: boolean;
isLoading: boolean;
}address: undefined | null | string
error: undefined | ResolveDomainError
has
Error: boolean is
Loading: boolean
-
diff --git a/docs/interfaces/_azns_resolver_core.SanitizeDomainOptions.html b/docs/interfaces/_azns_resolver_core.SanitizeDomainOptions.html
index 79f7666..277ec8d 100644
--- a/docs/interfaces/_azns_resolver_core.SanitizeDomainOptions.html
+++ b/docs/interfaces/_azns_resolver_core.SanitizeDomainOptions.html
@@ -1,130 +1,8 @@
-
-AZERO.ID – Resolver
- -
-
-
+
-
-AZERO.ID – Resolver
AZERO.ID – Resolver
+
AZERO.ID – Resolver
AZERO.ID – Resolver
- -
This repository contains JS/TS libraries to resolve domains & addresses registered with AZERO.ID.
-It's built as a monorepo and contains the following packages:
+It's built as a monorepo and contains the following packages:
@azns/resolver-core– Vanilla JS/TS Library@azns/resolver-react– React-Hooks Library (depends on@azns/resolver-core)
Additionally, multiple working examples are provided for both packages.
-📃 Integration Guide: https://docs.azero.id/integration
-👩💻 Interface Documentation: https://azero-id.github.io/resolver/
-Testnet Disclaimer 🚨
Currently, this package is not production-ready and only works on the Aleph Zero Testnet. Aleph Zero Mainnet contract addresses are provided as soon as our contracts are deployed there.
-Getting Started
Vanilla JS/TS
Install the package from the npm registry:
-npm install @azns/resolver-core
# or
pnpm add @azns/resolver-core
# or
yarn add @azns/resolver-core
-Resolve domain → address via resolveDomainToAddress:
import { SupportedChainId, resolveDomainToAddress } from '@azns/resolver-core'
const { address, error } = await resolveDomainToAddress('domains.tzero', {
chainId: SupportedChainId.AlephZeroTestnet,
})
// Print result
if (error) console.log(error.message)
else console.log(address)
-Resolve address → primary domain(s) via resolveAddressToDomain:
import { SupportedChainId, resolveAddressToDomain } from '@azns/resolver-core'
const { primaryDomain, error } = await resolveAddressToDomain(
'5EeBxqQ7Kz6hcchEgkBn9ybBS4UaqGggi2Rq5weNyEZ9DjAK',
{
chainId: SupportedChainId.AlephZeroTestnet,
},
)
// Print result
if (error) console.log(error.message)
else console.log(primaryDomain)
-React/Next.js Hooks
Install the packages from the npm registry:
-npm install @azns/resolver-core @azns/resolver-react
# or
pnpm add @azns/resolver-core @azns/resolver-react
# or
yarn add @azns/resolver-core @azns/resolver-react
-Resolve domain → address via useResolveDomainToAddress:
import { SupportedChainId } from '@azns/resolver-core'
import { useResolveDomainToAddress } from '@azns/resolver-react'
const { address, error } = useResolveDomainToAddress('domains.tzero', {
chainId: SupportedChainId.AlephZeroTestnet,
})
-Resolve address → primary domain(s) via useResolveAddressToDomain:
import { SupportedChainId } from '@azns/resolver-core'
import { useResolveAddressToDomain } from '@azns/resolver-react'
const { primaryDomain, error } = useResolveAddressToDomain(
'5EeBxqQ7Kz6hcchEgkBn9ybBS4UaqGggi2Rq5weNyEZ9DjAK',
{
chainId: SupportedChainId.AlephZeroTestnet,
},
)
-Run Examples
# Setup Node.js (recommended via nvm)
# Install pnpm: https://pnpm.io/installation (recommended via node corepack)
# Clone this repository
# Install dependencies
pnpm i
# Build packages & Run examples:
# - Vanilla Example starts on http://localhost:4000
# - Next.js Example starts on http://localhost:3000
pnpm run dev:examples
-Additionally, multiple working examples are provided for both packages.
+Integration Guide 📃
Get started by checking out our detailed integration guide:
+https://docs.azero.id/integration
+Interface Documentation 👩💻
View the full interface documentation & types here:
+https://azero-id.github.io/resolver
+Packages 🚢
-
+
- https://www.npmjs.com/package/@azns/resolver-core +
- https://www.npmjs.com/package/@azns/resolver-react +
Run Examples
# Setup Node.js (recommended via nvm)
# Install pnpm: https://pnpm.io/installation (recommended via node corepack)
# Clone this repository
# Install dependencies
pnpm i
# Build packages & Run examples:
# - Vanilla Example starts on http://localhost:4000
# - Next.js Example starts on http://localhost:3000
pnpm run dev:examples
+
- 
-
-
-
\ No newline at end of file
+ Generated using TypeDoc
+
-
diff --git a/docs/media/integration-banner.png b/docs/media/integration-banner.png
new file mode 100644
index 0000000..bcdf7f0
Binary files /dev/null and b/docs/media/integration-banner.png differ
diff --git a/docs/media/vanilla-example.png b/docs/media/vanilla-example.png
new file mode 100644
index 0000000..afc8b28
Binary files /dev/null and b/docs/media/vanilla-example.png differ
diff --git a/docs/modules/_azns_resolver_core.html b/docs/modules/_azns_resolver_core.html
index c85eabe..1a9acf0 100644
--- a/docs/modules/_azns_resolver_core.html
+++ b/docs/modules/_azns_resolver_core.html
@@ -1,130 +1,33 @@
-
-
-SanitizeDomainOptions | AZERO.ID – Resolver
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface SanitizeDomainOptions
Sanitizes a given domain string (e.g. Name.azero → name.azero).
+
Interface SanitizeDomainOptions
Sanitizes a given domain string (e.g. Name.azero → name.azero).
By default, the domain will be trimmed and converted to lowercase.
Hierarchy
--
-
- SanitizeDomainOptions
- Index
-
-
-
Properties
-Properties
-Optional lowercase
-lowercase?: boolean
Optional remove
-remove
Optional remove
-remove
Optional replace
-replace
Optional trim
-trim?: boolean
-
-
\ No newline at end of file
+Generated using TypeDoc
interface SanitizeDomainOptions {
lowercase?: boolean;
removeDots?: boolean;
removeOuterNonAlphanumeric?: boolean;
replaceUnderscores?: boolean;
trim?: boolean;
}
lowercase?: boolean;
removeDots?: boolean;
removeOuterNonAlphanumeric?: boolean;
replaceUnderscores?: boolean;
trim?: boolean;
}
Index
Properties
-
diff --git a/docs/modules/_azns_resolver_react.html b/docs/modules/_azns_resolver_react.html
index e322ac4..8db9921 100644
--- a/docs/modules/_azns_resolver_react.html
+++ b/docs/modules/_azns_resolver_react.html
@@ -1,68 +1,10 @@
-
-AZERO.ID –
@azns/resolver-core - v1.7.0 | AZERO.ID – Resolver AZERO.ID –
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module @azns/resolver-core - v1.3.0
AZERO.ID – @azns/resolver-core
+
Module @azns/resolver-core - v1.7.0
AZERO.ID – @azns/resolver-core
This repository contains JS/TS libraries to resolve domains & addresses registered with AZERO.ID.
➡️ Full README: https://github.com/azero-id/resolver
📃 Integration Guide: https://docs.azero.id/integration
👩💻 Interface Documentation: https://azero-id.github.io/resolver/
-Index
-Enumerations
-Classes
-Interfaces
-Type Aliases
-Variables
-Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Enumerations
Classes
Interfaces
Type Aliases
Variables
Functions
-
diff --git a/docs/types/_azns_resolver_core.BaseResolveOptions.html b/docs/types/_azns_resolver_core.BaseResolveOptions.html
index 94d7bca..8a3d43d 100644
--- a/docs/types/_azns_resolver_core.BaseResolveOptions.html
+++ b/docs/types/_azns_resolver_core.BaseResolveOptions.html
@@ -1,95 +1,6 @@
-
-AZERO.ID –
@azns/resolver-react - v1.7.0 | AZERO.ID – Resolver AZERO.ID –
-
-
-
-
-
-
-
-Module @azns/resolver-react - v1.3.0
AZERO.ID – @azns/resolver-react
+
Module @azns/resolver-react - v1.7.0
AZERO.ID – @azns/resolver-react
This repository contains JS/TS libraries to resolve domains & addresses registered with AZERO.ID.
➡️ Full README: https://github.com/azero-id/resolver
📃 Integration Guide: https://docs.azero.id/integration
👩💻 Interface Documentation: https://azero-id.github.io/resolver/
-Index
-Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Functions
-
-
-
-
-
-
-
-Type alias BaseResolveOptions
Base
chainId: SupportedChainIds;
customApi?: ApiPromise;
customContractAddresses?: ContractAddresses;
debug?: boolean;
}
-chainId: SupportedChainIds;
customApi?: ApiPromise;
customContractAddresses?: ContractAddresses;
debug?: boolean;
}
Custom options for resolveAddressToDomain and resolveDomainToAddress.
-
-Type declaration
--
-
-
-
chain
Id: SupportedChainIds
- -
-
OptionalcustomApi?: ApiPromise
- -
-
OptionalcustomContract Addresses?: ContractAddresses
- -
-
Optionaldebug?: boolean
-
Param
Chain ID to use (default: alephzero, available: alephzero, alephzero-testnet, development).
Param
Custom API instance to use instead of creating the default one (faster and more memory efficient, if you already have an API instance)
- -Param
Custom contract addresses to overwrite the default ones. Mandatory for development network.
Param
Enable debug logging.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias BaseResolveOptions
Base
chainId: SupportedChainIds;
customApi?: ApiPromise;
customContractAddresses?: ContractAddresses;
debug?: boolean;
}
chainId: SupportedChainIds;
customApi?: ApiPromise;
customContractAddresses?: ContractAddresses;
debug?: boolean;
}
Custom options for resolveAddressToDomain and resolveDomainToAddress.
Param: chainId
Chain ID to use (default: alephzero, available: alephzero, alephzero-testnet, development).
Param: customApi
Custom API instance to use instead of creating the default one (faster and more memory efficient, if you already have an API instance)
+Param: customContractAddresses
Custom contract addresses to overwrite the default ones. Mandatory for development network.
Param: debug
Enable debug logging.
+
-
-
-
-
-
-
-Type alias Chain
Chain: {
name: string;
network: string;
rpcUrls: [string, ...string[]];
ss58Prefix?: number;
testnet?: boolean;
}
-name: string;
network: string;
rpcUrls: [string, ...string[]];
ss58Prefix?: number;
testnet?: boolean;
}
-
Type declaration
--
-
-
-
name: string
- -
-
network: string
- -
-
rpc
Urls: [string, ...string[]]
- -
-
Optionalss58Prefix?: number
- -
-
Optionaltestnet?: boolean
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias Chain
Chain: {
name: string;
network: string;
rpcUrls: [string, ...string[]];
ss58Prefix?: number;
testnet?: boolean;
}
name: string;
network: string;
rpcUrls: [string, ...string[]];
ss58Prefix?: number;
testnet?: boolean;
}
-
-
-
-
-
-
-Type alias ContractAddresses
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias ContractAddresses
-
-
-
-
-
-
-Type alias ResolveAddressErrorName
Resolve
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias ResolveAddressErrorName
Resolve
| "UNSUPPORTED_NETWORK"
| "INVALID_ADDRESS_FORMAT"
| "CONTRACT_ERROR"
| "OTHER_ERROR"
| "UNSUPPORTED_NETWORK"
| "INVALID_ADDRESS_FORMAT"
| "CONTRACT_ERROR"
| "OTHER_ERROR"
-
-
-
-
-
-
-
-Type alias ResolveAddressOptions
-
-Type declaration
--
-
-
-
OptionalignoreAddress Prefix?: boolean
-
Param
If true, the current chain ss58 prefix will be ignored and the address will be decoded with any prefix
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias ResolveAddressOptions
-
-
-
-
-
-
-Type alias ResolveDomainErrorName
Resolve
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias ResolveDomainErrorName
Resolve
| "UNSUPPORTED_NETWORK"
| "UNSUPPORTED_TLD"
| "INVALID_DOMAIN_FORMAT"
| "CONTRACT_ERROR"
| "OTHER_ERROR"
| "UNSUPPORTED_NETWORK"
| "UNSUPPORTED_TLD"
| "INVALID_DOMAIN_FORMAT"
| "CONTRACT_ERROR"
| "OTHER_ERROR"
-
-
-
-
-
-
-
-Type alias ResolveDomainOptions
-
-Type declaration
--
-
-
-
OptionalskipSanitization?: boolean
-
Param
Uses the exact given domain w/o sanitization like lowercasing (default: false)
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias ResolveDomainOptions
-
-
-
-
-
-Variable CONTRACT_ADDRESSES
-Variable CONTRACT_ADDRESSESConst
-
-
\ No newline at end of file
+Generated using TypeDoc
Variable CONTRACT_ADDRESSESConst
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
diff --git a/docs/variables/_azns_resolver_core.alephzeroTestnet.html b/docs/variables/_azns_resolver_core.alephzeroTestnet.html
index 20ad715..abd1b8f 100644
--- a/docs/variables/_azns_resolver_core.alephzeroTestnet.html
+++ b/docs/variables/_azns_resolver_core.alephzeroTestnet.html
@@ -1,73 +1 @@
-
-
-
-
-
-
-Variable alephzeroTestnet
-Variable alephzeroTestnetConst
-
-
\ No newline at end of file
+Generated using TypeDoc
Variable alephzeroTestnetConst
-
-
-
-
-
-Variable allChains
-Variable allChainsConst
-
-
\ No newline at end of file
+Generated using TypeDoc
Variable allChainsConst
-
-
-
-
-
-Variable allSupportedChainIds
-Variable allSupportedChainIdsConst
all
-
-
\ No newline at end of file
+Generated using TypeDoc
Variable allSupportedChainIdsConst
-
-
-
-
-
-Variable development
-Variable developmentConst
-
-
\ No newline at end of file
+Generated using TypeDoc
Optional override for formatting stack traces
-