Skip to content

Latest commit

 

History

History
203 lines (159 loc) · 8.03 KB

README.md

File metadata and controls

203 lines (159 loc) · 8.03 KB

Lucid Evolution

Next-generation transaction builder for users and an off-chain framework for highly scalable dApps 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.

Projects powered by lucid-evolution

Cardano Foundation - IBC
CF - IBC
Liqwid Finance
Liqwid Finance
Splash
Splash
Meld
Meld
Maestro
Maestro
Mynth
Mynth
Pondora
Pondora
Atrium
Atrium
Genius Yield
Genius Yield
VESPR Wallet
VESPR Wallet
Ada Markets
Ada Markets
Strike Finance
Strike Finance
Summon
Summon

Introduction

Lucid Evolution is a comprehensive suite of tools designed to facilitate the off-chain development of scalable dApps and the creation of complex transactions on the Cardano blockchain

Packages

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

Tech Stack

  • TypeScript: For static type checking
  • Effect: Manages side effects, facilitating the creation of effectful functions that track errors, handle synchronous and asynchronous operations, and provide error short-circuiting capabilities
  • ESLint: For code linting
  • Prettier: For code formatting

Getting Started

Installation

git clone https://github.com/Anastasia-Labs/lucid-evolution.git
cd lucid-evolution
pnpm install

Build

To build all packages:

pnpm build

Development

To run the documentation site locally:

pnpm dev

Visit http://localhost:3000/lucid-evolution to view the docs

Testing

Run tests across all packages:

pnpm test

Code Quality

To format files with prettier, run the following command:

pnpm format

To check formatting, run the following command:

pnpm format-check

To check linting, run the following command:

pnpm lint

Documentation

For comprehensive documentation, please visit our official documentation site

Remote Caching

Lucid Evolution leverages the remote caching functionality provided by GitHub to optimize continuous integration (CI) pipelines.

By default, local caching is employed. Although there are no immediate plans for remote caching, the repository remains adaptable to future enhancements

Contributing

We welcome contributions to Lucid Evolution! Please feel free to submit issues, create pull requests, or engage in discussions to help improve the project

License

Lucid Evolution is open-source software licensed under the MIT License

Community

Join our Discord community for discussions, support, and updates


Developed with ❤️ by Anastasia Labs