Options
All
  • Public
  • Public/Protected
  • All
Menu

Facade class that surfaces all of the libraries capability and allow it's configuration. Uses conseiljs framework.

Hierarchy

  • ConseilTezosDomainsClient

Index

Constructors

constructor

Accessors

isSupported

  • get isSupported(): boolean
  • Whether this is supported instance of ConseilTezosDomainsClient (as opposed to ConseilTezosDomainsClient.Unsupported)

    Returns boolean

resolver

  • Gets the resolver instance. The resolver contains functions for resolving names and addresses.

    Returns NameResolver

validator

  • Gets the validator instance. The validator contains functions for validating domain names.

    Returns DomainNameValidator

Static Unsupported

  • Gets a singleton instance with method that are stubbed and return null or default value, or throw an exception. This instance can be used in an app that supports multiple networks where on some of them Tezos Domains are supported and on other not supported (contracts are not deployed etc.).

    example
    function getClient(network: string) {
        if(isTezosDomainsSupportedNetwork(network)) {
             return new ConseilTezosDomainsClient({ network, tezos });
        } else {
             return ConseilTezosDomainsClient.Unsupported;
        }
    }
    
    const client = getClient('unsupportednetwork');
    
    if (client.isSupported) { // not executed
        // ...
    }
    
    await client.resolver.resolveNameToAddress('alice.tez'); // returns null

    Returns ConseilTezosDomainsClient

Methods

setConfig

  • Parameters

    Returns void

Generated using TypeDoc