types.ts

export type Dictionary<T> = { [k: string]: T };

/**
 * SourceDefinition object
 * @typedef {Object} SourceDefinition
 * @property {string} [url] - main blockchain api url
 * @property {string | number} [network] - blockchain network
 */
export interface SourceDefinition {
  url?: string;
  network?: string | number;
  registry?: string;
}

/**
 * NamingServiceSource
 * just an alias
 * @typedef {string | boolean | SourceDefinition}
 */
export type NamingServiceSource = string | boolean | SourceDefinition;

/**
 * EnsNetworkIdMap
 * type represending the map between network number and network name
 * @typedef
 */
export type EnsNetworkIdMap = {
  [key: number]: string;
};

/**
 * BlockcahinNetworkUrlMap
 * type representing a map between network name such as
 *  - mainnet
 *  - ropsten
 * and a corresponding url
 * @typede
 */

export interface BlockhanNetworkUrlMap {
  [key: string]: string;
}

/**
 * RegistryMap
 * type represending the map between network name and registry address for specific NamingService
 */
export interface RegistryMap {
  [key: string]: string;
}

/**
 * ResolutionResulution
 * @typedef ResolutionResponse
 * @property {Object} addresses - Resolution addresses for various currency addresses attached to the domain
 * @property {Object} meta - meta information about the owner of the domain
 */
export type ResolutionResponse = {
  addresses: {
    [key: string]: string;
  };
  meta: {
    owner: string;
    type: string; //available domain
    ttl: number;
  };
};

/**
 * @internal
 * Used internally to map network number to a string
 */
export type NetworkIdMap = {
  [key: number]: string;
};

/**
 * Main configurational object for Resolution instance
 */
export type Blockchain =
  | boolean
  | {
      ens?: NamingServiceSource;
      zns?: NamingServiceSource;
      cns?: NamingServiceSource;
    };

/**
 * Default structure of ZnsResolution records
 * @typedef {object} ZnsResolution
 */
export type ZnsResolution = {
  crypto?: Dictionary<{ address?: string; [key: string]: any }>;
  ttl?: string;
  [key: string]: any;
};

export type Bip44Constants = [number, string, string];
export type owner = string;
export type ttl = string;

export const NullAddress = '0x0000000000000000000000000000000000000000';
export const NullAddressExtended =
  '0x0000000000000000000000000000000000000000000000000000000000000000';
export const EthCoinIndex = 60;

export const UnclaimedDomainResponse: ResolutionResponse = {
  addresses: {},
  meta: {
    owner: null, //available domain
    type: '',
    ttl: 0,
  },
};

/**
 * @deprecated Use UnclaimedDomainResponse instead (deprecated since 0.3.4)
 */
export const UNCLAIMED_DOMAIN_RESPONSE = UnclaimedDomainResponse;