Skip to content

Commit 3f6c9cc

Browse files
authored
feat: update smart contract set documentation (#123)
Updates: - 'SettleMint Components' section: http://localhost:8080/documentation/docs/about-settlemint/components/ - Remove 250 euros credit http://localhost:8080/documentation/docs/launch-platform/managed-cloud-deployment/create-an-account/ - Fabconnect http://localhost:8080/documentation/docs/using-platform/middleware/#firefly-fabconnect:~:text=A%20Fabric%20smart%20contract%20set. - Private keys signing proxy mention http://localhost:8080/documentation/docs/using-platform/private-keys/#:~:text=The%20smart%20contract%20set%20IDE%20is%20preconfigured%20to%20use%20this%20signing%20proxy. - Deploying smart contract section http://localhost:8080/documentation/docs/developer-guides/connect-frontend/#deploying-the-smart-contract - Asset tokenization use case http://localhost:8080/documentation/docs/developer-guides/asset-tokenization/#part-2-the-smart-contract - EAS http://localhost:8080/documentation/docs/developer-guides/attestation-service/#adding-the-smart-contract-set - Blockchain guides smart contract IDE sections - all of them are more or less the same ## Summary by Sourcery Update documentation for smart contract sets, access tokens, and platform components. Documentation: - Clarify the process of adding a smart contract set, including template selection and deployment plan details. - Update the documentation for Fabric middleware to include information about access tokens and replace example URLs and tokens. - Add information about application access tokens and their usage in connecting frontends and integrations. - Update the documentation for private keys to clarify their usage with signing proxies. - Update the documentation for Insights, clarifying the supported node types. - Update the "Components" section to include Insights and update the middleware options. - Correct broken links and outdated information in various documentation sections, including deployment plans, creating accounts, managing organizations, and adding resources like nodes, networks, and storage. - Improve the clarity and accuracy of the documentation for connecting frontends, asset tokenization, and resource usage. ## Summary by Sourcery Documentation: - Updated documentation for smart contracts, access tokens, and platform components, including correcting broken links and outdated information.
1 parent bd3f3b4 commit 3f6c9cc

File tree

51 files changed

+342
-938
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+342
-938
lines changed

.prettierrc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@
66
"singleQuote": true,
77
"trailingComma": "none",
88
"bracketSpacing": true,
9-
"arrowParens": "avoid"
9+
"arrowParens": "avoid",
10+
"plugins": ["prettier-plugin-sh"]
1011
}

bun.lock

Lines changed: 95 additions & 66 deletions
Large diffs are not rendered by default.

docs/about-settlemint/4_components.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The first step to building anything on SettleMint is to [create an
2828
application](../../using-platform/create-an-application). You can think of an
2929
application as the collection of resources that you need to build your
3030
blockchain application. This includes a blockchain network, smart contracts,
31-
middleware, storage, and integrations.{' '}
31+
middleware, storage, integrations, and insights.{' '}
3232

3333
## Add a Blockchain Network and Node
3434

@@ -73,8 +73,9 @@ application.
7373
/>
7474
Blockchain applications produce data that lives on the blockchain, but we need
7575
to be able to access that data in order to use it. Creating a
76-
[middleware](../../using-platform/middleware/) allows us SettleMint currently
77-
offers two middleware services: The Graph and Smart Contract Portal Middleware.{' '}
76+
[middleware](../../using-platform/middleware/) allows us to do so. SettleMint
77+
currently offers three middleware services: The Graph, Smart Contract Portal
78+
Middleware and Firefly Fabconnect.{' '}
7879

7980
## Add Storage
8081

@@ -113,5 +114,7 @@ Your blockchain application may require custom components or frontend applicatio
113114

114115
## Getting Started
115116

116-
Now that you have a better idea of each of the components that make up SettleMint, try deploying
117-
your first application with our [Hello World Guide](../../launch-platform/managed-cloud-deployment/quickstart/).
117+
Ready to build? Head over to:
118+
119+
- [Building with SettleMint](using-platform/1_add-a-network-to-an-application.md) for detailed platform instructions
120+
- [Developer Guides](developer-guides/guide-library.mdx) for step-by-step tutorials on common use cases

docs/account-billing/add-a-client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This guide explains how to add a client's organization to your organization as a
99

1010
:::tip
1111

12-
If you are not a SettleMint partner, this guide may not be useful for you. For general account and organization information, visit the [Create an Account](../launch-platform/managed-cloud-deployment/2_create-an-account.md) or [About Organization](../launch-platform/managed-cloud-deployment/3_about-organizations.md) sections.
12+
If you are not a SettleMint partner, this guide may not be useful for you. For general account and organization information, visit the [Create an Account](../launch-platform/managed-cloud-deployment/1_create-an-account.md) or [About Organization](../launch-platform/managed-cloud-deployment/2_about-organizations.md) sections.
1313

1414
Learn about the SettleMint Partner program and how to become a partner on our [Partner Program Page](https://www.settlemint.com/partner-program).
1515

docs/account-billing/join-a-partner.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This guide explains how to transfer your organization to a SettleMint partner. T
88

99
:::tip
1010

11-
If you have not been in contact with a SettleMint partner, this guide may not be useful for you. For general account and organization information, visit the [Create an Account](../launch-platform/managed-cloud-deployment/2_create-an-account.md) or [About Organization](../launch-platform/managed-cloud-deployment/3_about-organizations.md) sections.
11+
If you have not been in contact with a SettleMint partner, this guide may not be useful for you. For general account and organization information, visit the [Create an Account](../launch-platform/managed-cloud-deployment/1_create-an-account.md) or [About Organization](../launch-platform/managed-cloud-deployment/2_about-organizations.md) sections.
1212
:::
1313

1414
## Understanding the Client-Partner Model
Lines changed: 3 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,5 @@
1-
# Smart contracts IDE
1+
# Smart Contract Sets
22

3-
The SettleMint IDE is the only tool you need to edit the smart contract set template you have selected, or **write** your own brand **new** smart contracts. The programming language used for your Ethereum smart contracts is Solidity.
3+
You can launch a Smart Contract Set to significantly accelerate the development of your smart contracts.
44

5-
## Using the IDE
6-
7-
When you open the IDE, you land in an instance of Visual Studio Code similar to the image below.
8-
9-
![ide](../../../static/img/blockchain-guide/IDE.png)
10-
11-
On the left, in the **“Explorer”** panel, you can see all the folders and files related to the smart contract set.
12-
13-
The smart contract files are located in the **“contracts”** folder. You can edit them, or use them as they are if the template fits all your needs.
14-
15-
The **“deploy”** folder contains the scripts that enable the deployment of the smart contract set on the blockchain. You might have to edit these scripts if you add new arguments to the constructor of your smart contract.
16-
17-
The **“test”** folder contains a script that lets you test the functionalities of your smart contracts. You can add new ones if you edit the template. Do not hesitate to go through the test cases as they provide valuable information on how to use your smart contracts.
18-
19-
The **subgraph** folder holds all the files needed to index your smart contract using the Graph protocol.
20-
21-
## Scripts
22-
23-
Several scripts are defined in `package.json` to help you use the smart contract set:
24-
25-
- **lint** to lint your smart contracts, i.e. find the stylistic errors.
26-
- **compile** to compile your smart contracts.
27-
- **test** to run the test script in the “test” folder.
28-
- **smartcontract:deploy** to deploy the smart contract set on the blockchain.
29-
- **smartcontract:deploy:reset** to deploy from scratch after a first deployment.
30-
- **graph:config** to create the middleware configuration file.
31-
- **graph:compile** to compile the middleware files.
32-
- **graph:codegen** to create the middleware schema.
33-
- **graph:build** to build the middleware.
34-
- **graph:deploy** to deploy the middleware.
35-
- **graph:all** to execute all the graph scripts in one command.
36-
37-
:::warning Note
38-
39-
To execute the scripts related to the Graph middleware, you need a middleware instance in your app.
40-
41-
:::
42-
43-
You can execute these scripts in the terminal integrated with the IDE by running `yarn name-of-script`.
44-
For example, to run the `smartcontract:deploy` task using the terminal, open a new terminal (ctrl + shift + \`) and run the command`yarn smartcontract:deploy`.
45-
46-
## Private key
47-
48-
To be able to deploy your smart contract set on the blockchain you need to have a private key enabled on your node to sign the transaction, and you need to fund this key with Ether to cover the cost for the transaction. You can create a private key and fund it in the **Private keys section** of your application. [More about private keys.](../../using-platform/12_private-keys.md)
49-
50-
## Template library
51-
52-
Every instance of the IDE contains a set of pre-built smart contract templates. These templates are easily customizable to match your specific use case. [Discover the smart contract set templates for Ethereum.](../0_Ethereum/Template-library/1_ethereum-erc-20.md)
53-
54-
## Generative AI plugin
55-
56-
The integration of an OpenAI GPT plugin into the Smart Contract IDE of the SettleMint platform brings forth significant advantages for the fast development of new smart contracts. Generative AI technology empowers developers by providing them with automated code suggestions, smart contract templates, and code completion capabilities. This accelerates the development process by reducing manual effort and improving code efficiency.
57-
58-
Additionally, the interactive debugging and explanation features offered by the GPT plugin greatly benefit developers of all skill levels. Beginners can leverage the plugin’s explanations to understand complex concepts, improve their coding skills, and gain insights into best practices. Experienced developers can utilize the debugging features to quickly identify and resolve issues, leading to more robust and error-free smart contracts.
59-
60-
Overall, the integration of the OpenAI GPT plugin into the SettleMint platform’s Smart Contract IDE combines the power of generative AI and interactive debugging to enhance productivity, code quality, and learning opportunities for developers in the blockchain space.
61-
62-
You can find this plugin in the sidebar (magic lamp icon), in context menu and the action panel. The first time you use the plugin you will get asked for an OpenAI API key. Depending on your OpenAI API access you can use the default GPT 3.5 model or the GPT 4 model which is slower, but more accurate. Check out the settings in the IDE to configure this and other settings (like using your own Azure GPT service)
63-
64-
Here are some prompts to get you started:
65-
66-
- Write a Solidity ERC20 token representing a bond, based on OpenZeppelin. Include a bond repayment and coupon payments.
67-
- Write a Solidity ERC721 token representing real estate, based on OpenZeppelin and allow fractional ownership of this NFT in the form of ERC20 tokens.
68-
- Write The Graph indexing code that indexes an ERC721 token on the Ethereum Mainnet.
69-
70-
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/-e4weLqbYjk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
5+
[Learn here how to use Smart Contract Sets to deploy your smart contracts](../../using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/1_smart-contract-sets.md).
Lines changed: 3 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,5 @@
1-
# Smart contracts IDE
1+
# Smart Contract Sets
22

3-
The SettleMint IDE is the only tool you need to edit the smart contract set template you have selected, or **write** your own brand **new** smart contracts. The programming language used for your Polygon zkEVM smart contracts is Solidity.
3+
You can launch a Smart Contract Set to significantly accelerate the development of your smart contracts.
44

5-
## Using the IDE
6-
7-
When you open the IDE, you land in an instance of Visual Studio Code similar to the image below.
8-
9-
![ide](../../../static/img/blockchain-guide/IDE.png)
10-
11-
On the left, in the **“Explorer”** panel, you can see all the folders and files related to the smart contract set.
12-
13-
The smart contract files are located in the **“contracts”** folder. You can edit them, or use them as they are if the template fits all your needs.
14-
15-
The **“deploy”** folder contains the scripts that enable the deployment of the smart contract set on the blockchain. You might have to edit these scripts if you add new arguments to the constructor of your smart contract.
16-
17-
The **“test”** folder contains a script that lets you test the functionalities of your smart contracts. You can add new ones if you edit the template. Do not hesitate to go through the test cases as they provide valuable information on how to use your smart contracts.
18-
19-
The **subgraph** folder holds all the files needed to index your smart contract using the Graph protocol.
20-
21-
## Scripts
22-
23-
Several scripts are defined in `package.json` to help you use the smart contract set:
24-
25-
- **lint** to lint your smart contracts, i.e. find the stylistic errors.
26-
- **compile** to compile your smart contracts.
27-
- **test** to run the test script in the “test” folder.
28-
- **smartcontract:deploy** to deploy the smart contract set on the blockchain.
29-
- **smartcontract:deploy:reset** to deploy from scratch after a first deployment.
30-
- **graph:config** to create the middleware configuration file.
31-
- **graph:compile** to compile the middleware files.
32-
- **graph:codegen** to create the middleware schema.
33-
- **graph:build** to build the middleware.
34-
- **graph:deploy** to deploy the middleware.
35-
- **graph:all** to execute all the graph scripts in one command.
36-
37-
:::warning Note
38-
39-
To execute the scripts related to the Graph middleware, you need a middleware instance in your app.
40-
41-
:::
42-
43-
You can execute these scripts in the terminal integrated with the IDE by running `yarn name-of-script`.
44-
For example, to run the `smartcontract:deploy` task using the terminal, open a new terminal (ctrl + shift + \`) and run the command`yarn smartcontract:deploy`.
45-
46-
## Private key
47-
48-
To be able to deploy your smart contract set on the blockchain you need to have a private key enabled on your node to sign the transaction, and you need to fund this key with Ether to cover the cost for the transaction. You can create a private key and fund it in the **Private keys section** of your application. [More about private keys.](../../using-platform/12_private-keys.md)
49-
50-
## Template library
51-
52-
Every instance of the IDE contains a set of pre-built smart contract templates. These templates are easily customizable to match your specific use case. [Discover the smart contract set templates for Polygon zkEVM.](../10_Polygon-zkEVM/Template-library/1_polygon-zkevm-erc-20.md)
53-
54-
## Generative AI plugin
55-
56-
The integration of an OpenAI GPT plugin into the Smart Contract IDE of the SettleMint platform brings forth significant advantages for the fast development of new smart contracts. Generative AI technology empowers developers by providing them with automated code suggestions, smart contract templates, and code completion capabilities. This accelerates the development process by reducing manual effort and improving code efficiency.
57-
58-
Additionally, the interactive debugging and explanation features offered by the GPT plugin greatly benefit developers of all skill levels. Beginners can leverage the plugin’s explanations to understand complex concepts, improve their coding skills, and gain insights into best practices. Experienced developers can utilize the debugging features to quickly identify and resolve issues, leading to more robust and error-free smart contracts.
59-
60-
Overall, the integration of the OpenAI GPT plugin into the SettleMint platform’s Smart Contract IDE combines the power of generative AI and interactive debugging to enhance productivity, code quality, and learning opportunities for developers in the blockchain space.
61-
62-
You can find this plugin in the sidebar (magic lamp icon), in context menu and the action panel. The first time you use the plugin you will get asked for an OpenAI API key. Depending on your OpenAI API access you can use the default GPT 3.5 model or the GPT 4 model which is slower, but more accurate. Check out the settings in the IDE to configure this and other settings (like using your own Azure GPT service)
63-
64-
Here are some prompts to get you started:
65-
66-
- Write a Solidity ERC20 token representing a bond, based on OpenZeppelin. Include a bond repayment and coupon payments.
67-
- Write a Solidity ERC721 token representing real estate, based on OpenZeppelin and allow fractional ownership of this NFT in the form of ERC20 tokens.
68-
- Write The Graph indexing code that indexes an ERC721 token on the Ethereum Mainnet.
69-
70-
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/-e4weLqbYjk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
5+
[Learn here how to use Smart Contract Sets to deploy your smart contracts](../../using-platform/15_dev-tools/0_code-studio/1_smart-contract-sets/1_smart-contract-sets.md).

0 commit comments

Comments
 (0)