Skip to content

Latest commit

 

History

History
326 lines (276 loc) · 11.9 KB

README.md

File metadata and controls

326 lines (276 loc) · 11.9 KB

Lucid Evolution

A highly scalable, production-ready transaction builder and off-chain framework for dApps and devs on Cardano.

Build Status NPM Downloads Discord NPM Version

There are a growing number of projects that are built on top of lucid-evolution! If you've built a library or a project on top of lucid-evolution, tell me about it on X or on Discord . I'll add it below and tweet it out.

Powered by Lucid Evolution

Cardano Foundation - IBC
Cardano Foundation
- IBC 		EMURGO Academy
EMURGO
Academy 		Midgard Protocol
Midgard Protocol 		Liqwid Finance
Liqwid Finance 		Indigo Protocol
Indigo Protocol 		Splash
Splash
Meld
Meld 		Maestro
Maestro 		Mynth
Mynth 		Pondora
Pondora 		WingRiders
WingRiders 		Atrium
Atrium
Genius Yield
Genius Yield 		VESPR Wallet
VESPR Wallet 		Fetch
Fetch 		Strike Finance
Strike Finance 		Summon
Summon 		GenWealth
GenWealth
BetttingADA
BetttingADA 		Summon
Cardexscan

📦 Install

pnpm i @lucid-evolution/lucid
💡 Installing the lucid package automatically includes all other packages in the library.

🚀 Quick Start

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

// Initialize Lucid with a provider
const lucid = await Lucid(
  new Koios("https://preprod.koios.rest/api/v1"),
  "Preprod",
);

const seedPhrase = generateSeedPhrase(); // BIP-39
lucid.selectWallet.fromSeed(seedPhrase); // Select a wallet for signing

// Build, sign and submit transaction
const tx = await lucid
  .newTx()
  .pay.ToAddress("addr_testa...", { lovelace: 5000000n }) // Pay 5 ADA to addr_testa...
  .pay.ToAddress("addr_testb...", { lovelace: 5000000n }) // Pay 5 ADA to addr_testb...
  .complete(); // Balance the transaction and initiate UTxO selection

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

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

📚 Documentation

For comprehensive documentation including API references, examples, and guides, visit our official documentation site.

👥 Community and Support

🤝 Contributing

We welcome contributions to Lucid Evolution! Please check our CONTRIBUTING.md guide for more information.

⚒️ Getting Started

git clone https://github.com/Anastasia-Labs/lucid-evolution.git
cd lucid-evolution
pnpm install
Build all packages
pnpm build
📦 View Package Overview
Package Description
@lucid-evolution/lucid Core package for Lucid Evolution
@lucid-evolution/bip39 BIP-39 mnemonic code implementation
@lucid-evolution/core-types Shared type definitions
@lucid-evolution/core-utils Common utility functions
@lucid-evolution/crc8 CRC8 calculation utilities
@lucid-evolution/plutus Plutus integration tools
@lucid-evolution/provider Data provider interfaces
@lucid-evolution/sign_data Data signing utilities
@lucid-evolution/utils General-purpose utility functions
@lucid-evolution/wallet Wallet integration package
@lucid-evolution/typescript-config Shared TypeScript configurations
@lucid-evolution/eslint-config Shared ESLint configurations

🧪 Testing

# Run tests across all packages
pnpm test

# Run tests for a specific package
pnpm --filter @lucid-evolution/lucid test
🧪 Testing Details

Lucid Evolution includes both unit tests and on-chain integration tests.

For detailed testing instructions, including environment setup and API keys, please refer to our CONTRIBUTING guide.

📖 Local Documentation

pnpm dev

Visit http://localhost:3000/lucid-evolution

📜 License

Lucid Evolution is licensed under the MIT License.

Maintained with ❤️ by Anastasia Labs