Skip to content

Commit

Permalink
Refresh content structure - lucid evolution
Browse files Browse the repository at this point in the history
  • Loading branch information
0xBora committed Mar 7, 2025
1 parent e18007e commit 1e869ab
Show file tree
Hide file tree
Showing 5 changed files with 386 additions and 207 deletions.
206 changes: 0 additions & 206 deletions docs/get-started/lucid-evolution.md

This file was deleted.

164 changes: 164 additions & 0 deletions docs/get-started/lucid-evolution/get-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
---
id: get-started
sidebar_position: 1
title: Get Started with Lucid Evolution
sidebar_label: Instantiate Evolution
description: Quick start guide for Lucid Evolution
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Get Started with Lucid Evolution

Lucid Evolution is a highly scalable, production-ready transaction builder & off-chain framework for users and DApps. It provides a TypeScript library for building transactions and designing off-chain code.

In this guide, we will walk you through just 3 easy steps to install the `lucid-evolution` package, instantiate the Lucid Evolution library, create/choose a wallet, and build and submit a transaction. The library is capable of much more and is one of the popular tools for building off-chain code for Cardano dApps.

> For more examples and use cases, please refer to the official Lucid Evolution [documentation](https://anastasia-labs.github.io/lucid-evolution/documentation/deep-dives/make-payments).
> Come say hi on [Discord](https://discord.gg/G9GbN2CVTR) if you have any questions!
## Installation

<Tabs
defaultValue="pnpm"
values={[
{label: 'pnpm', value: 'pnpm'},
{label: 'npm', value: 'npm'},
{label: 'yarn', value: 'yarn'},
{label: 'bun', value: 'bun'},
]}>
<TabItem value="pnpm">

```bash
pnpm i @lucid-evolution/lucid
```

</TabItem>
<TabItem value="npm">

```bash
npm i @lucid-evolution/lucid
```

</TabItem>
<TabItem value="yarn">

```bash
yarn add @lucid-evolution/lucid
```

</TabItem>
<TabItem value="bun">

```bash
bun i @lucid-evolution/lucid
```

</TabItem>
</Tabs>

:::note

Installing the `lucid` package will automatically export all other Lucid Evolution packages as well. For more information on more granular package definitions for lightweight development, please refer to the the Evolution library [installation guide](https://anastasia-labs.github.io/lucid-evolution/install).

:::

## Instantiate Lucid Evolution

Lucid Evolution can be used with or without a blockchain provider, which allows you to query data and submit transactions. Evolution library supports the `Mainnet`, `Preprod`, `Preview` and `Custom` networks.

### Provider Selection

<Tabs
defaultValue="blockfrost"
values={[
{label: 'Blockfrost', value: 'blockfrost'},
{label: 'Kupmios', value: 'kupmios'},
{label: 'Maestro', value: 'maestro'},
{label: 'Koios', value: 'koios'},
]}>
<TabItem value="blockfrost">

```typescript
import { Lucid, Blockfrost } from "@lucid-evolution/lucid";

const lucid = await Lucid(
new Blockfrost("https://cardano-preprod.blockfrost.io/api/v0", "<projectId>"),
"Preprod"
);
```

</TabItem>
<TabItem value="kupmios">

```typescript
import { Lucid, Kupmios } from "@lucid-evolution/lucid";

const lucid = await Lucid(
new Kupmios(
"http://localhost:1442", // Kupo endpoint
"http://localhost:1337" // Ogmios endpoint
),
"Preview"
);
```

**or with API Keys**

```typescript
const lucid = await Lucid(
new Kupmios("http://localhost:1442", "http://localhost:1337", {
kupoHeader: { "priv-api-key": "<kupo-api-key>" }, // for example: "dmtr-api-key": "<kupo-api-key>"
ogmiosHeader: { "priv-api-key": "<ogmios-api-key>" },
}),
"Preview"
);
```

:::note

Kupmios is a mix of [Ogmios](https://ogmios.dev/) and [Kupo](https://cardanosolutions.github.io/kupo/).

:::

</TabItem>
<TabItem value="maestro">

```typescript
import { Lucid, Maestro } from "@lucid-evolution/lucid";

const lucid = await Lucid(
new Maestro({
network: "Preprod", // For MAINNET: "Mainnet" (1)
apiKey: "<Your-API-Key>", // Get yours by visiting https://docs.gomaestro.org/docs/Getting-started/Sign-up-login
turboSubmit: false, // Read about paid turbo transaction submission feature at https://docs.gomaestro.org/docs/Dapp%20Platform/Turbo%20Transaction
}),
"Preprod" // For MAINNET: "Mainnet" (2)
);
```

</TabItem>
<TabItem value="koios">

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

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

**or with a bearer token**

```typescript
const lucid = await Lucid(
new Koios("<koios-api-url>", "<koios-bearer-token>"),
"Preprod"
);
```

</TabItem>
</Tabs>
Loading

0 comments on commit 1e869ab

Please sign in to comment.