Skip to main content

Hyperverse Monorepo

Overview and structure of the Hyperverse Monorepo.


Monorepo Architecture

The Hyperverse Monorepo contains code packages and applications for the Hyperverse.

  • packages: Blockchain implementations, smart modules and starterkits.
  • apps: Example applications organized by blockchain.
info

View the Hyperverse Monorepo on GitHub to get started with the Hyperverse!

Packages

Blockchain implementations, smart modules, starterkits and utilities.

  • Hyperverse Core
  • Blockchain Integrations
  • Smart Modules
  • Starterkits
  • Utilities

Hyperverse Core

Package defining core Hyperverse functionality.

  • hyperverse: Defines core Hyperverse functionality.

Blockchain Integrations

Packages defining Hyperverse blockchain integrations.

Smart Modules

Packages defining blockchain specific use cases prepared for JavaScript developers.

  • Algorand
  • Ethereum
  • EVM
  • Flow
  • Metis
info

View explore modules a current list of descriptions and resources for each smart module.

Starterkits

Templates use to facilitate rapid development of Hyperverse smart modules.

Utilities

Additional tools and libraries used within Hyperverse packages.

  • web3modal: A single Web3 / Ethereum provider solution for all Wallets.
  • unstated-next: Library built for React that allows the sharing of state globally in our applications.
  • config: Contains all Hyperverse configuration files

Hyperverse Core

Package defining core Hyperverse functionality.

Source

  • useHyperverse.tsx: Specifies useHyperverse container as implemented by blockchain packages.
  • Provider.tsx: Defines Hyperverse provider configurations.
  • initialize.ts: Returns Hyperverse initialization options.
  • types.ts: Sets integration blockchain features, configuration, and instance definitions.

Components

Constants

  • blockchain.ts: Specifies list of Hyperverse compatible blockchains.
  • networks.ts: Specifies network naming conventions and configuration.
  • storage.ts: Specifies Hyperverse storage provider options.

Access: useHyperverse

Blockchain Integrations

Active Hyperverse integrations available for Smart Module development.

Algorand

Defines hyperverse-algorand specific Hyperverse implementation.

  • …status?

Ethereum

Defines hyperverse-ethereum specific Hyperverse implementation.

  • Provider.tsx: Defines Ethereum provider options connecting Mainnet & Testnet to Infura.
  • index.ts: Specifies blockchain ad provider definitions for Ethereum blockchain.
  • useEthereum.ts: Defines Ethereum container for implementation within Hyperverse Smart Modules.

Access: useEthereum

EVM

Defines hyperverse-evm specific Hyperverse implementation.

  • useEVM.ts: Defines provider options, modal, state, network, and connnections for EVM chains.
  • index.ts: Specifies blockchain provider definitions for EVM chains.

Access: useEVM

Flow

Defines hyperverse-flow specific Hyperverse implementation.

  • index.ts: Specifies blockchain provider definitions for Flow blockchain.
  • types.ts:
  • useFlow.ts: Defines Flow container for implementation within Hyperverse Smart Modules.

Access: useFlow

Metis

Defines hyperverse-metis specific Hyperverse implementation.

  • Provider.tsx: Defines Metis networks connecting Mainnet & Testnet to EVM provider.
  • index.ts: Specifies blockchain provider definitions for Metis.
  • useMetis.ts: Defines Metis container for implementation within Hyperverse Smart Modules.

Access: useMetis

Polygon

Defines hyperverse-polygon specific Hyperverse implementation.

  • Provider.tsx: Defines Polygon networks connecting Mainnet & Testnet to EVM provider.
  • Index.ts: Specifies blockchain provider definitions for Polygon.
  • usePolygon: Defines Polygon container for implementation within Hyperverse Smart Modules.

Access: usePolygon

Skynet

Defines hyperverse-skynet specific Hyperverse implementation.

  • useStorage.ts: Defines Storage container for implementation within Hyperverse Smart Modules.

Access: useStorage