@cardanotech/api

an unofficiall wallet API for the cardano node

Availabililty and Links

• npmjs.org (npm package)
• gitlab.com (source)
• github.com (source mirror)
• docs (typedoc)

Status for master

Status Category | Status Badge -- | -- GitLab Pipelines | GitLab Pipline Test Coverage | npm | Snyk | TypeScript Support | node Support | Code Style | PackagePhobia (total standalone install weight) | PackagePhobia (package size on registry) | BundlePhobia (total size when bundled) | Platform support |

Usage

Use TypeScript for best in class intellisense

Prerequisites

• docker needs to be installed on the system
• docker-compose needs to be installed on the system
• the user running the package must be able to talk to docker daemon.

import * as cardano from '@cardanotech/api';

const run = async () => {
  await cardano.CardanoApi.startCardanoNodeAndWalletWithDockerCompose(); // starts up cardano node and wallet on the system using docker-compose.
  const cardanoApiInstance = await cardano.CardanoApi.createForDockerCompose(); // static function that creates an instance of CardanoApi
  await cardanoApiInstance.blockchainSyncedPromise; // a promise that resolves once the running cardano-node has synced with the blockchain
  const cardanoWallet = await cardanoApiInstance.restoreWalletFromSeed(['my', 'awesome', 'seed']); // creates a wallet from seed. Alternatively takes a space separated string.
  const expectedPayment = await cardanoWallet.createExpectedPayment(
    100.546,
    'some optional address to forward to upon completion'
  ); // creates an expectedPayment of 100.546, takes a address to forward payments to upon completion

  console.log(expectedPayment.amount); // the amount of the expected payment
  console.log(expectedPayment.targetAddress); // the target address at which the payment should arrive
  console.log(expectedPayment.completedPaymentForwardAddress); // the address that the complete amount will be forwarded to once the expected payment completes successfully
  console.log(expectedPayment.status); // the current status of the payment
  console.log(expectedPayment.eventLog); // an array of events attributed to the expected payment

  const receipt = await expectedPayment.paymentReceivedPromise; // a promise that resolves with a receipt once payment is received.

  // trigger some action here, e.g. delivery of an ebook by email or posting items for shipment in the physical world.
};

run();

Commercial support

Lossless GmbH provides commercial support and consulting for this package. Please inquire about it by writing us at [email protected]

Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy