Skip to content

galacticcouncil/sdk-legacy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2,057 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Galactic SDK (Legacy)

Build SDK License

Legacy packages for Hydration chain integration. This monorepo contains the stable, @polkadot/api-based trading SDK and cross-chain transfer toolkit. These packages are maintained for existing consumers but are not recommended for new projects.

Table of Contents

Overview

┌────────────────────────────────────────────────────────────┐
│                         Your dApp                          │
├────────────────────────────────┬───────────────────────────┤
│           « sdk »              │       « xcm-sdk »         │
│           ··········           │       ············        │
│           Trade routing        │       Cross-chain         │
│           Pool queries         │       Transfers           │
├────────────────────────────────┴───────────────────────────┤
│             @polkadot/api — Substrate SDK                  │
└────────────────────────────────────────────────────────────┘

Getting Started

Prerequisites

  • Node.js 23+
  • npm 10+

Installation

Pick the packages you need:

# Trading SDK
npm i @galacticcouncil/sdk

# Cross-chain transfers
npm i @galacticcouncil/xcm-sdk @galacticcouncil/xcm-cfg

SDK

Trade router and pool utilities for Hydration, built on @polkadot/api.

Package Version Changelog Description
@galacticcouncil/sdk sdk_v changelog Trade router & pool utilities (@polkadot/api)

XCM (Cross-Chain)

Stable cross-chain transfer toolkit built on @polkadot/api. Production-proven with extensive route coverage.

Package Version Changelog Description
@galacticcouncil/xcm-core xcm-core_v changelog Core types, chain & asset definitions
@galacticcouncil/xcm-cfg xcm-cfg_v changelog Pre-built route configs & DEX integrations
@galacticcouncil/xcm-sdk xcm-sdk_v changelog Wallet interface for cross-chain transfers

Architecture

@galacticcouncil/xcm-sdk  ← Wallet, transfers, fee swaps
@galacticcouncil/xcm-cfg  ← Route configs, DEX implementations
@galacticcouncil/xcm-core ← Core types, chain & asset definitions

Examples

Ready-to-run examples are available in the examples/ directory:

Example Description
sdk-cjs SDK usage with CommonJS
sdk-esm SDK usage with ES Modules
xcm-transfer XCM cross-chain transfer

Contributing

Everything about building, setting up development environment & releasing can be found in CONTRIBUTING.md.

Issue Reporting

In case of unexpected SDK behaviour, please create a well-written issue here. It makes it easier to find & fix the problem accordingly.

Legal

This file is part of https://github.com/galacticcouncil/*

               $$$$$$$      Licensed under the Apache License, Version 2.0 (the "License")
            $$$$$$$$$$$$$        you may only use this file in compliance with the License
         $$$$$$$$$$$$$$$$$$$
                     $$$$$$$$$       Copyright (C) 2021-2024  Intergalactic, Limited (GIB)
        $$$$$$$$$$$   $$$$$$$$$$                       SPDX-License-Identifier: Apache-2.0
     $$$$$$$$$$$$$$$$$$$$$$$$$$
  $$$$$$$$$$$$$$$$$$$$$$$        $                      Built with <3 for decentralisation
 $$$$$$$$$$$$$$$$$$$        $$$$$$$
 $$$$$$$         $$$$$$$$$$$$$$$$$$      Unless required by applicable law or agreed to in
  $       $$$$$$$$$$$$$$$$$$$$$$$       writing, software distributed under the License is
     $$$$$$$$$$$$$$$$$$$$$$$$$$        distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
     $$$$$$$$$   $$$$$$$$$$$         OR CONDITIONS OF ANY KIND, either express or implied.
       $$$$$$$$
         $$$$$$$$$$$$$$$$$$            See the License for the specific language governing
            $$$$$$$$$$$$$                   permissions and limitations under the License.
               $$$$$$$
                                                                $$
 $$$$$   $$$$$                    $$                      $$
  $$$     $$$  $$$     $$   $$$$$ $$  $$$ $$$$  $$$$$$$  $$$$  $$$    $$$$$$   $$ $$$$$$
  $$$     $$$   $$$   $$  $$$    $$$   $$$  $  $$     $$  $$    $$  $$     $$$  $$$   $$$
  $$$$$$$$$$$    $$  $$   $$$     $$   $$        $$$$$$$  $$    $$  $$     $$$  $$     $$
  $$$     $$$     $$$$    $$$     $$   $$     $$$     $$  $$    $$  $$$     $$  $$     $$
 $$$$$   $$$$$     $$      $$$   $$$   $$     $$$$   $$$  $$    $$   $$$   $$   $$    $$$
                  $$         $$$$$               $$$$$     $$          $$$$
                $$$

For more details read LICENSE.md

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors