Skip to main content
Version: v1

Introduction

Welcome to the ZIGChain SDK! This SDK allows developers to seamlessly interact with the ZIGChain blockchain, providing tools for querying data, managing wallets, and performing blockchain transactions in your JavaScript or TypeScript applications. Whether you're building decentralized applications (dApps), integrating blockchain features, or creating custom tools, the ZIGChain SDK provides all the essential components.

Why Use ZIGChain SDK?​

  • Easy to Use: Simplifies interaction with the ZIGChain blockchain by providing convenient methods and abstractions.
  • Comprehensive: Supports querying token data, pools, balances, and metadata, as well as performing complex operations such as swaps.
  • Network Flexibility: Supports different networks such as mainnet and testnet, and allows custom configurations for private or custom blockchain networks.
  • Modular: Built to be modular and flexible, it integrates with other Cosmos-based chains and wallets seamlessly.

Choosing Between ZIGChain SDK and ZIGChain SDK JS​

ZIGChain provides two Software Development Kits (SDKs) for building applications on its blockchain: ZIGChain SDK and ZIGChain SDK JS

Below is a comparison to help you to choose the right SDK based on their project requirements:

FeatureZIGChain SDKZIGChain SDK JS
DescriptionFrontend (FE) SDK leveraging Cosmos Kit, adapted for ZIGChainLightweight SDK suitable for both frontend and backend (FE/BE)
Best forRapid development with minimal customizationGreater flexibility and customization options
Frontend/BackendFrontendFrontend and Backend
Other requirements?Standalone usageCombine it with Cosmos Kit
Expertise levelBeginner-friendlyBest for advanced users or complex architectures/designs

When to use ZIGChain SDK or ZIGChain SDK JS?​

Use ZIGChain SDK if:

  • ✅ Best for frontend applications that need quick and simple blockchain integration.
  • ✅ Built-in wallet management via Cosmos Kit, with minimal setup required.
  • ✅ Ideal for querying balances, pools, and executing swaps without deep blockchain knowledge.

Example Use Case: A token factory frontend that enables users to create new tokens, check their balances, and manage supply directly from the UI with minimal configuration.

Use ZIGChain SDK JS if:

  • ✅ Works for both frontend and backend, enabling full-stack blockchain interactions.
  • ✅ Together with Cosmos Kit, provides a powerful set that offers flexibility to build any type of product.
  • ✅ Gives maximum flexibility for composing, signing, and broadcasting blockchain messages.

Example Use Case: A decentralized lending protocol, where the backend handles smart contract interactions, automates loan issuance, liquidations, and interest calculations. The SDK enables seamless communication between borrowers, lenders, and the protocol’s smart contracts across Cosmos-based networks.

Prerequisites: Authentication Setup​

Before installing the ZIGChain SDK, you need to configure authentication to access the package repository. The ZIGChain SDK is hosted on GitHub Packages and requires an authentication token.

Create a .npmrc file in the root directory of your project with the following content:

//npm.pkg.github.com/:_authToken=AUTH_TOKEN
@zigchain:registry=https://npm.pkg.github.com
always-auth=true

Replace AUTH_TOKEN with the authentication token provided by ZIGChain.

Getting Your Authentication Token

To obtain your authentication token, please contact the ZIGChain team through our official channels:

  • Discord - Join our community and reach out for support
  • Telegram - Connect with the team directly

For additional support channels, visit our Community & Support page.

This token is required to access and install ZIGChain packages from the GitHub registry.

After creating the .npmrc file and replacing the AUTH_TOKEN value, you can proceed with installing the ZIGChain SDK packages using npm install commands.

Installation​

To get started with the ZIGChain SDK, you need to install it in your project. Use your preferred package manager to install the SDK:

npm install @zigchain/zigchain-sdk @cosmos-kit/react

Cosmos-Kit Dependency​

The ZIGChain SDK depends on cosmos-kit, a powerful framework for connecting Cosmos wallets and managing blockchain interactions across multiple chains. Cosmos-Kit provides wallet integration and connection management for wallets like Keplr, Cosmostation, Leap, and more, allowing you to easily connect to various Cosmos-based blockchains.

Key Benefits of Cosmos-Kit:​

  • Multi-Wallet Support: Integrates seamlessly with popular wallets in the Cosmos ecosystem.
  • Multi-Chain Support: Easily switch between multiple Cosmos-based blockchains.
  • React Hooks: Provides hooks for wallet connection management, making it easy to integrate with React applications.
  • Composable Architecture: Designed for flexibility, making it easy to customize or extend for your specific needs.

For more information on how to integrate wallet support and manage connections with Cosmos-Kit, visit the official Cosmos-Kit documentation.

Setting up the SDK with ZigchainContextProvider​

After installing the dependencies, you'll need to configure the SDK in your application. This involves setting up the ZigchainContextProvider to manage wallet connections and blockchain interactions. It does not support being rendered as a server component. To use it properly in a Next.js (or similar) environment, it must be wrapped in a client component that includes the "use client" directive.

import { ZigchainContextProvider } from "@zigchain/zigchain-sdk";
import {
  zigchain,
  localzigchainAssetlist,
  mainnetConfig,
} from "@zigchain/zigchain-sdk"; // ZIGChain configurations

function App() {
  return (
    <ZigchainContextProvider network="mainnet">
      {/* Your app components */}
    </ZigchainContextProvider>
  );
}

export default App;

Custom Network Configuration​

If you're working with a custom ZIGChain network, you can easily pass custom configuration settings like rpcURL, apiURL, and prefix:

const customConfig = {
  rpcURL: "https://custom-rpc.example.com",
  apiURL: "https://custom-api.example.com",
  prefix: "custom",
};

<ZigchainContextProvider network="custom" customConfig={customConfig}>
  {/* Your app components */}
</ZigchainContextProvider>;

This provides flexibility to integrate with custom networks or test environments.

Next Steps​

Once you've set up the SDK and ZigchainContextProvider, you're ready to start interacting with the ZIGChain blockchain. Check out our Hooks Documentation and examples to see how to query tokens, fetch balances, and perform other blockchain actions.

For more advanced configuration and usage, head over to the Context Provider section.