Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/launch-platform/managed-cloud-deployment/1_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ sidebar_position: 3

# Getting Started - Hello World

##### This guide will help you explore some of the core building blocks of working with SettleMint even if this is your first time working with a Blockchain.
##### This guide will help you explore some of the core building blocks of working with SettleMint even if this is your first time working with a Blockchain

In this guide you will learn how to [create a blockchain network](../../using-platform/1_add-a-network-to-an-application.md), [deploy a node](../../using-platform/2_add-a-node-to-a-network.md), write a [smart contract](../../using-platform/6_create-smart-contract-set.md) and [create an integration](../../using-platform/9_integration-studio.md).
In this guide you will learn how to [create a blockchain network](../../using-platform/1_add-a-network-to-an-application.md), [deploy a node](../../using-platform/2_add-a-node-to-a-network.md), write a [smart contract](../../using-platform/6_add_smart_contract_sets/0_smart_contracts.md) and [create an integration](../../using-platform/9_integration-studio.md).

Below is both a video and written guide for you to build along to:

Expand Down Expand Up @@ -152,9 +152,9 @@ In the IDE, you need to locate and rename the `Example.sol` file that comes incl

![Rename Contract](../../../static/img/quickstart/renamecontract.png)

1. On the left File Explorer panel, find the `contracts` folder and click the arrow to expand.
2. Find the `Example.sol` file in the list
3. Right-click on the file and select `Rename`. Rename the file to `HelloWorld.sol`. This is case-sensitive so make sure you have named it exactly `HelloWorld
1. On the left File Explorer panel, find the `contracts` folder and click the arrow to expand.
2. Find the `Example.sol` file in the list
3. Right-click on the file and select `Rename`. Rename the file to `HelloWorld.sol`. This is case-sensitive so make sure you have named it exactly `HelloWorld

Now you can replace the code that is in the `HelloWorld.sol` file.

Expand Down Expand Up @@ -330,7 +330,7 @@ This is done by clicking the name of the private key. There select the `Details`
![Key Created](../../../static/img/quickstart/privatekeycreated.png)
![Alt text](../../../static/img/quickstart/copyprivatekey.png)

With the private key copied, you can now go back to the Integration Studio and paste this key into the first line after `const privateKey = ` inside the ' ''. The private key should begin with `0x`.
With the private key copied, you can now go back to the Integration Studio and paste this key into the first line after `const privateKey =` inside the ' ''. The private key should begin with `0x`.

![Paste Private Key](../../../static/img/quickstart/pasteprivatekey.png)

Expand All @@ -346,10 +346,10 @@ SettleMint uses Hardhat scripts to deploy smart contracts. To deploy the Hello W

![Deploy Changes](../../../static/img/quickstart/deploychanges.png)

1. Go to the `deploy` folder in the file explorer on the left
2. Open the `00_deploy_example.ts` file
3. Delete the code that is currently in this file
4. Copy and paste the code below:
1. Go to the `deploy` folder in the file explorer on the left
2. Open the `00_deploy_example.ts` file
3. Delete the code that is currently in this file
4. Copy and paste the code below:

```typescript
import { DeployFunction } from 'hardhat-deploy/types';
Expand Down Expand Up @@ -469,10 +469,10 @@ You can now start interacting with the Hello World contract via a front-end page

Your URL will look something similar to this:

Before: `https://helloworld-9ece.gke-europe.settlemint.com/#flow/cfc3eb139dc03dc5`
Before: `https://helloworld-9ece.gke-europe.settlemint.com/#flow/cfc3eb139dc03dc5`
After: `https://helloworld-9ece.gke-europe.settlemint.com/helloworld`

In your browser you will see two options `Read-only ` and `Write`functions:
In your browser you will see two options `Read-only` and `Write`functions:

- `Read-only`: These functions can only read the data from the smart contract

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You can access the Admin Console to complete the SettleMint Platform setup, run

![CleanShot 2022-10-01 at 13.01.15@2x.png](/img/completing-setup-and-deploying/CleanShot_2022-10-01_at_13.01.152x.png)

- Upload the license file [downloaded from Step 1](../download/download-portal.md)
- Upload the license file [downloaded from Step 1](./download/download-portal.md)

![CleanShot 2022-10-01 at 13.01.29@2x.png](/img/completing-setup-and-deploying/CleanShot_2022-10-01_at_13.01.292x.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ From the SettleMint Download Portal, download the following files
- Full Bundle or Small Bundle : If you choose the small bundle, set up separate pipeline to push images to your repository.
See [below](#understanding-the-structure) for a more detailed explanation.

Continue with [Step 2](../installing-on-an-existing-cluster/install-airgap/install-airgap.md)
Continue with [Step 2](../install-airgap/install-airgap.md)

## Understanding the Structure

Expand Down Expand Up @@ -60,5 +60,5 @@ Please note that with this option, upgrading to a another version of the SettleM
- You may also need to get newer versions of the framework software, but our license page will indicate if so.

Once you have downloaded all the files from the link shared with you, you can check that your setup meets the minimum
[requirements](../installing-on-an-existing-cluster/requirements.md) before continuing with the
[installation](../installing-on-an-existing-cluster/install-airgap/install-airgap.md).
[requirements](../requirements.md) before continuing with the
[installation](../install-airgap/install-airgap.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
sidebar_position: 2
---

# Online Installation

To proceed with the online installation, you only need to download the license file from the download portal.

Check that your setup meets the minimum [requirements](../requirements.md)
before proceeding with the [installation](../install-online/install-online.md).
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ There are 3 options to set up the install. Depending on your license, you can ch

- License file
- Installers
- [KOTS CLI](../installing-on-an-existing-cluster/install-airgap/install-kots.md)
- [KOTS admin console](../installing-on-an-existing-cluster/install-airgap/install-kotsadm.md)
- [KOTS CLI](../install-airgap/install-kots.md)
- [KOTS admin console](../install-airgap/install-kotsadm.md)
- SettleMint Platform, comprising of
- Deployer image and scripts
- All the component images
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Install the SettleMint Platform in an Airgap Environment

When installing the SettleMint Platform on a cluster without internet access, you will need to ensure that you have
followed the steps discribed in the [download section](../../download/download-airgap.md) to download the required license and installation files.
followed the steps discribed in the [download section](../download/download-airgap.md) to download the required license and installation files.

Airgapped install is only available for licenses that have the airgapped feature enabled.

Expand Down Expand Up @@ -33,7 +33,7 @@ details on Open Shift command line linkages. 2. **Install the [Admin Console](./

3. **Install the SettleMint Platform application via the Admin Console**

As explained in the [download section](../../download/download-airgap.md),
As explained in the [download section](../download/download-airgap.md),
there are 2 ways to proceed with your airgapped installations: Full or Small Bundles. In the case of **Small**
Bundle, there is an additional step to run the script to push the images to your local registry. You must run this step
**prior** to running the `kots install` command below.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ kotsadm package.

## Install the Admin Console

1. Download the admin console binary bundle, `kotsadm.tar.gz` ([Downloads](../../download/download-airgap.md))
1. Download the admin console binary bundle, `kotsadm.tar.gz` ([Downloads](../download/download-airgap.md))

- latest kotsadm release notes can be found [here](https://docs.replicated.com/release-notes/rn-app-manager)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Follow these steps from the machine that is connected to your airgapped cluster.

2. Ensure your image registry is setup. See the [Image Registry Section](./install-airgap.md).

3. Run the provided script mentioned in the [download section](../../download/download-airgap.md) to pull the images
3. Run the provided script mentioned in the [download section](../download/download-airgap.md) to pull the images
from our repository and push them on your registry.

```bash
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ title: Overview
description: Overview
sidebar_position: 0
---

# Deploying Smart Contracts

## Introduction

To make developing smart contracts easier, we offer an open-source [template library](/btp-docs/docs/using-platform/6_add_smart_contract_sets/1_smart_contract_templates.md) and an Integrated Development Environment (IDE). The template library includes pre-built smart contracts that you can customize to meet your specific needs.

If you need a fundamental explanation of what smart contracts are and how they work, we recommend contacting our team to join our Learn World Blockchain course. Our experts will guide you through the basics, ensuring you have a solid foundation before diving into development. For a practical guide, please visit [deploying a contract](/btp-docs/docs/using-platform/6_add_smart_contract_sets/deploying_a_contract.md).
To make developing smart contracts easier, we offer an open-source [template library](./1_smart_contract_templates.md) and an Integrated Development Environment (IDE). The template library includes pre-built smart contracts that you can customize to meet your specific needs.

If you need a fundamental explanation of what smart contracts are and how they work, we recommend contacting our team to join our Learn World Blockchain course. Our experts will guide you through the basics, ensuring you have a solid foundation before diving into development. For a practical guide, please visit [deploying a contract](./3_deploying_a_contract.md).

SettleMint's smart contract sets include both Hardhat and Foundry, enabling you to compile, test, and deploy using your preferred framework or a combination of both. This flexibility allows you to optimize your development process to best suit your project needs and preferences.

Expand All @@ -20,8 +20,8 @@ The following is a high-level overview of smart contract development processes a

### 1. Deploying a Smart Contract Set

- **Add Smart Contract Set**: Navigate to the smart contract sets page and press the button "Add Smart Contract Set."
- **Picking Your Template**: Pick the template of your choice.
- **Add Smart Contract Set**: Navigate to the smart contract sets page and press the button "Add Smart Contract Set."
- **Picking Your Template**: Pick the template of your choice.

### 2. Compiling and Configuring The Smart Contract

Expand All @@ -30,6 +30,7 @@ The following is a high-level overview of smart contract development processes a
- **Purpose**: Tailors the deployment process to your specific requirements and ensures your contract can run on the blockchain.

### 3. Deploying and Interacting with the Smart Contract

- **Deploying**: Upload your compiled smart contract to a blockchain network.
- **Interacting**: Once deployed, interact with the smart contract through transactions that call its functions.
- **Purpose**: Makes the contract accessible on the blockchain so users can interact with it and utilize its features to perform actions defined in its logic.
Expand All @@ -55,7 +56,8 @@ Hardhat is a development environment for EVM software. It provides a flexible an
3. **Compile and Deploy Contract**: Convert your Solidity code into bytecode and deploy your compiled contract to the blockchain network of your choice.

## Key Points

- **Smart Contracts**: Self-executing programs with predefined rules.
- **Compiling and Configuring**: Converts code into a format the blockchain can run and tailors the deployment process.
- **Deploying and Interacting**: Uploads the compiled code to the blockchain and makes it accessible for interaction.
By following these steps and using the appropriate tools, you can easily create, compile, and deploy smart contracts to automate and secure your business processes on the blockchain.
By following these steps and using the appropriate tools, you can easily create, compile, and deploy smart contracts to automate and secure your business processes on the blockchain.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The SettleMint Integrated Development Environment (IDE) is a powerful tool that simplifies the development of your smart contracts. It includes pre-built smart contract set templates for a certain use case, which are easily customizable to match your specific use case. The IDE also includes compilation and migration scripts that drastically simplify deployment to the relevant blockchain.

When you [add a smart contract set](6_create-smart-contract-set.md), you get an instance of the IDE that is configured to the blockchain and smart contract set templates of your choice. Go to the **IDE tab** on the **Smart contract sets details page** to access it.
When you [add a smart contract set](./6_add_smart_contract_sets/0_smart_contracts.md), you get an instance of the IDE that is configured to the blockchain and smart contract set templates of your choice. Go to the **IDE tab** on the **Smart contract sets details page** to access it.

The IDE programming languages for smart contracts differ depending on the protocol. For blockchain networks that are EVM (Ethereum Virtual Machine) compatible, and are listed below, the programming language used is Solidity.

Expand Down