Skip to content

Commit

Permalink
Merge branch 'staging' into staging
Browse files Browse the repository at this point in the history
  • Loading branch information
jmagan authored Jun 15, 2023
2 parents eb1e21e + 98a90e8 commit 45d3fc6
Show file tree
Hide file tree
Showing 4 changed files with 11,550 additions and 8,065 deletions.
33 changes: 32 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -1289,4 +1289,35 @@ All of the merged PRs in April
- gufmar ([@gufmar](https://github.com/gufmar))
- michele-nuzzi ([@michele-nuzzi](https://github.com/michele-nuzzi))
- nielstron ([@nielstron](https://github.com/nielstron))
- mmahut ([@mmahut](https://github.com/mmahut))
- mmahut ([@mmahut](https://github.com/mmahut))

## 2023.20.0 (2023-05-31)

All of the merged PRs in May

#### PRs: 12

- fix: blockfrost link - get started by ([@vladimirvolek](https://github.com/vladimirvolek)) in [#1053](https://github.com/cardano-foundation/developer-portal/pull/1053)
- Add Maestro Dapp Platform builder tool by ([@Vardominator](https://github.com/Vardominator)) in [#1047](https://github.com/cardano-foundation/developer-portal/pull/1047)
- Add changelog data for April by ([@fill-the-fill](https://github.com/fill-the-fill)) in [#1049](https://github.com/cardano-foundation/developer-portal/pull/1049)
- Update utxo-model.md by ([@4TT1L4](https://github.com/4TT1L4)) in [#1028](https://github.com/cardano-foundation/developer-portal/pull/1028)
- Bring in the new SPO category from revamp branch by ([@katomm](https://github.com/katomm)) in [#1063](https://github.com/cardano-foundation/developer-portal/pull/1063)
- Update project-catalyst.md by ([@katomm](https://github.com/katomm)) in [#1064](https://github.com/cardano-foundation/developer-portal/pull/1064)
- Update installing-cardano-node.md fixed commit for libsodium by ([@os11k](https://github.com/os11k)) in [#1062](https://github.com/cardano-foundation/developer-portal/pull/1062)
- On-Chain Polls: Fix verify-poll parameter by ([@weebl2000](https://github.com/weebl2000)) in [#1065](https://github.com/cardano-foundation/developer-portal/pull/1065)
- On-Chain Polls: correct & update explorer links by ([@rphair](https://github.com/rphair)) in [#1068](https://github.com/cardano-foundation/developer-portal/pull/1068)
- Remove duplicate sidebar link by ([@OlofBlomqvist](https://github.com/OlofBlomqvist)) in [#1070](https://github.com/cardano-foundation/developer-portal/pull/1070)
- Add Registering a Pool to stake pool documentation by ([@sanskys](https://github.com/sanskys)) in [#1066](https://github.com/cardano-foundation/developer-portal/pull/1066)

#### Contributors: 10

- vladimirvolek ([@vladimirvolek](https://github.com/vladimirvolek))
- Vardominator ([@Vardominator](https://github.com/Vardominator))
- fill-the-fill ([@fill-the-fill](https://github.com/fill-the-fill))
- 4TT1L4 ([@4TT1L4](https://github.com/4TT1L4))
- katomm ([@katomm](https://github.com/katomm))
- os11k ([@os11k](https://github.com/os11k))
- weebl2000 ([@weebl2000](https://github.com/weebl2000))
- rphair ([@rphair](https://github.com/rphair))
- OlofBlomqvist ([@OlofBlomqvist](https://github.com/OlofBlomqvist))
- sanskys ([@sanskys](https://github.com/sanskys))
28 changes: 3 additions & 25 deletions docs/get-started/running-cardano.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ curl -O -J https://book.world.dev.cardano.org/environments/mainnet/alonzo-genesi
curl -O -J https://book.world.dev.cardano.org/environments/mainnet/conway-genesis.json
```

The latest supported networks can be found at https://book.world.dev.cardano.org/environments.html
The latest supported networks can be found at https://book.world.dev.cardano.org/environments.html

:::note
Expand All @@ -114,11 +113,9 @@ Each network has a `config` file, `genesis` file(s), `topology` file, and unique
This section will be updated when new **Cardano** networks come online with their respective configuration files and **Network Magic**.
:::

You might be asking what the difference is between `mainnet` and `testnet` and why there are two official network types? To put it simply, **Cardano** is an open-source blockchain, and anyone is free to spin up a network based on **Cardano's** software components. The `mainnet` network was the first one established during the start of the **Byron** era in 2017. And everyone participating in the network agreed that is where all the real value of **Cardano** lives.
You might be asking what the difference is between `mainnet` and `testnet` and why there are two official network types? To put it simply, **Cardano** is an open-source blockchain, and anyone is free to spin up a network based on **Cardano's** software components. The `mainnet` network was the first one established during the start of the **Byron** era in 2017. And everyone participating in the network agreed that is where all the real value of **Cardano** lives.

Testing the network's features and capabilities can be expensive and will consume real value. So [Input-Output Global](https://iohk.io) has spun up sandboxes or testnet versions of the network. Instead of using real `ada` tokens for transactions, you use the `tAda` or **Test ADA**. Alternatively, you can spin up your own custom **Cardano** network, but that is outside the scope of this guide.
Testing the network's features and capabilities can be expensive and will consume real value. So [Input-Output Global](https://iohk.io) has spun up sandboxes or testnet versions of the network. Instead of using real `ada` tokens for transactions, you use the `tAda` or **Test ADA**. Alternatively, you can spin up your own custom **Cardano** network, but that is outside the scope of this guide.
Testing the network's features and capabilities can be expensive and will consume real value. So [Input-Output Global](https://iohk.io) has spun up sandboxes or testnet versions of the network. Instead of using real `ada` tokens for transactions, you use the `tAda` or **Test ADA**. Alternatively, you can spin up your own custom **Cardano** network, but that is outside the scope of this guide.

### Running the node

Expand Down Expand Up @@ -182,27 +179,23 @@ Available options:

:::note
In this section, we will use the path `$HOME/cardano/testnet` to store all the testnet `cardano-node` related files as an example, and please replace it with the directory you have chosen to store the files.
In this section, we will use the path `$HOME/cardano/testnet` to store all the testnet `cardano-node` related files as an example, and please replace it with the directory you have chosen to store the files.
:::

We will focus on six key command-line parameters for running a node:

**`--topology`**: This requires the path of the `topology.json` file that you have downloaded as instructed [above](/docs/get-started/running-cardano#configuration-files).

> For example, If you have downloaded the `topology.json` file to the path `$HOME/cardano/testnet/topology.json`, then the argument would be something like this:
> For example, If you have downloaded the `topology.json` file to the path `$HOME/cardano/testnet/topology.json`, then the argument would be something like this:
```
--topology $HOME/cardano/testnet/topology.json
--topology $HOME/cardano/testnet/topology.json
```

**`--database-path`**: This expects the path to a directory where we will store the actual blockchain data like **blocks**, **transactions**, **metadata**, and other data type that people stored in the **Cardano** blockchain. We explore how we can query those kinds of data in the cardano-db-sync section. ***@TODO: link to the cardano-db-sync section.***

> For example, if we decide that all files required by `cardano-node` will be in the path `$HOME/cardano/testnet`. Then we could create a database directory like this, `mkdir -p $HOME/cardano/testnet/db`.
> For example, if we decide that all files required by `cardano-node` will be in the path `$HOME/cardano/testnet`. Then we could create a database directory like this, `mkdir -p $HOME/cardano/testnet/db`.
> The directory structure would then be something like this:
```
$HOME/cardano/testnet/
$HOME/cardano/testnet/
├── db
├── alonzo-genesis.json
├── byron-genesis.json
Expand All @@ -217,10 +210,8 @@ $HOME/cardano/testnet/
1 directory, 4 files
```
> As you may have noticed, we are planning to run a testnet node in this example and have downloaded the configuration files into the `$HOME/cardano/testnet/` directory. We also see that we have created the `db` directory inside `$HOME/cardano/testnet/` successfully. The argument would look something like this:
> As you may have noticed, we are planning to run a testnet node in this example and have downloaded the configuration files into the `$HOME/cardano/testnet/` directory. We also see that we have created the `db` directory inside `$HOME/cardano/testnet/` successfully. The argument would look something like this:
```
--database-path $HOME/cardano/testnet/db
--database-path $HOME/cardano/testnet/db
```
> Please download and move the configuration files to your Cardano directory as shown above to continue following this guide.

Expand All @@ -231,7 +222,6 @@ $HOME/cardano/testnet/
> Here is an example `--socket-path` argument for **Linux**:
```
--socket-path $HOME/cardano/testnet/db/node.socket
--socket-path $HOME/cardano/testnet/db/node.socket
```
> As you can see, the argument points to a file since **unix sockets** are represented as files (like everything else in **Linux**). In this case, we put the socket file in the `db` directory that we have just created before.
>
Expand Down Expand Up @@ -260,7 +250,6 @@ $HOME/cardano/testnet/
> Here is an example `--config` argument:
```
--config $HOME/cardano/testnet/config.json
--config $HOME/cardano/testnet/config.json
```
> Please make sure that the `alonzo-genesis.json`, `byron-genesis.json` and `shelley-genesis.json` are in the same directory as the `config.json`.

Expand All @@ -271,13 +260,9 @@ cardano-node run \
--config $HOME/cardano/testnet/config.json \
--database-path $HOME/cardano/testnet/db/ \
--socket-path $HOME/cardano/testnet/db/node.socket \
--config $HOME/cardano/testnet/config.json \
--database-path $HOME/cardano/testnet/db/ \
--socket-path $HOME/cardano/testnet/db/node.socket \
--host-addr 127.0.0.1 \
--port 1337 \
--topology $HOME/cardano/testnet/topology.json
--topology $HOME/cardano/testnet/topology.json
```

If you have everything set correctly, you should see something like this:
Expand Down Expand Up @@ -326,7 +311,6 @@ So we will set that in `$HOME/.bashrc` or `$HOME/.zshrc`, depending on which she
Add this line to the bottom of your shell profile (**MacOS** and **Linux**):
```
export CARDANO_NODE_SOCKET_PATH="$HOME/cardano/testnet/db/node.socket"
export CARDANO_NODE_SOCKET_PATH="$HOME/cardano/testnet/db/node.socket"
```

Once saved, reload your shell/terminal for changes to take effect.
Expand All @@ -335,10 +319,9 @@ Finally, we can now test querying the blockchain tip of our `cardano-node`:

- First, run `cardano-node` in a separate terminal for it to start syncing (if not already).
- Open another terminal and run the following command `cardano-cli query tip --testnet-magic 1`.
- Open another terminal and run the following command `cardano-cli query tip --testnet-magic 1`.

> You should see something like this:
```json
```json
{
"block": 2598870,
"epoch": 133,
Expand All @@ -354,17 +337,12 @@ Finally, we can now test querying the blockchain tip of our `cardano-node`:
"syncProgress": "57.09"
}
```
```

:::note
We include `--testnet-magic <NetworkMagic>` in the parameter for `cardano-cli query tip` because we are using a testnet node. If you intend to query `mainnet` instead, please use the `--mainnet` parameter and make sure your node is connected to the `mainnet` network.
We include `--testnet-magic <NetworkMagic>` in the parameter for `cardano-cli query tip` because we are using a testnet node. If you intend to query `mainnet` instead, please use the `--mainnet` parameter and make sure your node is connected to the `mainnet` network.
:::

What you see here is the local tip data of your node. This case, means that you are synced up to `block: 2598870` and `slot: 27149964`.
What you see here is the local tip data of your node. This case, means that you are synced up to `block: 2598870` and `slot: 27149964`.

`syncProgress` is the percentage your node that has been synced. `100` meaning it is fully synced.

`syncProgress` is the percentage your node that has been synced. `100` meaning it is fully synced.

Expand Down
3 changes: 3 additions & 0 deletions docs/smart-contracts/marlowe.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,6 @@ Marlowe uses two validators: the _semantics validator_ for the Marlowe DSL and a
- [Analysis in the playground](https://www.youtube.com/watch?v=VmoUAifui38)
- [ACTUS labs](https://www.youtube.com/watch?v=6PPWFZEfkks)

## Metrics & Adoption
- [Marlowe Explorer: Scanners for contracts on Mainnet & testnets](https://marlowescan.com/)
- [MarloweStat: Statistics for Marlowe contracts on public networks](http://data.marlowestat.org/)
Loading

0 comments on commit 45d3fc6

Please sign in to comment.