Lucid SDK

Lucid SDK is a powerful JavaScript/TypeScript library for interacting with the Cardano blockchain. It enables developers to build decentralized applications (dApps) and manage transactions easily.

Getting Started

Prerequisites

• Node.js (v14.0.0 or higher)
• npm (Node Package Manager)

Installation

To install Lucid SDK, use npm or yarn:

npm install @lucid-evolution/lucid

or

yarn add @lucid-evolution/lucid

Quick Start

Example of initializing Lucid SDK and creating a simple transaction:

import { Lucid, Koios, generateSeedPhrase } from "@lucid-evolution/lucid";

const lucid = await Lucid(
  new Koios("https://preprod.koios.rest/api/v1"),
  "Preprod"
);
const seedPhrase = generateSeedPhrase();
lucid.selectWallet.fromSeed(seedPhrase);

const tx = await lucid
  .newTx()
  .payToAddress("addr_testa...", { lovelace: 5000000n })
  .payToAddress("addr_testb...", { lovelace: 5000000n })
  .complete();

const signedTx = await tx.signWithWallet().complete();
const txHash = await signedTx.submit();

console.log("Transaction sent:", txHash);

Build and Publish to npm

To publish your own version of the SDK to npm:

1. Build the SDK:

npm run build

2. Bump Version and Create Release

npm run release

3. Push Changes and Merge into main:

- After running npm run release, push your changes and merge them into the main branch. This will automatically trigger the publishing process.

4. Automatic Publish to npm:

- After merging into main, the pipeline will be triggered to build the SDK and automatically publish the new version to npm.

📦 Make sure the name field in your package.json is unique or scoped (e.g. "@your-scope/lucid-sdk").

License

Lucid SDK is licensed under the Apache-2.0 License.

Project Status

This project is actively maintained and developed. Contributions are welcome!