Skip to content

hadelive/lucid-evolution

 
 

Repository files navigation

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 evolution-sdk! If you've built a library or a project on top of evolution-sdk, tell me about it on X or on Discord . I'll add it below and tweet it out.

Powered by Evolution SDK

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 @evolution-sdk/lucid
💡 Installing the lucid package automatically includes all other packages in the library.

🚀 Quick Start

import { Lucid, Koios, generateSeedPhrase } from "@evolution-sdk/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 Evolution SDK! Please check our CONTRIBUTING.md guide for more information.

Getting Started

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

🧪 Testing

# Run tests across all packages
pnpm test

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

Evolution SDK 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/evolution-sdk.


📜 License

Evolution SDK is licensed under the MIT License.


Maintained with ❤️ by No Witness Labs

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.3%
  • Other 0.7%