Overview

Learn how to use the Abridged SDK to easily add Web 3 components, modularly extending your application's functionality.

How it works

With the Abridged SDK, you can integrate Web 3 components to leverage capabilities that are only available with blockchain technology. You can easily configure an existing native mobile or web-based application to include Web 3 features without compromising your product experience.

An application using Abridged consists of 3 main components:

  1. Your native mobile or web-based application

  2. Your backend

  3. The Abridged SDK

The SDK is currently available for JavaScript applications. iOS and Android compatibility is arriving soon so be on the lookout.

If you're looking for a more detailed reference with all available methods, objects, and errors, consult our full SDK reference.

SDK playground

We provide a convenient hosted front-end that can be used to quickly experiment with all the method calls available with the Abridged SDK without having to download anything locally. Head over to the SDK Playground documentation to start diving into the Abridged SDK functionality on a test network.

Step 1: Install the SDK

The Abridged SDK is still in pre-release version and is distributed under the codename "Archanova".

To install the Abridged SDK, run the following command in your terminal.

npm install @archanova/sdk -S

Abridged periodically releases updates to the SDK which can include new functionality, bug fixes, and security updates. We recommend you update your integrated version of the Abridged SDK as soon as a new version is available.

Step 2: Initialize the SDK

The sdk object made available by the Abridged SDK exposes an interface for integrating and interacting with various Web 3 components.

To initialize an Abridged SDK instance in your JavaScript application, import the SDK and insert the following initialization code into your app codebase.

JavaScript
// Inject into import block
import {
getSdkEnvironment,
SdkEnvironmentNames,
createSdk
} from '@archanova/sdk';
‚Äč
// Select the ethereum network
let sdkEnv = getSdkEnvironment(SdkEnvironmentNames.Kovan); // kovan env by default
// Create SDK instance and store locally
const sdk = new createSdk(sdkEnv.setConfig('storageAdapter', localStorage));
// Initialize instance
await sdk.initialize();