adrestia

Documentation Status

Adrestia is a collection of products which makes it easier to integrate with Cardano. It comes in different flavours: SDK or high-level APIs. Depending on the use-cases you have and the control that you seek, you may use any of the components below.

Components

APIs

name / link

description

Byron

Jörmungandr

Shelley

cardano-wallet

JSON/REST API for managing UTxOs in HD wallets

DONE

DONE

IN PROGRESS

cardano-rest

JSON/HTTP API for browsing on-chain data

DONE

X

IN PROGRESS

cardano-graphql

GraphQL/HTTP API for browsing on-chain data

DONE

X

IN PROGRESS

SDK

Name / Link

Description

Haskell

JavaScript

bech32

Human-friendly Bech32 address encoding

DONE

bitcoinjs bech32

cardano-addresses

Addresses and mnemonic manipulation & derivations

DONE

IN PROGRESS

cardano-coin-selection

Coin selection and fee balancing algorithms

DONE

IN PROGRESS

cardano-launcher

Shelley cardano-node and cardano-wallet launcher for NodeJS applications

X

DONE

cardano-serialization-lib

Binary serialization of on-chain data types

IN PROGRESS

IN PROGRESS

cardano-transactions

Transaction construction and signing

DONE

IN PROGRESS

Formal Specifications

Name / Link

Description

utxo-wallet-specification

Formal specification for a UTxO wallet encoding

Internal

Warning

Here be dragons. These tools are used internally by other tools and does not benefit from the same care in documentation thanother tools above.

name / link

description

cardano-js

(experimental) Cardano primitives for ECMAScript applications

cardano-js-sdk

(experimental) Cardano SDK for ECMAScript applications

persistent

Fork of the persistent Haskell library maintained for cardano-wallet

Building the Documentation

This documentation may be built with Sphinx:

1
2
3
4
python -m pip install --upgrade --no-cache-dir pip
python -m pip install --upgrade --no-cache-dir Pygments==2.3.1 setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1
python -m pip install --exists-action=w --no-cache-dir -r doc/.sphinx/requirements.txt
sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html