From 2611ca2fe5db4d8f2d6fc807b67e23b5b88a6f26 Mon Sep 17 00:00:00 2001 From: AelfHarsh Date: Thu, 27 Jun 2024 09:16:13 +0530 Subject: [PATCH] Formated APIs of smartcontract page --- .../docs/smart-contract-api/association-contract/index.md | 3 +-- .../smart-contract-api/configuration-contract/index.md | 2 +- docs/docs/smart-contract-api/consensus-contract/index.md | 2 +- .../docs/smart-contract-api/cross-chain-contract/index.md | 2 +- docs/docs/smart-contract-api/economic-contract/index.md | 4 +--- docs/docs/smart-contract-api/election-contract/index.md | 2 +- docs/docs/smart-contract-api/genesis-contract/index.md | 5 ++--- .../docs/smart-contract-api/multi-token-contract/index.md | 8 ++------ docs/docs/smart-contract-api/parliament-contract/index.md | 4 +--- docs/docs/smart-contract-api/profit-contract/index.md | 8 ++------ docs/docs/smart-contract-api/referendum-contract/index.md | 2 -- .../smart-contract-api/token-convert-contract/index.md | 8 +++----- .../smart-contract-api/token-holder-contract/index.md | 6 ++---- docs/docs/smart-contract-api/treasury-contract/index.md | 8 ++------ docs/docs/smart-contract-api/vote-contract/index.md | 8 ++------ 15 files changed, 22 insertions(+), 50 deletions(-) diff --git a/docs/docs/smart-contract-api/association-contract/index.md b/docs/docs/smart-contract-api/association-contract/index.md index 661505d..ee895cf 100644 --- a/docs/docs/smart-contract-api/association-contract/index.md +++ b/docs/docs/smart-contract-api/association-contract/index.md @@ -3,9 +3,8 @@ sidebar_position: 1 title: Association Contract --- -# AElf.Contracts.Association -## Association contract +# Association contract Organizations established to achieve specific goals can use this contract to cooperatively handle transactions within the organization. diff --git a/docs/docs/smart-contract-api/configuration-contract/index.md b/docs/docs/smart-contract-api/configuration-contract/index.md index 4a963c6..766c485 100644 --- a/docs/docs/smart-contract-api/configuration-contract/index.md +++ b/docs/docs/smart-contract-api/configuration-contract/index.md @@ -3,7 +3,7 @@ sidebar_position: 15 title: Configuration Contract --- -# Configuration contract. +# Configuration Contract Used to manage the configuration on the blockchain. Implements aelf Standards ACS1. diff --git a/docs/docs/smart-contract-api/consensus-contract/index.md b/docs/docs/smart-contract-api/consensus-contract/index.md index 5b84de1..b865e1b 100644 --- a/docs/docs/smart-contract-api/consensus-contract/index.md +++ b/docs/docs/smart-contract-api/consensus-contract/index.md @@ -3,7 +3,7 @@ sidebar_position: 4 title: Consensus Contract --- -# AElf.Contracts.Consensus.AEDPoS +# Consensus Contract ## AEDPoS contract diff --git a/docs/docs/smart-contract-api/cross-chain-contract/index.md b/docs/docs/smart-contract-api/cross-chain-contract/index.md index ad61dfe..c9b9770 100644 --- a/docs/docs/smart-contract-api/cross-chain-contract/index.md +++ b/docs/docs/smart-contract-api/cross-chain-contract/index.md @@ -4,7 +4,7 @@ title: Cross Chain Contract --- -# Cross-Chain contract. +# Cross-Chain Contract Implement aelf Standards ACS1 and ACS7. diff --git a/docs/docs/smart-contract-api/economic-contract/index.md b/docs/docs/smart-contract-api/economic-contract/index.md index aa49d74..b93e68a 100644 --- a/docs/docs/smart-contract-api/economic-contract/index.md +++ b/docs/docs/smart-contract-api/economic-contract/index.md @@ -5,9 +5,7 @@ title: Economic Contract # Economic Contract -The Economic contract establishes the economic system of the aelf. When the blockchain starts to work, this contract will initialize other contracts related to economic activities. - -Implements aelf Standards ACS1. +The Economic contract establishes the economic system of the aelf. When the blockchain starts to work, this contract will initialize other contracts related to economic activities. Implements aelf Standards ACS1. ## Contract Methods diff --git a/docs/docs/smart-contract-api/election-contract/index.md b/docs/docs/smart-contract-api/election-contract/index.md index b62543c..78a1991 100644 --- a/docs/docs/smart-contract-api/election-contract/index.md +++ b/docs/docs/smart-contract-api/election-contract/index.md @@ -3,7 +3,7 @@ sidebar_position: 5 title: Election Contract --- -# Election contract +# Election Contract Used for voting for Block Producers.Implement aelf Standards ACS1. diff --git a/docs/docs/smart-contract-api/genesis-contract/index.md b/docs/docs/smart-contract-api/genesis-contract/index.md index 53b092a..e46171b 100644 --- a/docs/docs/smart-contract-api/genesis-contract/index.md +++ b/docs/docs/smart-contract-api/genesis-contract/index.md @@ -3,10 +3,9 @@ sidebar_position: 6 title: Genesis Contract --- -# AElf.Contracts.Genesis +# Genesis Contract -Genesis contract. Used to manage the deployment and update of contracts. -Implement aelf Standards ACS0 and ACS1. +Used to manage the deployment and update of contracts. Implement aelf Standards ACS0 and ACS1. ## Contract Methods diff --git a/docs/docs/smart-contract-api/multi-token-contract/index.md b/docs/docs/smart-contract-api/multi-token-contract/index.md index afc1d4c..1e82cf6 100644 --- a/docs/docs/smart-contract-api/multi-token-contract/index.md +++ b/docs/docs/smart-contract-api/multi-token-contract/index.md @@ -3,13 +3,9 @@ sidebar_position: 7 title: Multi Token Contract --- -# AElf.Contracts.MultiToken +# MultiToken Contract -MultiToken contract. - -The MultiToken contract is mainly used to manage the user's account and transaction fees related settings. - -Implements aelf Standards ACS1 and ACS2. +The MultiToken contract is mainly used to manage the user's account and transaction fees related settings. Implements aelf Standards ACS1 and ACS2. ## Contract Methods diff --git a/docs/docs/smart-contract-api/parliament-contract/index.md b/docs/docs/smart-contract-api/parliament-contract/index.md index edaad6e..68864dd 100644 --- a/docs/docs/smart-contract-api/parliament-contract/index.md +++ b/docs/docs/smart-contract-api/parliament-contract/index.md @@ -3,9 +3,7 @@ sidebar_position: 3 title: Parliament Contract --- -# AElf.Contracts.Parliament - -Parliament contract. +# Parliament Contract The production nodes use the Parliament contract to govern important matters. In the initial state, the production nodes are members of the parliament, and only when two-thirds of the production nodes vote in favor of a given decision, will it be executed. diff --git a/docs/docs/smart-contract-api/profit-contract/index.md b/docs/docs/smart-contract-api/profit-contract/index.md index 06cd34d..056bc85 100644 --- a/docs/docs/smart-contract-api/profit-contract/index.md +++ b/docs/docs/smart-contract-api/profit-contract/index.md @@ -3,13 +3,9 @@ sidebar_position: 8 title: Profit Contract --- -# AElf.Contracts.Profit +# Profit Contract -## Profit contract - -The Profit contract is an abstract layer for creating a scheme to share bonuses. Developers can build a system to distribute bonuses by calling this contract. - -Implement aelf Standards ACS1. +The Profit contract is an abstract layer for creating a scheme to share bonuses. Developers can build a system to distribute bonuses by calling this contract. Implement aelf Standards ACS1. ## Contract Methods diff --git a/docs/docs/smart-contract-api/referendum-contract/index.md b/docs/docs/smart-contract-api/referendum-contract/index.md index b89c79e..3702c58 100644 --- a/docs/docs/smart-contract-api/referendum-contract/index.md +++ b/docs/docs/smart-contract-api/referendum-contract/index.md @@ -5,8 +5,6 @@ title: Referendum Contract # Referendum -Referendum contract. - Production nodes or associations cannot determine all decisions. Some extremely important decisions, especially those involving user rights and interests, should involve all users and give full control to the user's voting for governance. The Referendum contract is built for this. Implement aelf Standards ACS1 and ACS3. diff --git a/docs/docs/smart-contract-api/token-convert-contract/index.md b/docs/docs/smart-contract-api/token-convert-contract/index.md index d359f3b..4de9d1e 100644 --- a/docs/docs/smart-contract-api/token-convert-contract/index.md +++ b/docs/docs/smart-contract-api/token-convert-contract/index.md @@ -1,13 +1,11 @@ --- sidebar_position: 14 -title: Token Convert Contract +title: Token Converter Contract --- -# TokenConverter +# Token Converter Contract -Using this contract can build a connection between the base token and other tokens created on the chain. After building the connection, users can trade tokens with the Bancor model. You can find detailed information about Bancor in the AElf Economic System White Paper. - -Implement aelf Standards ACS1. +Using this contract can build a connection between the base token and other tokens created on the chain. After building the connection, users can trade tokens with the Bancor model. You can find detailed information about Bancor in the AElf Economic System White Paper. Implement aelf Standards ACS1. ## Contract Methods diff --git a/docs/docs/smart-contract-api/token-holder-contract/index.md b/docs/docs/smart-contract-api/token-holder-contract/index.md index 07c41ba..558a00a 100644 --- a/docs/docs/smart-contract-api/token-holder-contract/index.md +++ b/docs/docs/smart-contract-api/token-holder-contract/index.md @@ -3,11 +3,9 @@ sidebar_position: 12 title: Token Holder Contract --- -# TokenHolder contract. +# TokenHolder Contract -Used to build a bonus model for distributing bonuses to those who hold the token. - -Implement aelf Standards ACS1. +Used to build a bonus model for distributing bonuses to those who hold the token. Implement aelf Standards ACS1. ## Contract Methods diff --git a/docs/docs/smart-contract-api/treasury-contract/index.md b/docs/docs/smart-contract-api/treasury-contract/index.md index 3d1c4d8..5ecd87e 100644 --- a/docs/docs/smart-contract-api/treasury-contract/index.md +++ b/docs/docs/smart-contract-api/treasury-contract/index.md @@ -3,13 +3,9 @@ sidebar_position: 10 title: Treasury Contract --- -# AElf.Contracts.Treasury +# Treasury Contract -Treasury contract. - -Used for distributing bonuses to voters and candidates during the election process. - -Implement aelf Standards ACS1 and ACS10. +Used for distributing bonuses to voters and candidates during the election process. Implement aelf Standards ACS1 and ACS10. ## Contract Methods diff --git a/docs/docs/smart-contract-api/vote-contract/index.md b/docs/docs/smart-contract-api/vote-contract/index.md index e936139..605b965 100644 --- a/docs/docs/smart-contract-api/vote-contract/index.md +++ b/docs/docs/smart-contract-api/vote-contract/index.md @@ -3,12 +3,8 @@ sidebar_position: 11 title: Vote Contract --- -# Vote contract. - -The Vote contract is an abstract layer for voting. Developers implement -concrete voting activities by calling this contract. - -Implements aelf Standards ACS1. +# Vote Contract +The Vote contract is an abstract layer for voting. Developers implement concrete voting activities by calling this contract. Implements aelf Standards ACS1. ## Contract Methods