Asteroid Protocol Docs
  • Asteroid Protocol Docs
    • Introduction
    • General overview
  • Creators/Artists
    • Getting started for creators/artists
    • Creating your first inscription
    • Creating a collection with the launchpad
    • Creating a token (CFT-20)
    • Join the Asteroid community
  • Collectors
    • Getting started for collectors
  • Developers
    • Getting started for devs
    • The Cosmos Inscriptions Specification
    • Cosmos Fungible Token (CFT-20) Standard
    • Deploy, mint, transfer, trade or bridge CFT-20 tokens
    • Asteroid Protocol API
    • Command line tool
    • Ideas to build on Asteroid Protocol
    • Multisig wallets
    • Enable support for your bridged tokens on Astroport.fi
    • NFT spec
    • Migrating an inscription into a collection
  • References
    • Logo and brand assets
    • Frequently Asked Questions (FAQs)
    • Asteroid timeline
    • Important links
    • Terminology
Powered by GitBook
On this page
  • Introduction
  • Metaprotocols
  • Asteroid Toolkit
  • Important links
  • Run Asteroid Protocol locally
  • The Asteroid Protocol API
  1. Developers

Getting started for devs

Learn how to Asteroid Protocol works, deploy your own Asteroid indexer, access public APIs and more.

PreviousGetting started for collectorsNextThe Cosmos Inscriptions Specification

Last updated 9 months ago

Introduction

  • With Asteroids, anyone can permanently publish content directly onto the Cosmos Hub blockchain where it will live on in perpetuity

  • Developed in collaboration between Delphi Labs and the Astroport Foundation, the framework brought inscriptions and fungible tokens to the world’s largest Cosmos blockchain by market cap — a chain that doesn’t natively support tokens or permissionless smart contracts by design

  • The open source framework includes an Asteroid indexer, explorer, API, Cosmos Fungible Token (CFT-20) specification, a token deployer and minting tool, and front-end/back-end software

  • Anyone can use their Leap or Keplr wallet to begin inscribing data, images and text and/or minting CFT-20 tokens — including the world’s — at

  • As a metaprotocol framework, Asteroids are substantially more powerful than alternative approaches, which have largely relied on Cosmos SDK’s “memo” field and do not support metaprotocol-like functionality or larger files up to ~550kb

  • All software and specifications are experimental, unaudited and not “endorsed” by any entity including Delphi Labs and the Astroport Foundation. Use at your own risk

Metaprotocols

The Asteroid Protocol is a generalized metaprotocol framework. That means anyone can use it to create their own Asteroid protocol. To date, contributors have already defined several Asteroid metaprotocols:

  1. The Cosmos Inscriptions Specification (or "arbitrary content inscriptions"): With arbitrary content inscriptions, users can publish virtually any sort of data that a browser can display… from JPGs to videos, text to JSON, HTML and even online games… directly on the Hub. File sizes can be as large as ~550kb.

  2. Cosmos Fungible Tokens (CFT-20): A way of deploying, minting and transferring fungible tokens on Cosmos Hub, which does not natively support fungible tokens by design.

  3. Asteroid NFTs: With the , users can create collections of arbitrary content inscriptions.

  4. Asteroid marketplace: A framework for swapping inscriptions on-chain. Asteroidprotocol.io utilizes this framework to enable swapping of inscriptions in the and tokens in the .

  5. Token bridge: A framework for where they're minted as TokenFactory coins (and therefore have full IBC compatibility).

The Asteroid framework is fully extensible as well, meaning anyone can define and launch their own metaprotocol on Cosmos Hub.

Asteroid Toolkit

  • Specifications for the Asteroid metaprotocol framework, arbitrary inscriptions and CFT-20 tokens

  • An open-source indexer

  • An open-source API

  • An open-source front-end and backend for deploying your own Asteroid explorer

Important links

Run Asteroid Protocol locally

The Asteroid Protocol API

An Asteroid explorer and minting tool is live at . The protocol’s release also included the following:

A minting tool and explorer live at

All these tools can be found in the , and we encourage you to begin building on top of Asteroids now.

: Create or swap your own NFTs or tokens that will live on Cosmos Hub for as long as the chain exists

: Check out a list of cool things we’d love to see built on Asteroid Protocol

: Need some cash and guidance to build out an idea on Asteroid Protocol? Consider applying for an Asteroid Grant!

: Comes with a command-line tool that surfaces all necessary metaprotocol operations

: Use GraphQL to query the Asteroid API directly. Or navigate to to explore everything the API has to offer. Check out this (or read the FAQs) to see some sample API queries.

: Download a demo app that shows you how to integrate @asteroid-protocol/sdk with Next.js and CosmosKit.

: Download the open-source indexer and review the specs that determine how Asteroid Protocol works

: A community-run site highlighting the art-based collections on Asteroid Protocol

: Learn about the history and original creators of Asteroid Protocol

: A Telegram group for builders on Asteroid Protocol

: A general Telegram group for those interested in Asteroid Protocol

: Stay on top of the latest news and highlights from Asteroid Protocol

Instructions to run Asteroid Protocol locally are maintained in Github: .

You can use GraphQL to query the public Asteroid API via the public endpoint at . You can also query the API directly in your browser using publicly-available GraphQL tool such as . Visit the page to learn how and see examples of common queries.

first CFT-20, ROIDS
asteroidprotocol.io
NFT metaprotocol
inscriptions marketplace
token marketplace
bridging CFT-20s from Cosmos Hub to Neutron
asteroidprotocol.io
asteroidprotocol.io
Asteroid Github repository
Asteroidprotocol.io
Ideas for builders
Grant application
Asteroid Protocol TypeScript SDK
API Endpoint
https://www.graphqlbin.com/
video
Custom Frontend integration example
Github
Asteroidhub.xyz
Launch Article
Asteroid Devs Telegram group
Asteroid Telegram group
Asteroid X/Twitter
https://github.com/astroport-fi/asteroid-local
https://new-api.asteroidprotocol.io/v1/graphql
Apollo Graph
Asteroid Protocol API