SoneiumDomains JS SDK

The ultimate Soneium Domains javascript library, with viem under the hood.

Features

• Super fast response times
• Easy call batchability
• Written in TypeScript
• Supports the most cutting edge ENS features
• Full tree-shaking support

Installation

Install @soneium-domains/js, alongside viem.

npm install @soneium-domains/js viem

or

yarn add @soneium-domains/js viem

Getting Started

The most simple way to get started is to create a public ENS client, with a supported chain and transport imported from viem. The public client has all the read functions available on it, as well as all subgraph functions.

// Import viem transport, viem chain, and @soneium-domains/js
import { http } from 'viem'
//import { minato } from 'viem/chains'
import { createEnsPublicClient } from '@soneium-domains/js'

const minato = {
  id: 1946,
  chainId : 1946,
  name: "Soneium Minato",
  rpcUrls: { default : { http : ['https://rpc.minato.soneium.org/']}},
  rpc: 'https://rpc.minato.soneium.org/',
  nativeCurrency: {
    name: "Minato Ether",
    symbol: "ETH",
    decimals: 18,
  },
  blockExplorers: [
    {
      name: "Minato Explorer",
      url: "https://explorer-testnet.soneium.org/",
      apiUrl: "https://explorer-testnet.soneium.org/api",
    },
  ],
  testnet: true,
};

// Create the client
const client = createEnsPublicClient({
  chain: minato,
  transport: http(),
})

// Use the client
const ethAddress = client.getAddressRecord({ name: 'sam.son' })

Docs

Full docs site coming soon.