diff --git a/docs/cli/commands/index.md b/docs/cli/commands/index.md index 440abf6c..003b92a2 100644 --- a/docs/cli/commands/index.md +++ b/docs/cli/commands/index.md @@ -18,55 +18,4 @@ This section contains Super Protocol CLI commands. [Install and configure SPCTL] | [orders](/cli/commands/orders) | Manage your orders. | | [offers](/cli/commands/offers) | View and manage Marketplace offers. | | [providers](/cli/commands/providers) | View and manage providers. | -| [quotes](/cli/commands/quotes) | Verify the authenticity and integrity of a Trusted Execution Environment. | - -## Command syntax - -The syntax format for commands: - -``` -./spctl -``` - -_Command groups_ contain functionally related commands. Check the complete list of command groups in the [previous section](/cli/commands#command-groups). - -_Commands_ perform a specific function, like placing an order or showing the list of providers. - -For example, the [`tokens`](/cli/commands/tokens) command group includes the following commands: - -- [`balance`](/cli/commands/tokens/balance): Checks the balance. -- [`request`](/cli/commands/tokens/request): Requests testnet tokens. - -_Options_ modify the command behavior and are prefixed by double hyphen `--`; for example, `--help`. Options can be mandatory or optional. - -_Arguments_ provide values for commands and options. Angle brackets `< >` indicate argument placeholders in the command syntax. When executing a command, replace placeholders, including the brackets, with values. For example, replace `` with `12` for [Python Base Image](https://marketplace.superprotocol.com/?offer=offerId%3D12). - -Command syntax may also contain the following special characters: - -- Square brackets `[ ]` indicate optional arguments and options. -- Curly brackets `{ }` indicate a required choice between two or more options or arguments. -- A vertical bar `|` separates mutually exclusive options or arguments you must choose from. -- An ellipsis `...` indicates you may use the preceding option or argument multiple times. - -Never include these special characters in the final command. - -### Example - -The following is a mandatory option `--solution` of the [`workflows create`](/cli/commands/workflows/create) command: - -``` ---solution {,[] | } -``` - -The format `{,[] | }` requires you to choose one of the following: - -- `,[]`: a mandatory argument `` and an optional argument ``, separated by a comma. -- ``: a mandatory argument. - -So, the final format of this option must be one of the following: - -- `--solution `. For example, `--solution 13`. -- `--solution ,`. For example, `--solution 13,15`. -- `--solution `. For example, `--solution ./python-solution.json`. - -Read the descriptions of arguments and options and refer to the examples for more information. If you have any issues or questions, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new). \ No newline at end of file +| [quotes](/cli/commands/quotes) | Verify the authenticity and integrity of a Trusted Execution Environment. | \ No newline at end of file diff --git a/docs/cli/commands/syntax.md b/docs/cli/commands/syntax.md new file mode 100644 index 00000000..f81e14cb --- /dev/null +++ b/docs/cli/commands/syntax.md @@ -0,0 +1,55 @@ +--- +id: "syntax" +title: "Command Syntax" +slug: "/syntax" +sidebar_position: 1 +--- + +Command format: + +``` +./spctl +``` + +_Command groups_ contain functionally related commands. See the [full list of command groups](/cli/commands). + +_Commands_ perform a specific function, like placing an order or showing the list of providers. + +For example, the [`tokens`](/cli/commands/tokens) command group includes the following commands: + +- [`balance`](/cli/commands/tokens/balance): Checks the balance. +- [`request`](/cli/commands/tokens/request): Requests testnet tokens. + +_Options_ modify the command behavior and are prefixed by double hyphen `--`; for example, `--help`. Options can be mandatory or optional. + +_Arguments_ provide values for commands and options. Angle brackets `< >` indicate argument placeholders in the command syntax. When executing a command, replace placeholders, including the brackets, with values. For example, replace `` with `27` for [ComfyUI (GPU)](https://marketplace.superprotocol.com/marketplace?offer=offerId%3D27). + +Command syntax may also contain the following special characters: + +- Square brackets `[ ]` indicate optional arguments and options. +- Curly brackets `{ }` indicate a required choice between two or more options or arguments. +- A vertical bar `|` separates mutually exclusive options or arguments you must choose from. +- An ellipsis `...` indicates you may use the preceding option or argument multiple times. + +Never include these special characters in the final command. + +### Example + +The following is a mandatory option `--solution` of the [`workflows create`](/cli/commands/workflows/create) command: + +``` +--solution {,[] | } +``` + +The format `{,[] | }` requires you to choose one of the following: + +- `,[]`: a mandatory argument `` and an optional argument ``, separated by a comma. +- ``: a mandatory argument. + +So, the final format of this option must be one of the following: + +- `--solution `. For example, `--solution 26`. +- `--solution ,`. For example, `--solution 26,25`. +- `--solution `. For example, `--solution ./tgwui-cpu.resource.json`. + +Read the descriptions of arguments and options and refer to the examples for more information. If you have any issues or questions, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new). \ No newline at end of file diff --git a/docs/cli/index.md b/docs/cli/index.md index 2551403b..b4686dba 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -119,7 +119,7 @@ Providers need another copy of SPCTL configured to manage their offers. Where `0xB9f0b77BDbAe9fBe3E60BdC567E453f503605BAb` is your Authority Account wallet address. - Use the `--config` option with [SPCTL commands](/cli/commands) to manage your provider and orders. For example: + Use the `--config` option with SPCTL commands to use another config file and easily switch between accounts. For example: ``` ./spctl orders list --my-account --type tee --config spctl-config-0xB9f0b77BDbAe9fBe3E60BdC567E453f503605BAa.json diff --git a/docs/hackathon/about.md b/docs/hackathon/about.md index 7a87ec42..181ad43e 100644 --- a/docs/hackathon/about.md +++ b/docs/hackathon/about.md @@ -61,3 +61,14 @@ Sign up for our newsletter and social media on the [Super Hackathon webpage](htt ## Participation eligibility Participation is open globally, except for individuals or entities located in jurisdictions under comprehensive sanctions (U.S., EU, or UK) or listed on their sanctions or export-control lists (including OFAC SDN, BIS Denied/Entity/Unverified, EU Consolidated, and UK OFSI/UK Sanctions Lists), or owned or controlled by such parties. + +## Technical links + +GitHub: + +- [Chainlink Oracle](https://github.com/Super-Protocol/chainlink) +- [Chainlink Camp Contracts](https://github.com/Super-Protocol/chainlink-camp-contracts) + +BNB Blockchain Explorer: + +- [Hackathon smart contract](https://opbnb.bscscan.com/address/0x1e29a39c8ddc364041d30f3b1da09ccfc2cddd57) \ No newline at end of file diff --git a/docs/hackathon/data-feeds.md b/docs/hackathon/data-feeds.md index b1b24069..8a4b73b5 100644 --- a/docs/hackathon/data-feeds.md +++ b/docs/hackathon/data-feeds.md @@ -1,12 +1,10 @@ --- id: "data-feeds" -title: "Confidential Data Feeds" +title: "Confidential data feeds" slug: "/data-feeds" sidebar_position: 3 --- -Below is the current list of confidential data feeds. - This list was last updated on October 10, 2025. More feeds are coming soon. | **Pair** | **Proxy contract** | diff --git a/docs/hackathon/images/liquity-eligibility.png b/docs/hackathon/images/liquity-eligibility.png new file mode 100644 index 00000000..72d0a3bf Binary files /dev/null and b/docs/hackathon/images/liquity-eligibility.png differ diff --git a/docs/hackathon/images/venus-eligibility.png b/docs/hackathon/images/venus-eligibility.png new file mode 100644 index 00000000..fe944ef5 Binary files /dev/null and b/docs/hackathon/images/venus-eligibility.png differ diff --git a/docs/hackathon/liquity.md b/docs/hackathon/liquity.md index c9ea70de..d51815a9 100644 --- a/docs/hackathon/liquity.md +++ b/docs/hackathon/liquity.md @@ -17,12 +17,28 @@ This guide is based on the original [Liquity V2 Development & Deployment Guide]( - Foundry toolchain - BNB for gas on opBNB +## 0. Check the project eligibility + +Open the project's [GitHub page](https://github.com/liquity/bold) and search for the following methods: + +- `latestAnswer` +- `getAnswer` +- `latestRound` +- `getRoundData` +- `latestRoundData` + + +
+
+ +Since the method is called from a smart contract (.sol file), the dApp is eligible. If they were called from the frontend (.ts, .js, .tsx, or .jsx files), the dApp would be unsuitable for the Super Hackathon. + ## 1. Clone the repository Clone the [Liquity V2 (BOLD) repository](https://github.com/liquity/bold): ```bash -git clone git@github.com:liquity/bold.git +git clone https://github.com/liquity/bold.git ``` ## 2. Install dependencies diff --git a/docs/hackathon/rules.md b/docs/hackathon/rules.md index f45cc179..c0fd3ef1 100644 --- a/docs/hackathon/rules.md +++ b/docs/hackathon/rules.md @@ -7,9 +7,11 @@ sidebar_position: 2 ## Choosing a dApp for migration +One way to find eligible dApps is to use the [Chainlink Ecosystem search tool](https://www.chainlinkecosystem.com/ecosystem) and filter by Ethereum, Polygon, and BNB Chain, selecting projects that use Chainlink Data Feeds. + ### Eligibility requirements -The original dApp must already use Chainlink Data Feeds in its on-chain logic. See the [list of supported data feeds](/hackathon/data-feeds). +The original dApp must use Chainlink Data Feeds in its on-chain logic. See the [list of supported data feeds](/hackathon/data-feeds). The interface methods (`latestAnswer`, `getAnswer`, `latestRound`, `getRoundData`, `latestRoundData`) must be called from a smart contract (.sol file). If they are called from the frontend (.ts, .js, .tsx, or .jsx files), the dApp will not be accepted. @@ -25,10 +27,6 @@ Frontends are welcome but optional—evaluation is based solely on the deployed The project’s license must allow forking and reuse (acceptable licenses include MIT, Apache 2.0, GPL-family, or equivalent). -### Recommendations - -One way to find eligible dApps is to use the [Chainlink Ecosystem search tool](https://www.chainlinkecosystem.com/ecosystem) and filter by Ethereum, Polygon, and BNB Chain, selecting projects that use Chainlink Data Feeds. - ## Deploying to opBNB All projects must be migrated to opBNB no earlier than the official hackathon start on October 13, 2025, at 11:00 UTC and no later than October 31, 2025, at 11:00 UTC. diff --git a/docs/hackathon/venus-protocol.md b/docs/hackathon/venus-protocol.md index a610a688..d4f828a7 100644 --- a/docs/hackathon/venus-protocol.md +++ b/docs/hackathon/venus-protocol.md @@ -16,12 +16,28 @@ This example demonstrates a complete migration workflow, from repository setup a - Node.js ≥20 - BNB for gas on opBNB +## 0. Check the project eligibility + +Open the project's [GitHub page](https://github.com/VenusProtocol) and search for the following methods: + +- `latestAnswer` +- `getAnswer` +- `latestRound` +- `getRoundData` +- `latestRoundData` + + +
+
+ +Since the method is called from a smart contract (.sol file), the dApp is eligible. If they were called from the frontend (.ts, .js, .tsx, or .jsx files), the dApp would be unsuitable for the Super Hackathon. + ## 1. Clone the repository -Clone the [Venus Protocol oracle repository](https://github.com/VenusProtocol/oracle): +Clone the [VenusProtocol/oracle repository](https://github.com/VenusProtocol/oracle): ```bash -git clone git@github.com:VenusProtocol/oracle.git +git clone https://github.com/VenusProtocol/oracle.git ``` ## 2. Install dependencies @@ -127,11 +143,11 @@ For example, [opbnb.bscscan.com/address/0x6DA2Fe3A44dc2837e1ffc450339Ae107AE1AC2 To complete the migration, you’ll need both the original and new contract addresses. -### 10.1. Locate the original deployment +### 12.1. Locate the original deployment In the cloned repository, open `oracle/deployments/ethereum/ChainlinkOracle_Implementation.json`. Inside, find the original Chainlink Oracle address, for example: `0x36EFe8716fa2ff9f59D528d154D89054581866A5`. -### 10.2. Submit the project +### 12.2. Submit the project Go to the [Super Hackathon webpage](https://hackathon.superprotocol.com/) and fill out the submission form: