Package Exports

@xchainjs/xchain-cardano
@xchainjs/xchain-cardano/lib/index.esm.js
@xchainjs/xchain-cardano/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@xchainjs/xchain-cardano) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Cardano client

Installation

yarn add @xchainjs/xchain-cardano

npm install @xchainjs/xchain-cardano

Initialization

Using the Cardano client you can initialize the main class of the module in consultation mode if you do not provide any parameters, this means you could retrieve information from the blockchain and prepare transactions to sign, but you will not be able to sign transactions, or generate addresses.

import { Client } from '@xchainjs/xchain-cardano'

const client = new Client()

// Make read operations with your client

Otherwise, if you want to sign transactions and get the addresses you own, you will need to initialize the main class of the protocol as follows

import { Client, defaultCardanoParams } from '@xchainjs/xchain-cardano'

const client = new Client({
  phrase: 'your secret phrase',
  ...defaultCardanoParams
})

// Make read or write operations with your client

Features

Thanks to the Cardano client you will be able to:

Get the Cardano and tokens balances that an address owns
Generate addresses given a secret phrase
Transfer Cardano and tokens to another address
Get details of a transaction
Get address transaction history

Examples

You can find examples using the Cardano package in the Cardano examples folder.

Documentation

More information about how to use the Cardano client can be found on documentation