Smart Contract API

AElfProject · Jun 26, 2024 · 5a53cbe · 5a53cbe
1 parent 99bad18
commit 5a53cbe
Show file tree

Hide file tree

Showing 21 changed files with 7,365 additions and 27 deletions.
diff --git a/docs/Tools/chain-sdk/c#-sdk/index.md → docs/Tools/chain-sdk/csharp-sdk/index.md b/docs/Tools/chain-sdk/c#-sdk/index.md → docs/Tools/chain-sdk/csharp-sdk/index.md
diff --git a/docs/quick-start/start-and-run-a-node-on-aelf-locally-or-on-cloud/index.md b/docs/quick-start/start-and-run-a-node-on-aelf-locally-or-on-cloud/index.md
@@ -6,21 +6,21 @@ This guide will walk you through the steps required to run an aelf node on Googl
 
 1. Go to the [Google Cloud Marketplace](https://console.cloud.google.com/marketplace) and search for "aelf blockchain for enterprise".
 
-   ![image](gcp-step1.png)
+   ![image](../../../static/img/gcp-step1.png)
 
 2. Find the aelf image and click on "LAUNCH ON COMPUTE ENGINE".
 
-   ![image](gcp-step2-b.png)
+   ![image](../../../static/img/gcp-step2-b.png)
 
 3. Keep the default settings and click "DEPLOY" at the bottom left of the page.
 
-   ![image](gcp-deployed.png)
+   ![image](../../../static/img/gcp-deployed.png)
 
 ## Step 2: Access and Start the Chain
 
 1. Login to the launched VM instance via SSH. You can do this by clicking the SSH drop-down and selecting "Open in browser window".
 
-   ![image](gcp-ssh-select.png)
+   ![image](../../../static/img/gcp-ssh-select.png)
 
 2. In the SSH session, execute `sudo bash` to elevate your privileges.
 
@@ -35,7 +35,7 @@ This guide will walk you through the steps required to run an aelf node on Googl
      cd /opt/aelf-node && docker-compose up -d
      ```
 
-   ![image](gcp-docker-compose.png)
+   ![image](../../../static/img/gcp-docker-compose.png)
 
 ## Step 3: Verify Chain Status
 
@@ -45,6 +45,6 @@ This guide will walk you through the steps required to run an aelf node on Googl
    curl -X GET "http://127.0.0.1:8001/api/blockChain/chainStatus" -H "accept: text/plain; v=1.0"
    ```
 
-   ![image](gcp-curl-chain-stat.png)
+   ![image](../../../static/img/gcp-curl-chain-stat.png)
 
 2. If everything is working normally, you should see the chain status increase with each request.
diff --git a/docs/references/smart-contract-api/association-contract/index.md b/docs/references/smart-contract-api/association-contract/index.md
diff --git a/docs/references/smart-contract-api/configuration-contract/index.md b/docs/references/smart-contract-api/configuration-contract/index.md
diff --git a/docs/references/smart-contract-api/consensus-contract/index.md b/docs/references/smart-contract-api/consensus-contract/index.md
diff --git a/docs/references/smart-contract-api/cross-chain-contract/index.md b/docs/references/smart-contract-api/cross-chain-contract/index.md
diff --git a/docs/references/smart-contract-api/economic-contract/index.md b/docs/references/smart-contract-api/economic-contract/index.md
diff --git a/docs/references/smart-contract-api/election-contract/index.md b/docs/references/smart-contract-api/election-contract/index.md
diff --git a/docs/references/smart-contract-api/genesis-contract/index.md b/docs/references/smart-contract-api/genesis-contract/index.md
diff --git a/docs/references/smart-contract-api/index.md b/docs/references/smart-contract-api/index.md
diff --git a/docs/references/smart-contract-api/multi-token-contract/index.md b/docs/references/smart-contract-api/multi-token-contract/index.md
diff --git a/docs/references/smart-contract-api/parliament-contract/index.md b/docs/references/smart-contract-api/parliament-contract/index.md
diff --git a/docs/references/smart-contract-api/profit-contract/index.md b/docs/references/smart-contract-api/profit-contract/index.md
diff --git a/docs/references/smart-contract-api/referendum-contract/index.md b/docs/references/smart-contract-api/referendum-contract/index.md
diff --git a/docs/references/smart-contract-api/token-convert-contract/index.md b/docs/references/smart-contract-api/token-convert-contract/index.md
diff --git a/docs/references/smart-contract-api/token-holder-contract/index.md b/docs/references/smart-contract-api/token-holder-contract/index.md
diff --git a/docs/references/smart-contract-api/treasury-contract/index.md b/docs/references/smart-contract-api/treasury-contract/index.md
diff --git a/docs/references/smart-contract-api/vote-contract/index.md b/docs/references/smart-contract-api/vote-contract/index.md
diff --git a/docs/understanding-aelf/core/implementation/index.md b/docs/understanding-aelf/core/implementation/index.md
@@ -5,7 +5,7 @@ title: Core Implementation
 
 # Design Principles
 
-![image](node-archi.png)
+![image](../../../../static/img/node-archi.png)
 
 The diagram above shows the conceptual structure of the node and the separation between the OS and Kernel.
 

diff --git a/docs/understanding-aelf/cross-chain/architecture/index.md b/docs/understanding-aelf/cross-chain/architecture/index.md
@@ -22,7 +22,7 @@ Through this link, messages are exchanged, and indexing is performed to ensure t
 
 In the current architecture, both the side chain node and the main chain node have one server and exactly one client. This forms the basis for AElf's two-way communication between the main chain and side chains. Both the server and the client are implemented as node plugins (a node has a collection of plugins). Interaction (listening and requesting) can start once both nodes are running.
 
-![Node Level Architecture](side-chain-nodes.png)
+![Node Level Architecture](../../../../static/img/side-chain-nodes.png)
 
 The diagram above illustrates two nodes run by an entity: one main chain node and one side chain node. Note that the nodes don't have to be in the same physical location.
 
@@ -63,4 +63,4 @@ Apart from the data in blocks, most cross-chain data will be stored by the cross
 
 Conceptually, the node operates as described in the following diagram. The main/side chain node receives cross-chain data from the other side and stores it in local memory. The indexing transaction is packed by the miner, and the cross-chain data is written into the `State` through the `Crosschain Contract`.
 
-![Data Flow](architecture-node.png)
+![Data Flow](../../../../static/img/architecture-node.png)
diff --git a/docs/understanding-aelf/cross-chain/introduction/index.md b/docs/understanding-aelf/cross-chain/introduction/index.md
@@ -10,16 +10,19 @@ One of the major issues with current blockchain systems is scalability. This is
 To address this issue, AElf introduced side chains in its initial design. The concept is that each side-chain handles one or more similar business scenarios, distributing different tasks across multiple chains to improve overall processing efficiency.
 
 ## Key Points:
+
 - **Independent and Specialized**: Side-chains are designed to be independent and specialized, ensuring that the dApps running on them perform efficiently and smoothly.
 - **Network Link**: There is a network link between the main-chain node and side-chain nodes, with communication indirectly facilitated through a Merkle root.
 
-![image](introduction-topology.png)
+![image](../../../../static/img/introduction-topology.png)
 
-*The diagram above illustrates the conceptual idea behind side chains.*
+_The diagram above illustrates the conceptual idea behind side chains._
 
 Side chains are isolated but still need a way to interact with each other. To enable cross-chain verification scenarios, AElf introduces a communication mechanism through **Merkle roots** and **indexing**.
 
 ## Overview
+
 The following sections of this documentation will provide:
+
 - An overview of the architecture of AElf's side chains.
 - A guide explaining how to set up a main-chain and a side chain node.