Socket
Socket
Sign inDemoInstall

@siddomains/sidjs

Package Overview
Dependencies
649
Maintainers
5
Versions
29
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @siddomains/sidjs

sid.js v2


Version published
Maintainers
5
Created

Readme

Source

Use sidjs SDK to interact with SID contracts

SID.js

SIDjs integrates the SID contract and ENS and supports all the ENSjs APIs, you will only need one unified SDK to integrate all domains across multiple chains. SIDjs will hide all the complicated cross-chain detail from the partners, making the integration very easy.

Overview of the API

Installation

Install @siddomains/sidjs, alongside Ethers v5.

npm install @siddomains/sidjs ethers@5.7.2

Getting Started

All that's needed to get started is a web3 provider instance, you should pass it and select network id when creating a new SID instance.

// bsc test domain example
const SID = require('@siddomains/sidjs').default      
const SIDfunctions = require('@siddomains/sidjs')                                                                                                                                                                                
const ethers = require('ethers')                                                                                                                

let sid 

async function main(name) {
  const infura = "https://data-seed-prebsc-1-s1.binance.org:8545/"  
  const provider = new ethers.providers.JsonRpcProvider(infura)
  sid = new SID({ provider, sidAddress: SIDfunctions.getSidAddress('97') })

  const address = await sid.name(name).getAddress() // 0x123                                                                                
  console.log("name: %s, address: %s", name, address)                                                                                          

}                                                                                                                                           
main("resolver.bnb")
// bsc mainnet domain example
const SID = require('@siddomains/sidjs').default      
const SIDfunctions = require('@siddomains/sidjs')
const rpc = require('@siddomains/sidjs/dist/constants/rpc')                                                                                                                                                                                
const ethers = require('ethers')                                                                                                                

let sid 

async function main(name) {
  const provider = new new ethers.providers.JsonRpcProvider(rpc.apis.bsc_mainnet)
  sid = new SID({ provider, sidAddress: SIDfunctions.getSidAddress('56') })

  const address = await sid.name(name).getAddress() // 0x123                                                                                
  console.log("name: %s, address: %s", name, address)                                                                                          

}                                                                                                                                           
main("resolver.bnb")

// ens domain example
const SID = require('@siddomains/sidjs').default      
const SIDfunctions = require('@siddomains/sidjs')                                                                                                                                                                                
const ethers = require('ethers')                                                                                                                

let sid 

async function main(name) {
  const infura = "https://web3.ens.domains/v1/mainnet"
  const provider = new ethers.providers.JsonRpcProvider(infura)
  sid = new SID({ provider, sidAddress: SIDfunctions.getSidAddress('1') })

  const address = await sid.name(name).getAddress() // 0x123                                                                                
  console.log("name: %s, address: %s", name, address)                                                                                          

}                                                                                                                                           
main("resolver.ens")

exports

default - SID
getSidAddress
getResolverContract
getSIDContract
namehash
labelhash

SID Interface

name(name: String) => Name

Returns a Name Object, that allows you to make record queries.

resolver(address: EvmAddress) => Resolver

Returns a Resolver Object, allowing you to query names from this specific resolver. Most useful when querying a different resolver that is different than is currently recorded on the registry. E.g. migrating to a new resolver

async getName(address: EvmAddress) => Promise<Name>

Returns the reverse record for a particular Evm address.

async setReverseRecord(name: Name) => Promise<EthersTxObject>

Sets the reverse record for the current Evm address

Name Interface

async getOwner() => Promise<EvmAddress>

Returns the owner/controller for the current SID name.

async setOwner(address: EvmAddress) => Promise<Ethers>

Sets the owner/controller for the current SID name.

async getResolver() => Promise<EvmAddress>

Returns the resolver for the current SID name.

async setResolver(address: EvmAddress) => Promise<EvmAddress>

Sets the resolver for the current SID name.

async getTTL() => Promise<Number>

Returns the TTL for the current SID name.

async getAddress(coinId: String) => Promise<EvmAddress>

Returns the address for the current SID name for the coinId provided.

async setAddress(coinId: String, address: EvmAddress) => Promise<EthersTxObject>

Sets the address for the current SID name for the coinId provided.

async getContent() => Promise<ContentHash>

Returns the contentHash for the current SID name.

async setContenthash(content: ContentHash) => Promise<EthersTxObject>

Sets the contentHash for the current SID name.

async getText(key: String) => Promise<String>

Returns the text record for a given key for the current SID name.

async setText(key: String, recordValue: String) => Promise<EthersTxObject>

Sets the text record for a given key for the current SID name.

async setSubnodeOwner(label: String, newOwner: EvmAddress) => Promise<EthersTxObject>

Sets the subnode owner for a subdomain of the current SID name.

async setSubnodeRecord(label: String, newOwner: EvmAddress, resolver: EvmAddress, ttl: ?Number) => Promise<EthersTxObject>

Sets the subnode owner, resolver, ttl for a subdomain of the current SID name in one transaction.

 async createSubdomain(label: String) => Promise<EthersTxObject>

Creates a subdomain for the current SID name. Automatically sets the owner to the signing account.

async deleteSubdomain(label: String) => Promise<EthersTxObject>

Deletes a subdomain for the current SID name. Automatically sets the owner to "0x0..."

Resolver Interface

address

Static property that returns current resolver address

name(name) => Name

Returns a Name Object that hardcodes the resolver

Build SDK and test on your test machine

yarn install
yarn run build
node main.js

FAQs

Last updated on 21 Jul 2023

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