exodus-hydra

Warning

This repository has a public mirror at ExodusOSS/hydra. Please act accordingly.

Hydra, a many-headed serpent in Greek mythology

This is the monorepo that is home to the many components of the Exodus SDK.

Getting started

Please sort yourself into one of the six houses:

• Play with the SDK immediately: visit the playground at https://exodus-hydra.pages.dev/. For now it's restricted to those with Exodus email but we hope to open this up soon.
• Use the SDK to build an app
• Learn how "features" work and plug into the SDK
• Troubleshoot the SDK
• Learn how to navigate this repo

Learn how to navigate this repo

In this repo you'll find legos of different sizes, from the low level, e.g. cryptographic libraries, to the high level, e.g. features that plug into the Exodus SDK, and everything in between. Please read the lego manual before having any fun.

Now that you're back, here's a quick overview of repo structure:

• ./adapters: platform adapters for web, mobile, desktop, etc. This is where all platform-specific code is contained and everything else should be platform agnostic. Don't let the platforms leak out!
• ./features: feature legos - domain-specific groupings of atom(s), module(s) and plugin(s) that plug into the SDK with sdk.use(feature(config))
• ./modules: module legos - module legos that aren't quite big enough to put on feature pants - legacy and need to be wrapped into features.
• ./libraries: library legos - stateless utils like lodash, eslint plugins, currency manipulation utils, REST clients, etc.
• ./sdks: SDKs combine all of the above into a single object that encapsulates the application lifecycle and exports namespaced APIs of all component features. You'll typically see it used in the UI under the name exodus, e.g. exodus.wallet.create() or exodus.addressProvider.getDefaultAddress({ walletAccount, assetName }). At the moment we have two SDK flavors. Most of the time you'll use ./sdks/headless, but if you need something super lightweight with no features built-in, use ./sdks/argo.
• ./tools: local eslint plugins, nx generators, vscode snippets, etc.

Contributing

Done with the required reading? See how to contribute.