namicorn/build/ens.d.ts

import { SourceDefinition, NamicornResolution } from './types';
import NamingService from './namingService';
/**
 * Class to support connection with Etherium naming service
 * @param network - network string such as
 * - mainnet
 * - ropsten
 * @param url - main api url such as
 * - https://mainnet.infura.io
 * @param registryAddress - address for a registry contract
 */
export default class Ens extends NamingService {
    readonly network: string;
    readonly url: string;
    readonly registryAddress?: string;
    private ensContract;
    /**
     * Source object describing the network naming service operates on
     * @param source - if specified as a string will be used as main url, if omited then defaults are used
     * @throws ConfigurationError - when either network or url is setup incorrectly
     */
    constructor(source?: string | boolean | SourceDefinition);
    /**
     * Checks if the domain is in valid format
     * @param domain - domain name to be checked
     */
    isSupportedDomain(domain: string): boolean;
    /**
     * Checks if the current network is supported
     */
    isSupportedNetwork(): boolean;
    /**
     * Reverse the ens address to a ens registered domain name
     * @async
     * @param address - address you wish to reverse
     * @param currencyTicker - currency ticker like BTC, ETH, ZIL
     * @returns Domain name attached to this address
     */
    reverse(address: string, currencyTicker: string): Promise<string>;
    /**
     * Resolves domain to a specific cryptoAddress
     * @param domain - domain name to be resolved
     * @param currencyTicker - specific currency ticker such as
     *  - ZIL
     *  - BTC
     *  - ETH
     * @returns A promise that resolves in a string
     * @throws ResolutionError
     */
    address(domain: string, currencyTicker: string): Promise<string>;
    /**
     * Owner of the domain
     * @param domain - domain name
     * @returns An owner address of the domain
     */
    owner(domain: string): Promise<string | null>;
    /**
     * Resolves the given domain
     * @async
     * @param domain - domain name to be resolved
     * @returns A promise that resolves in an object
     */
    resolve(domain: string): Promise<NamicornResolution | null>;
    /**
     * Produces ENS namehash
     * @param domain - domain to be hashed
     * @returns ENS namehash of a domain
     */
    namehash(domain: string): string;
    /**
     * Normalizes the source object based on type
     */
    protected normalizeSource(source: string | boolean | SourceDefinition): SourceDefinition;
    /**
     * This was done to make automated tests more configurable
     */
    private resolverCallToName;
    /**
     * This was done to make automated tests more configurable
     */
    private getResolver;
    /**
     * This was done to make automated tests more configurable
     */
    private getOwner;
    /**
     * This was done to make automated tests more configurable
     */
    private getResolutionInfo;
    private getCoinType;
    /**
     * @param resolver - resolver address
     * @param nodeHash - namehash of a domain name
     */
    private fetchAddress;
    /**
     * Look up for network from url provided
     * @param url - main api url for blockchain
     * @returns Network such as:
     *  - mainnet
     *  - testnet
     */
    private networkFromUrl;
    /**
     * Internal wrapper for ens method. Used to throw an error when ens is down
     *  @param method - method to be called
     *  @throws ResolutionError -> When blockchain is down
     */
    private callMethod;
}