Skip to content

Commit b79204a

Browse files
satran004satran004
authored
Update docs for 0.9.1-beta and installation script fix (#61)
* chore: Fix installation script for 0.9.1-beta release, update docs for Yaci CLI distribution
1 parent 41c0259 commit b79204a

File tree

7 files changed

+579
-490
lines changed

7 files changed

+579
-490
lines changed

‎docs/pages/_meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"index": "Introduction",
3+
"yaci_cli_distribution": "Yaci CLI (Non Docker Dist)",
34
"how_to_use": "How to use",
45
"about": {
56
"title": "About",

‎docs/pages/about.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
# About
22

3-
//TODO
3+
The Yaci DevKit offers a customizable Cardano devnet that quickly launches and resets via the Yaci CLI, enabling faster
4+
iterations for developers. It features Yaci Store, a lightweight indexer using H2, and Yaci Viewer, a browser-based interface for viewing transactions.
5+
It supports flexible configurations, integrates with Ogmios and Kupo, and is compatible with Blockfrost API endpoints, all easily deployable
6+
with Docker Compose for efficient setup.

‎docs/pages/index.mdx

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,54 @@
1+
import { Callout } from 'nextra/components'
2+
13
# Introduction
24

35
The Yaci DevKit offers a customizable Cardano devnet that quickly launches and resets via the Yaci CLI, enabling faster
46
iterations for developers. It features Yaci Store, a lightweight indexer using H2, and Yaci Viewer, a browser-based interface
57
for viewing transactions. It supports flexible configurations, integrates with Ogmios and Kupo, and is compatible
68
with Blockfrost API endpoints, all easily deployable with Docker Compose for efficient setup.
79

10+
## Distribution Types
11+
12+
1. **Yaci DevKit:** A Docker Compose-based distribution that includes all required components. This is the **recommended**
13+
distribution for most users. Follow the installation instructions in the next section to install Yaci DevKit.
14+
15+
2. **Yaci CLI (Non-Docker):** A ZIP distribution that includes only Yaci CLI. This distribution is useful for users who
16+
prefer to use Yaci CLI without Docker. With this distribution, you can download and manage required components like Cardano Node,
17+
Ogmios, Kupo, and Yaci Store using Yaci CLI. For installation instructions, refer to the [Yaci CLI Installation](/yaci_cli_distribution) section.
18+
19+
This version improves readability and consistency in terminology.
20+
21+
## Yaci DevKit Installation
22+
23+
## Pre-requisites:
24+
- Docker
25+
826
## Installation
927

1028
To install latest stable version of Yaci DevKit, run:
1129

1230
```bash
13-
curl -s "https://devkit.yaci.xyz/install.sh" | bash
31+
curl --proto '=https' --tlsv1.2 -LsSf https://devkit.yaci.xyz/install.sh | sh
1432
```
1533

1634
To install a specific version of Yaci DevKit, run:
1735

1836
```bash
19-
curl -s "https://devkit.yaci.xyz/install.sh" | bash -s -- <version>
37+
curl --proto '=https' --tlsv1.2 -LsSf https://devkit.yaci.xyz/install.sh | sh -s -- <version>
2038
```
2139

2240
**Note:** Replace `<version>` with the desired version number without the `v` prefix.
2341

2442
## Zip Installation
2543

2644
Download the latest zip from [release section](https://github.com/bloxbean/yaci-devkit/releases) and unzip it.
45+
<br/>
46+
47+
<Callout type={"error"}>
48+
**Important:**
2749

50+
In Yaci DevKit **v0.9.1-beta** and later, the Yaci CLI's native executable is the default. If you encounter issues starting DevKit,
51+
you can switch back to the Java version by setting the **`yaci_cli_mode`** environment variable to **`java`** in the `config/env` file within
52+
the Yaci DevKit installation directory."
53+
</Callout>
2854

‎docs/pages/tutorials/meshjs/overview.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
import { Callout } from 'nextra/components'
2+
13
# Building transactions with Mesh SDK and submit to Yaci Devnet's Cardano Node
24

5+
<Callout type={'info'}>
6+
More documentation on the Mesh SDK's Yaci DevKit Integration can be found [here](https://meshjs.dev/yaci).
7+
</Callout>
8+
39
This example demonstrates how to build a transaction with the Mesh SDK and submit it to the Yaci Devnet's Cardano Node. The [Mesh SDK](https://meshjs.dev/) is a JavaScript library that provides a set of tools to interact with the Cardano blockchain.
410

511
### Yaci Provider to query and submit with Yaci instance

‎docs/pages/yaci_cli_distribution.mdx

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
import { Callout } from 'nextra/components'
2+
3+
## Introduction
4+
5+
For users who prefer not to use Docker, there's a ZIP distribution that contains only Yaci CLI. This allows you to download
6+
and manage necessary components like Cardano Node, Ogmios, Kupo, and Yaci Store directly through the command line.
7+
8+
Please note that **Yaci Viewer** is not currently supported out-of-the-box in this distribution.
9+
10+
### Who is this for?
11+
12+
- **Developers and system administrators:** Quickly set up a new custom node or multi-node networks
13+
- **Users wanting more control:** Easily manage compatible component versions and configurations
14+
15+
### Key advantages of the Yaci CLI distribution:
16+
17+
- **Reduced Disk Space:** Requires less disk space than the Docker image, containing only the Yaci CLI binary, configuration files, and any downloaded components.
18+
- **Version Flexibility:** Specify compatible versions of Cardano Node and other components directly in the download configuration file if the default versions don't meet your requirements.
19+
- **Customizable Setup:** Developers can selectively enable components like Yaci Store, Ogmios, and Kupo to achieve the same functionality as the Yaci DevKit Docker image.
20+
21+
22+
## Supported Platforms
23+
24+
Yaci CLI is currently supported on the following platforms:
25+
26+
1. **Linux x86:** Tested on Ubuntu 20.04, Ubuntu 22.04
27+
2. **MacOS 14 (Arm64) or later**
28+
29+
## Installation
30+
31+
- Download the latest version of the Yaci CLI Zip file from the [releases page](https://github.com/bloxbean/yaci-devkit/releases).
32+
- Unzip the downloaded file.
33+
- You will find the `yaci-cli` binary in the unzipped folder, and the configuration files in the `config` folder.
34+
35+
## Run Yaci CLI
36+
37+
You can now run the `yaci-cli` binary. However, this distribution doesn't include any of the necessary components for creating a devnet.
38+
You'll need to download these using Yaci CLI before proceeding.
39+
40+
41+
## Download Components
42+
43+
The simplest way to download the necessary components is to use the `download` command. This will automatically download all
44+
the required components for your specific platform, including Cardano Node, Ogmios, Kupo, Yaci Store, and JRE.
45+
46+
```shell
47+
yaci-cli:> download
48+
```
49+
50+
All components will be downloaded to the `$user_home/.yaci-cli` folder by default.
51+
52+
If you need to replace any existing components, simply use the `--overwrite` option.
53+
54+
55+
```shell
56+
yaci-cli:> download --overwrite
57+
```
58+
59+
Alternatively, you can download the components individually using the `download -c <component>` command, replacing `<component>` with the specific component you want to download.
60+
61+
```shell
62+
yaci-cli:> download -c node
63+
yaci-cli:> download -c ogmios
64+
yaci-cli:> download -c kupo
65+
yaci-cli:> download -c yaci-store
66+
```
67+
68+
<Callout type="warning">
69+
**Note:** You can change the default `yaci-cli` home folder by setting the `yaci.cli.home` property in the `application.properties` configuration file.
70+
</Callout>
71+
72+
## Create a new Devnet
73+
74+
Once you have downloaded the required components, you're ready to create a new devnet. You can use the `create-node` command to do this.
75+
76+
```shell
77+
yaci-cli:> create-node -o --start
78+
```
79+
80+
This command will create a new devnet with a single node and start it. By default, Yaci Store, Ogmios, and Kupo are disabled.
81+
You can enable them by setting their respective `enabled` properties to `true` in the `config/application.properties` file.
82+
83+
Alternatively, you can use the `enable-kupomios`, `enable-yacistore`, or `enable-kupo` commands before creating/starting the devnet.
84+
85+
For more information on the available commands and their usage, refer to the Yaci CLI commands documentation [here](/commands).
86+
87+
## Configuration
88+
89+
You'll find three configuration files within the `config` folder:
90+
91+
### **application.properties :**
92+
93+
This is the main configuration file to manage the functionality of Yaci CLI.
94+
95+
#### 1. Enable/Disable Optional Components
96+
97+
By default, all optional components are disabled. To enable any of them, simply set their respective `enabled` property to `true`.
98+
99+
```properties
100+
ogmios.enabled=true
101+
kupo.enabled=true
102+
yaci.store.enabled=true
103+
```
104+
<Callout type="warning">
105+
**Note:** If you want to use Yaci Store for transaction building, script cost evaluation, and transaction submission via a Blockfrost-compatible API layer,
106+
you'll need to enable both `Yaci Store` and `Ogmios`.
107+
108+
</Callout>
109+
110+
#### 2. Update Ports
111+
You can update the default ports for the Ogmios, Kupo, and Yaci Store.
112+
113+
```properties
114+
ogmios.port=1337
115+
kupo.port=1442
116+
yaci.store.port=8080
117+
```
118+
119+
### **node.properties**
120+
121+
This file contains the configuration for the Cardano Node. You can update the configuration as per your requirements to modify the node's genesis configuration.
122+
123+
### **download.properties**
124+
125+
This file contains the default download versions for the various components. You can update these versions or even provide direct download URLs if needed.
126+
This configuration helps you to download specific compatible versions of Cardano Node or other components, giving you greater control over your environment.
127+
128+
## Multi Node Network Setup
129+
130+
Since Yaci CLI is used in both Yaci DevKit and this distribution, the commands to create a multi-node network remain the same.
131+
You can follow the instructions provided in the [Additional Nodes on Different Machines](/multi-node-setup#additional-nodes-on-different-machines) section of the multi-node setup guide.
132+
133+
134+
135+

‎docs/public/install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ if [ -z "$1" ]; then
2424
fi
2525
# Fetch the latest release version from GitHub
2626
VERSION=$(curl -s "https://api.github.com/repos/bloxbean/yaci-devkit/releases/latest" | jq -r '.tag_name' | sed 's/^v//')
27-
ARTIFACT=$(curl -s "https://api.github.com/repos/bloxbean/yaci-devkit/releases/latest" | jq -r '.assets[0].name')
27+
ARTIFACT="yaci-devkit-$VERSION.zip"
2828
echo "No version specified. Fetching latest version: $VERSION"
2929
else
3030
VERSION=$1

0 commit comments

Comments
 (0)