Socket
Socket
Sign inDemoInstall

@ic-naming/client

Package Overview
Dependencies
7
Maintainers
2
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ic-naming/client

[![CI & CD](https://github.com/IC-Naming/js-sdk/actions/workflows/pipeline.yml/badge.svg)][1]


Version published
Maintainers
2

Readme

Source

IC-Naming JavaScript SDK

CI & CD

NPM

Installing

Using npm:

npm install @dfinity/{agent,candid,principal} # dfinity dependencies
npm install @ic-naming/client

Using yarn:

yarn add @dfinity/{agent,candid,principal} # dfinity dependencies
yarn add @ic-naming/client

Example

import { Principal } from "@dfinity/principal";
import { IcNamingClient } from "@ic-naming/client";

const client = new IcNamingClient({
  net: "IC", // IC | ICP | TICP
  mode: "production", // local | production
});

// get records
client.getRecordsOfName("helloworld.ic").then((records) => {
  // get ICP address(principal)
  const principal = records.find((r) => r[0] === "principal.icp");
  console.debug(`helloworld.ic's principal is ${principal}`);

  // get ICP address(account id)
  const accountId = records.find((r) => r[0] === "account_id.icp");
  console.debug(`helloworld.ic's account id is ${accountId}`);

  // get twitter
  const twitter = records.find((r) => r[0] === "com.twitter");
  console.debug(`helloworld.ic's twitter is ${twitter}`);

  // get eth address
  const ethAdddress = records.find((r) => r[0] === "token.eth");
  console.debug(`helloworld.ic's eth adddress is ${ethAdddress}`);
});

// get name's registrant
client.getRegistrantOfName("helloworld.ic").then((registrant) => {
  console.debug(`helloworld.ic's registrant is ${registrant}`);
});

// get name's expired time
client.getExpiredTimeOfName("helloworld.ic").then((timestamp) => {
  const expiredTime = new Date(Number(timestamp));
  console.debug(`helloworld.ic's expired time is ${expiredTime}`);
});

// get reverse resolve
const thePrincipal = Principal.fromText(
  "v2xhg-um7x6-mhni4-sgqsc-qarqs-bgoyy-ngobl-qoe7c-7a4cm-bvn4f-pqe"
);

client.getReverseResolve(thePrincipal).then((name) => {
  if (name) console.debug(`reverse resolve name is ${name}`);
  else console.debug(`reverse resolve name not exist`);
});

Special host and identity:

import { IcNamingClient } from "@ic-naming/client";

const client = new IcNamingClient({
  net: "IC",
  mode: "production", // local | production
  httpAgent: {
    host: "https://ic0.app", // default by mode
    identity: {
      identity: {
        transformRequest: () => {
          /* ... */
        },
        getPrincipal: () => {
          /* ... */
        },
      },
    },
  },
});

More example in repo

  • React App - A "React App" for search naming

Client API

client.ts

https://IC-Naming.github.io/js-sdk/

Contribute

Local commands:

yarn dev # rollup library watch mode
yarn type # typescript type check
yarn test # jest unit test
yarn build # rollup build to dist/
yarn release # generate new version

Release

git tag vX.Y.Z HEAD  # Create a tag started with "v" to trigger CI/CD pipeline

git push origin main --tags

Keywords

FAQs

Last updated on 21 Jul 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc