@cubed/coreid-util

Why use it

This project is to simplify the use of conflux coreid, without paying attention to the specific function details of different contracts, and will also process parameters and return values, making it easier to call and view results.

In addition, it supports the multicall method, which can call multiple different functions with apply different parameters in one RPC call

How to use

const ADDRESS1 = "cfxtest:aargwwstcp4axhxgkxfuy9pent1vtmaskjwr12xfsj";
// registered 88888888.web3, xiaokonglong.web3
const ADDRESS2 = "cfxtest:aap7yfv4bhh5db8xrnu3w27v8dcjzwavty234a1hjz";
// registered 666666.web3
const NAME1 = "666666.web3";
const NAME2 = "88888888.web3";
const NAME2_SUBDOMAIN = "subdomain.88888888.web3";
const DNS_NOTATION = "\x05hello\x04web3\x00";

// Get CoreidUtil instance
const coreidutil = new CoreidUtil();
// Get CoreidUtil instance with optional config, all options are individually configurable:
// const coreidutilWithConfig = new CoreidUtil({
//   networkId: 1029,
//   rpc: "https://main.confluxrpc.com",
//   contracts: { // note: contract name should be uppercase
//     REVERSE_REGISTRAR: "",
//     BASE_REGISTRAR: "",
//     NAME_WRAPPER: "",
//     WEB3_CONTROLLER: "",
//     PUBLIC_RESOLVER: "",
//     REVERSE_RECORDS: "",
//     MULTICALL: "",
//   }
// });

// Get owner of name
const owner = await coreidutil.ownerOf(NAME1);

// Get owned names of address
const userDomains = await coreidutil.userDomains(ADDRESS1);

// Get forward resolved address of name
const forwardResolvedAddress = await coreidutil.address(NAME2);

// Get parent name and forward resolved address of subdomain name
const parent = await coreid.parent(NAME2_SUBDOMAIN);

// Get expiration time
const nameExpires = await coreidutil.nameExpires(NAME2);

// Get reverse resolved name of address
// Note:
//   For security reasons, when the forward resolved record and reverse resolved record configs are inconsistent, the reverse resolved name will return empty. For detail reference:
//   https://web3-username.gitbook.io/.web3-username-docs/contract-api-reference/publicresolver#xu-yao-zhu-yi-de-shi
const name = await coreidutil.name(ADDRESS1);

// Get reverse resolved names of multiple addresses
// Note:
//   For security reasons, when the forward resolved record and reverse resolved record configs are inconsistent, the reverse resolved name will return empty. For detail reference:
//   https://web3-username.gitbook.io/.web3-username-docs/contract-api-reference/publicresolver#xu-yao-zhu-yi-de-shi
const names = await coreidutil.names([ADDRESS1, ADDRESS1]);

// Get status of name, results in: Valid, TooShort, Reserved, IllegalChar, Locked, Registered, SoldOut
const status = await coreidutil.status(NAME1);

// Get registrant contract address of name
const registrant = await coreid.registrant(NAME1);

// Get controller contract address of name
const controller = await coreid.controller(NAME1);

// Call multiple different functions with apply different parameters in one RPC call
const MULTICALL_PARAMS = [
  {
    method: "ownerOf",
    args: [NAME1],
  },
  {
    method: "userDomains",
    args: [ADDRESS1],
  },
  {
    method: "address",
    args: [NAME2],
  },
  {
    method: "parent",
    args: [NAME2_SUBDOMAIN],
  },
  {
    method: "nameExpires",
    args: [NAME2],
  },
  {
    method: "name",
    args: [ADDRESS1],
  },
  {
    method: "names",
    args: [[ADDRESS1, ADDRESS2]],
  },
  {
    method: "status",
    args: [NAME1],
  },
  {
    method: "registrant",
    args: [NAME1],
  },
  {
    method: "controller",
    args: [NAME1],
  },
];
const MULTICALL_RESULT = await coreid.multicall(MULTICALL_PARAMS);

// utils
const {namehash, dnsNameNotationDecode, labelhash } = CoreidUtil.utils;
namehash(NAME1);
labelhash(NAME1.split('.')[0]);
dnsNameNotationDecode(DNS_NOTATION);

CoreID related resources

• SDK: web3ns.js
• Docs:
  • Github
  • Developer Docs
  • Contracts Docs
  • Demo
  • Contracts API

CoreID util project default config:

const NETWORK = {
  mainnet: 1029,
  testnet: 1,
};

const DEFAULT_NETWORK = "testnet";

const RPC = {
  mainnet: "https://main.confluxrpc.com",
  testnet: "https://test.confluxrpc.com",
};

const ROOT = ".web3";

const RPC = {
  mainnet: "https://main.confluxrpc.com",
  testnet: "https://test.confluxrpc.com",
};

const CONTRACTS = {
  // TBD
  mainnet: {
    CNS_REGISTRY: "",
    REVERSE_REGISTRAR: "",
    BASE_REGISTRAR: "",
    NAME_WRAPPER: "",
    WEB3_CONTROLLER: "",
    PUBLIC_RESOLVER: "",
    REVERSE_RECORDS: "",
    UTIL: "",
    MULTICALL: "cfx:achfcd4z000fw2977dz09z8nat38wxbfrynkxpe15v",
  },
  // come from: https://web3-username.gitbook.io/.web3-username-docs/deployment#testnet
  testnet: {
    CNS_REGISTRY: "cfxtest:acemru7fu1u8brtyn3hrtae17kbcd4pd9u2m761bta",
    REVERSE_REGISTRAR: "cfxtest:acfarpzehntpre0thg8x7dp0ajw4ms328pe1mm17vd",
    BASE_REGISTRAR: "cfxtest:acg08bujp0kmsup1zk11c9mad7zd6648eynbcjtndm",
    NAME_WRAPPER: "cfxtest:acapc3y2j7atme3bawvaex18hs36tn40uu5h6j3mtu",
    WEB3_CONTROLLER: "cfxtest:aca1858y5a9fnyx9rxd1c9knr517cd0e6afzzhgj01",
    REVERSE_RECORDS: "cfxtest:acgddsj3kah2f4f4c6959bvc4732f4juyj90h0zmg2",
    UTIL: "cfxtest:aca4w63ypgup8tryphprzfcrh5kh0hpbgasb2z3s0j",
    MULTICALL: "cfxtest:acexk57dcp2gcaydnyyz615b1993c319uup08gwwzs",
  },
};

Please Note

Environment That Can Be Used

At present, the contract is only deployed on the testnet and cannot be used on the mainnet.

Install Dependence

Note: This project is depending on js-conflux-sdk, buffer and bignumber.js
if your project does not use it, run npm i -D js-conflux-sdk buffer bignumber.js to install first.

Getting Started

This project was bootstrapped with Vite.

Available Scripts

In the project directory, you can run:

npm i

Install project dependence

npm run dev

Runs the project in the development mode.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run build

Builds the project for production to the dist folder.
It correctly bundles project in production mode and optimizes the build for the best performance.

The build is minified.