Astral
  • Welcome
  • Astral Litepaper
  • GeoNFT
    • Ecological State
  • Spatial Data Registry
    • On-chain Spatial Data Registry
    • Celo/EVM Anchored Spatial Data Registry
      • Technical Design
        • Ingestion
        • Anchoring
        • Validation
        • List on Ocean Marketplace
      • Summary
    • CosmWasm Anchored Spatial Data Registry
  • Progress
  • ARCHIVE
    • Introduction
    • Spatial Data Primer
    • Background
      • Motivation
      • Value
      • The Stack
        • Data
        • Oracles
        • Spatial Contracts
    • A Web3-Native Geospatial Vision
      • A rationale for GeoDIDs
      • GeoTIFFs and IPLD
        • Encoding the GeoTIFF
        • Decoding the GeoTIFF
    • Spatial.sol
      • Design Considerations
    • Verifiable Spatial Data Registries
    • GeoDIDs
      • DID Primer
      • GeoDID Core
        • GeoDID Core Specification
        • GeoDID Collection Example
        • GeoDID Item Example
      • GeoDID Extensions
        • GeoJSON
        • GeoTIFF
          • IPLD-encoded GeoTIFF
          • Cloud-optimized GeoTIFF
        • STAC
          • STAC Items
          • STAC Catalogs
      • Build with GeoDIDs
        • Getting Started
        • @astralprotocol/core
          • API
          • Types
        • @astralprotocol/contracts
          • API
        • @astralprotocol/subgraph
      • GeoDIDs v0.2
    • Spatial Oracles
    • Universal Location Proofs
Powered by GitBook
On this page
  • Description
  • To add Astral Protocol Contracts to your application
  • To develop or try the Astral Protocol Contracts locally
  • To deploy your own contracts in the Ropsten testnet

Was this helpful?

Export as PDF
  1. ARCHIVE
  2. GeoDIDs
  3. Build with GeoDIDs

@astralprotocol/contracts

Documentation about the Astral Protocol Contracts Package.

PreviousTypesNextAPI

Last updated 3 years ago

Was this helpful?

Description

These contracts serve as the Registry for the Astral Protocol GeoDIDs. It allows binding of a GeoDID to an ethereum address and CID name resolving.

By registering a spatial asset Smart Contract events are triggered, which are picked up by the subgraph indexer to build the tree of relationships for easy querying.

To add Astral Protocol Contracts to your application

yarn add @astralprotocol/contracts

To develop or try the Astral Protocol Contracts locally

  • Clone the astralprotocol repository and go to packages/contracts:

git clone git@github.com:AstralProtocol/astralprotocol.git
cd astralprotocol/packages/contracts

  • Run ganache yarn ganache

  • In a new terminal, deploy contracts with yarn truffle

  • Run tests with yarn truffle-test

  • You can deploy an instance by running yarn new-instance. It builds a GeoDID tree with hardcoded GeoDID ids and CIDs.

  • You can test the removal of some links by running yarn remove-links.

  • Watch the changes in a locally deployed subgraph.

  • Do coverage check up by killing the ganache process in the first terminal and running yarn coverage

To deploy your own contracts in the Ropsten testnet

  • Create a .env file in /packages/contracts with a MNEMONIC and ROPSTEN_API_KEY

.env
MNEMONIC="mnemonic phrase goes here with testnet ether in address[0] on ropsten cool"
ROPSTEN_API_KEY=https://ropsten.infura.io/v3/<PROJECT ID HERE>
Build Status
Coverage Status