EDNS SDK for JavaScript

Abstract

The EDNS SDK is a comprehensive toolkit designed to seamlessly integrate with the EDNS smart contract and resolver API. It empowers developers by providing an intuitive set of tools and resources for connecting, managing, and interacting with the EDNS ecosystem. With this SDK, users can effortlessly harness the full potential of EDNS's advanced blockchain functionalities to create robust and innovative decentralized applications.

Table of Contents:

• Getting Started
• Getting Help
• Contributing

Getting Started

How To Install

In Node.js

The preferred way to install the EDNS SDK for Node.js is to use the npm package manager for Node.js. Simply type the following into a terminal window:

npm install @edns/core

Usage with TypeScript

The EDNS SDK for JavaScript bundles TypeScript definition files for use in TypeScript projects and to support tools that can read .d.ts files. Our goal is to keep these TypeScript definition files updated with each release for any public api.

Pre-requisites

Before you can begin using these TypeScript definitions with your project, you need to make sure your project meets a few of these requirements:

• Use latest version of TypeScript. We recommend 5.x+

• Includes the TypeScript definitions for node. You can use npm to install this by typing the following into a terminal window:

  npm install --save-dev @types/node

• If you are targeting at es5 or older ECMA standards, your tsconfig.json has to include 'es5' and 'es2015.promise' under compilerOptions.lib.

In Node.js

To use the TypeScript definition files within a Node.js project, simply import edns-sdk as you normally would.

In a TypeScript file:

// import entire SDK
import EDNS from '@edns/core';
// import EDNS object for custom features
import {EDNS} from '@edns/core';

NOTE: You need to add "esModuleInterop": true to compilerOptions of your tsconfig.json. If not possible, use like import * as EDNS from '@edns/core'.

Getting Help

The best way to interact with our team is through GitHub or email.

Contributing

We welcome community contributions and pull requests.

More in documentation