This is a library wrapping the cardano-cli with TypeScript (can also be used in Javascript projects) which makes it possible to interact with the cardano CLI much faster and more efficient.
You need access to a Cardano Node socket. If you have a remote node you can create a ssh tunnel with the socket file as follows:
ssh -nNT -L /tmp/forwarded.socket:/path/to/remote/node.socket remote-machine-user@remote-machine-ip
npm install cardanocli-js
git clone https://github.com/miguelaeh/cardanocli-js.gitcd cardanocli-jsnpm install
const{ CardanoCliJs, CardanoCliJsOptions}=require("cardanocli-js");constshelleyGenesisPath="/home/ada/mainnet-shelley-genesis.json";// Update this path to the actual pathconstoptions=newCardanoCliJsOptions({shelleyGenesisPath:'/home/miguelaeh/projects/cardano-cli-agent/cardanocli-js/tests/assets/shelley-genesis.json'// network: 4, // Uncomment this line to use a testnet by adding the testnet magic});constcardanocliJs=newCardanocliJs(options);constcreateWallet=(account)=>{constpayment=cardanocliJs.address.keyGen(account);conststake=cardanocliJs.stake_address.keyGen(account);cardanocliJs.stake_address.build(account);constaddr=cardanocliJs.address.build(account,{paymentVkey:payment.vkey,stakeVkey:stake.vkey,});returnaddr;};constwalletAddr=createWallet("my-wallet-name");console.log("My wallet address:",walletAddr);Check/examples for more use cases. If you have doubts on how to use a specific command you can also check thetests folder, where all the commands are tested.
Install npm dev dependencies usingnpm install --also=dev.
Tests are using Jest framework and can be run by usingnpm run-script test command.
Tests are configured to run with the Sancho network. You may need to update yourcardano-cli binary to the sancho one in order to run the tests.
Starting on version4.0.0 the HTTP provider has been removed. There are better options for that as of today. For example, the blockfrost API.This means than to use this library you need a fully synced node. And it is, as its name states, a wrapper over the CLI to make your life easier when creating scripts.If you need to connect to your own remote cardano nodes you can forward the socket via an SSH tunnel:
ssh -nNT -L /tmp/forwarded.socket:/path/to/remote/node.socket remote-machine-user@remote-machine-ip
For better maintencane, the library has been moved to TypesScript and its internal structure changed.