Hyperion Docs
  • Home
  • Overview
    • Introduction
    • Contact
    • Glossary
    • Roadmap
  • Concepts
    • Concentrated Liquidity
    • Fees
    • Swap
    • Liquidity Mining
    • Range Order
    • Drips
  • Guides
    • FAQ
    • How to Swap
    • How to Create New Position
    • How to Add/Remove Liquidity
    • How to Create a New Pool
    • How to Place a Limit Order
  • Developer
    • Dev Overview
    • via SDK
      • Getting Started
      • Prerequisites
      • Features Available
        • Get pools
        • Get positions
        • Get ticks
        • Create pool
        • Add Liquidity
        • Remove Liquidity
        • Fee & Rewards
        • Swap
        • Types
    • via Contract
      • Get Started
      • Data structure
      • Features available
        • Create pool
        • Swap
        • Open position
        • Add liquidity
        • Remove liquidity
        • Collect fees
        • Collect rewards
    • via API
    • Contract ErrorCode
  • Security
    • Audits
  • Resource
    • Brand Asset
Powered by GitBook
On this page
  • 1. NPM install
  • 2. Setting Up Configuration
  1. Developer
  2. via SDK

Prerequisites

PreviousGetting StartedNextFeatures Available

Last updated 29 days ago

1. NPM install

$ pnpm i @hyperionxyz/sdk

2. Setting Up Configuration

You need create an Aptos Build account, and generate a API key for using Aptos public services. Click to learn more.

Hyperion Typescript SDK now includes a default initialization method that allows for quick generation of the Hyperion SDK configuration. You can utilize the src/config/initCetusSDK method to swiftly initialize the configuration. You have the option to select either 'mainnet' or 'testnet' for the network.

import { Network } from "@aptos-labs/ts-sdk";
import { initHyperionSDK } from '@hyperionxyz/sdk'

const sdk = initHyperionSDK({
    network: Network.MAINNET, 
    APTOS_API_KEY: "Your APTOS API key"
})

Now, you can start using Hyperion SDK!

https://build.aptoslabs.com/docs/introduction