diff --git a/docs/tools/oracle/index.md b/docs/tools/oracle/index.md index 8c4e70a8..0e375ddf 100644 --- a/docs/tools/oracle/index.md +++ b/docs/tools/oracle/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -title: Oracle +title: Introduction description: Transfer tamper-proof data from off-chain to on-chain --- @@ -22,3 +22,4 @@ The go-to place for developers who want to learn how to build applications using ## 3. What's Next? You have now understood the basic functions of Oracle. Next, you can choose the appropriate Oracle product based on your scenario to make your DApp contract more secure and efficient. + diff --git a/docs/tools/oracle/quick-start/automation/index.md b/docs/tools/oracle/quick-start/automation/index.md index dee0430d..43efdc89 100644 --- a/docs/tools/oracle/quick-start/automation/index.md +++ b/docs/tools/oracle/quick-start/automation/index.md @@ -2,6 +2,8 @@ sidebar_position: 3 --- +# Automation + AetherLink Automation allows developers to automate smart contract functions by triggering actions based on specific events or conditions. This reduces the need for manual intervention and ensures contracts execute efficiently and reliably when certain criteria are met. ## 1. Preparation diff --git a/docs/tools/oracle/quick-start/data-feeds/index.md b/docs/tools/oracle/quick-start/data-feeds/index.md index d5d4c367..7244269d 100644 --- a/docs/tools/oracle/quick-start/data-feeds/index.md +++ b/docs/tools/oracle/quick-start/data-feeds/index.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 1 +--- + # DataFeeds AetherLink Datafeeds provide decentralized, real-time data from multiple sources, enabling smart contracts to access highly reliable and accurate off-chain information, such as asset prices, for secure decision-making in decentralized applications. diff --git a/docs/tools/oracle/quick-start/index.md b/docs/tools/oracle/quick-start/index.md new file mode 100644 index 00000000..9cda9c55 --- /dev/null +++ b/docs/tools/oracle/quick-start/index.md @@ -0,0 +1,34 @@ +# Quick Start + +## Requirements + +This guide assumes that you have basic knowledge about writing and deploying smart contracts. If you are new to smart contract development, learn how to [Deploy Your First Smart Contract](/quick-start/developers/hello-world-contract/) before you begin. + +## Preparation + +### Apply Subscription ID + +Before initiating a task to the oracle, you need to contact [AetherLink](https://t.me/TheAetherLink) to apply for a subscription number for your task. Later, you can manage the service fee based on this subscription ID. Remember that you only have the right to use your own subscription ID. + +### Oracle Address + +Below are the oracle contract addresses in different environments: + +| ENV | CHAINID | ADDRESS | +| ------- | ------- | ---------------------------------------------------- | +| MainNet | AELF | `BGhrBNTPcLccaxPv6hHJrn4CHHzeMovTsrkhFse5o2nwfvQyG` | +| MainNet | tDVV | `BGhrBNTPcLccaxPv6hHJrn4CHHzeMovTsrkhFse5o2nwfvQyG` | +| TestNet | AELF | `21Fh7yog1B741yioZhNAFbs3byJ97jvBmbGAPPZKZpHHog5aEg` | +| TestNet | tDVW | `21Fh7yog1B741yioZhNAFbs3byJ97jvBmbGAPPZKZpHHog5aEg` | + +How to use the oracle contract address. Please reference the picture below in the complete code. You can also dynamically configure it through other configurations. + +![Oracle Contract Address](oracle-contract-address.png) + +## Next Steps + +🚀 Congratulations on completing the preparations for integrating the oracle. We currently support 3 oracle scenarios, and you can navigate to the corresponding page based on your requirements. + +1. **Datafeeds**: AetherLink Datafeeds provide decentralized, real-time data from multiple sources, enabling smart contracts to access highly reliable and accurate off-chain information, such as asset prices, for secure decision-making in decentralized applications. +2. **VRF (Verifiable Random Function)**: AetherLink VRF delivers provably fair and verifiable random numbers, ensuring the randomness used in smart contracts is tamper-proof and transparent. This is particularly useful for gaming, lotteries, and any application that requires trusted randomness. +3. **Automation**: AetherLink Automation allows developers to automate smart contract functions by triggering actions based on specific events or conditions. This reduces the need for manual intervention and ensures contracts execute efficiently and reliably when certain criteria are met. diff --git a/docs/tools/oracle/quick-start/oracle-contract-address.png b/docs/tools/oracle/quick-start/oracle-contract-address.png new file mode 100644 index 00000000..f4e0d6ca Binary files /dev/null and b/docs/tools/oracle/quick-start/oracle-contract-address.png differ diff --git a/docs/tools/oracle/quick-start/vrf/index.md b/docs/tools/oracle/quick-start/vrf/index.md index 04064dd6..f75e1872 100644 --- a/docs/tools/oracle/quick-start/vrf/index.md +++ b/docs/tools/oracle/quick-start/vrf/index.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # VRF AetherLink VRF delivers provably fair and verifiable random numbers, ensuring the randomness used in smart contracts is tamper-proof and transparent. This is particularly useful for gaming, lotteries, and any application that requires trusted randomness. diff --git a/sidebars.ts b/sidebars.ts index 0a556b94..1f6874ba 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -59,9 +59,20 @@ const sidebars: SidebarsConfig = { }, items: [ { type: "doc", id: "tools/aelf-playground/index" }, - { type: "link", label: "Wallet", href: "https://portkey.finance/", description: "Integrate your dApp with Portkey wallet" }, + { + type: "link", + label: "Wallet", + href: "https://portkey.finance/", + description: "Integrate your dApp with Portkey wallet", + }, { type: "doc", id: "tools/faucet/index" }, - { type: "doc", id: "tools/oracle/index" }, + { + type: "category", + label: "Oracle", + link: { type: "doc", id: "tools/oracle/index" }, + customProps: { description: "Oracle is" }, + items: [{ type: "autogenerated", dirName: "tools/oracle" }], + }, { type: "link", label: "Indexer",