yoroi-eUTxO-txs

This is a library for providing a friendly API for building the most common transaction types in the context of a Cardano (eUTxO) Wallet.

Please notice we don't have an NPM package yet as well :)

Getting started

This lib is dependent on cross-csl. See the instalation instructions depending on your runtime. For the remaning of this document we will use examples assuming a NodeJS runtime.

After installing cross-csl, set the runtime:

import { init } from '@emurgo/cross-csl-nodejs';
import { setRuntime } from '@emurgo/yoroi-eUTxO-txs';

setRuntime(init);

this is just needed at the startup of your application. After that, you can get an instance of SpendOnlyWallet:

import { SpendOnlyWallet } from '@emurgo/yoroi-eUTxO-txs';

const wallet = await SpendOnlyWallet.new(
  [
    {
      address: 'addr1q8yr9x2jp24h3lhcp290jyz0cupsdr3z0mgr6wjq4gfyx4zkj6g2hck2e75datgvnvr7eahspjyf6mvqnut26dcgxusqppc2nl',
      tx: 'ba36122323592ade04cc5e9f908a606a97ab80250e901633c700b7b59c70162e',
      index: 0,
      value: {
        amount: 100_000_000, // 100 ADA
        assets: {
          '648823ffdad1610b4162f4dbc87bd47f6f9cf45d772ddef661eff198': { // policy ID hex
            '77444f4745': 1 // asset name hex and amount to send
          }
        }
      }
    }
  ],
  [
    {
      address: 'addr1qy9705sg44vfuz0aehckl4ja02yv838knexfq8sdcnvklu0xcvwck966mufzw0tq2h44dhpxf6uf5ee3652g5y75tzjqa7u5we',
      spendingKeyInfo: {
        start: 4,
        path: [0, 10]
      },
      stakingKeyInfo: {
        start: 4,
        path: [2, 0]
      },
    }
  ]
);

please notice the above is only dummy data, you should really get this info from the blockchain based on the context of the wallet!

With the SpendOnlyWallet you can create and sign transactions. A good way to see how to instantiate and create transactions using real data is to check the unit tests that submit TXs to a real node at spec/index.spec.ts and spec/ledger.spec.ts (for signing with a Ledger device).