Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 4 additions & 18 deletions .github/workflows/build-manual.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,7 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Get repo name
run: |
echo "REPO_NAME=$(basename ${{ github.repository }})" >> $GITHUB_ENV

- name: Set up QEMU
uses: docker/setup-qemu-action@v3

- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
uses: actions/checkout@v4

- name: Log in to the Container registry
uses: docker/login-action@v3
Expand All @@ -40,7 +30,7 @@ jobs:

- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@v4
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
Expand All @@ -49,8 +39,7 @@ jobs:
type=ref,event=branch,suffix=-build-${{ github.run_id }}
type=ref,event=tag
type=ref,event=pr
type=raw,value=develop-build-${{ github.run_id }}
type=raw,value=${{ env.REPO_NAME }}-${{ github.ref_name }}-build-${{ github.run_id }}
type=raw,value=build-${{ github.run_id }}
${{ github.ref == 'refs/heads/main' && 'type=raw,value=mainnet' || '' }}
${{ github.ref == 'refs/heads/main' && format('type=raw,value=mainnet-build-{0}', github.run_id) || '' }}

Expand All @@ -61,7 +50,4 @@ jobs:
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
push: ${{ github.event_name != 'pull_request' }}
build-args: |
ENV_FILE=${{ secrets.DEVELOP_ENV_FILE_BASE64 }}
cache-from: type=gha
cache-to: type=gha,mode=max
build-args: NPM_TOKEN=${{ secrets.GITHUB_TOKEN }}
4 changes: 2 additions & 2 deletions .github/workflows/check-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: yarn install
- run: yarn build
- run: npm i
- run: npm run build


6 changes: 0 additions & 6 deletions .gitmodules

This file was deleted.

23 changes: 11 additions & 12 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,20 @@ This is the documentation website for Super Protocol - a confidential cloud and
## Common Commands

### Development
- `yarn` or `yarn install` - Install dependencies
- `yarn start` - Start local development server with live reload
- `yarn build` - Build static site for production
- `yarn serve` - Serve the built site locally
- `yarn clear` - Clear Docusaurus cache
- `npm install` - Install dependencies
- `npm run start` - Start local development server with live reload
- `npm run build` - Build static site for production
- `npm run serve` - Serve the built site locally
- `npm run clear` - Clear Docusaurus cache

### Documentation Generation
- `yarn contracts:gen-docs` - Generate contract documentation from Solidity files
- `yarn write-translations` - Generate translation files
- `yarn write-heading-ids` - Generate heading IDs for documentation
- `npm run write-translations` - Generate translation files
- `npm run write-heading-ids` - Generate heading IDs for documentation

### Other Commands
- `yarn docusaurus <command>` - Direct access to Docusaurus CLI
- `yarn deploy` - Deploy to hosting service
- `yarn swizzle` - Customize Docusaurus components
- `npm run docusaurus <command>` - Direct access to Docusaurus CLI
- `npm run deploy` - Deploy to hosting service
- `npm run swizzle` - Customize Docusaurus components

## Architecture & Structure

Expand Down Expand Up @@ -76,7 +75,7 @@ When working with documentation:

## Build Process

The CI/CD pipeline runs `yarn build` on pull requests to verify the site builds successfully. The build process includes:
The CI/CD pipeline runs `npm run build` on pull requests to verify the site builds successfully. The build process includes:
1. Static site generation from markdown files
2. Processing of mathematical formulas with KaTeX
3. Search index generation
Expand Down
12 changes: 3 additions & 9 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
FROM node:18-buster AS builder
FROM node:22-bookworm-slim AS builder

ARG NPM_TOKEN
WORKDIR /app

RUN apt-get install g++ make python3
RUN wget https://dl.google.com/go/go1.13.linux-amd64.tar.gz && tar -C /usr/local -xzf go1.13.linux-amd64.tar.gz
ENV PATH $PATH:/usr/local/go/bin

COPY . .
RUN npm i -g solidity-docgen@v0.5.16
RUN npm config -g set '//npm.pkg.github.com/:_authToken' ${NPM_TOKEN}
RUN yarn --frozen-lockfile
RUN yarn build
RUN npm ci
RUN npm run build

FROM nginx:alpine
WORKDIR /usr/share/nginx/html
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
### Installation

```
$ yarn
$ npm i
```

### Local Development

```
$ yarn start
$ npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
$ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
12 changes: 4 additions & 8 deletions docs/colab/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,7 @@ Register accounts and set up SPCTL—the Super Protocol CLI tool.
<br/>
<br/>

3. In the Account window, copy your Super Wallet address and share it with your contact in Super Protocol to receive SPPI tokens.

<img src={require('./images/2.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>
3. In the Account window, copy your **Login Wallet** address and share it with your contact in Super Protocol to receive SPPI tokens.

### Set up SPCTL

Expand Down Expand Up @@ -326,9 +322,9 @@ The command will show the order report and save it to the `report.json` file in
"type": "Data",
"size": 12901,
"hash": {
"algo": "sha256",
"hash": "8598805cd2136a4beff17559a7228854f6a8cc0b027856ea5c196fb8d0602501",
"encoding": "hex"
"algo": "sha256",
"hash": "8598805cd2136a4beff17559a7228854f6a8cc0b027856ea5c196fb8d0602501",
"encoding": "hex"
}
},
```
Expand Down
8 changes: 4 additions & 4 deletions docs/colab/gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Log in and get tokens.
<br/>
<br/>

4. In the Account window, copy your Super Wallet address and share it with your contact in Super Protocol to receive SPPI tokens.
4. In the Account window, copy your **Super Wallet** address and share it with your contact in Super Protocol to receive SPPI tokens.

<img src={require('./images/2.png').default} width="auto" height="auto" border="1"/>
<br/>
Expand Down Expand Up @@ -87,9 +87,9 @@ The command shows the order report and saves it to the `report.json` file in the
"type": "Data",
"size": 12901,
"hash": {
"algo": "sha256",
"hash": "8598805cd2136a4beff17559a7228854f6a8cc0b027856ea5c196fb8d0602501",
"encoding": "hex"
"algo": "sha256",
"hash": "8598805cd2136a4beff17559a7228854f6a8cc0b027856ea5c196fb8d0602501",
"encoding": "hex"
}
},
```
Expand Down
131 changes: 131 additions & 0 deletions docs/guides/log-in-trustwallet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
---
id: "log-in-trustwallet"
title: "Log In with Trust Wallet"
slug: "/log-in-trustwallet"
sidebar_position: 2
---

This guide provides step-by-step instructions on how to log in to [Super Protocol Marketplace](https://marketplace.superprotocol.com/) as a Web3 user using Trust Wallet—a popular, free, non-custodial software wallet.

:::important

Super Protocol is not affiliated with Trust Wallet.

:::

## Before you begin

Install the Trust Wallet extension for your browser:

- [Trust Wallet for Chromium](https://chromewebstore.google.com/detail/trust-wallet/egjidjbpglichdcondbcbdnbeeppgdph) (Google Chrome, Microsoft Edge, Opera, Brave)
- [Trust Wallet for Safari](https://apps.apple.com/us/app/trust-crypto-bitcoin-wallet/id1288339409)

## Step 1. Create a new wallet address

Although you can use an existing EVM wallet address, it is recommended that you create a new one specifically for Super Protocol.

1.1. Open Trust Wallet.

<img src={require('../marketplace/images/trust-open.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

1.2. Click your current account name, and then **Add new wallet**.

<img src={require('../marketplace/images/trust-newwallet.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

1.3. Select **Create a new wallet**.

<img src={require('../marketplace/images/trust-newwallet-create.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

1.4. Confirm your Trust Wallet password and click **Next**.

<img src={require('../marketplace/images/trust-newwallet-password.png').default} width="auto" height="auto" border="1"/>
<br/>

## Step 2. Connect the account

2.1. Open the [Marketplace web app](https://marketplace.superprotocol.com/) and press **Enter Marketplace**.

<img src={require('../marketplace/images/enter-marketplace-button.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

2.2. Select **Connect Wallet**.

<img src={require('../marketplace/images/enter-marketplace-connect-wallet.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

2.3 Select **Trust Wallet**.

<img src={require('../marketplace/images/enter-marketplace-trust.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

2.4. In the Trust Wallet window, press **Connect** and then **Confirm** the signature request.

<img src={require('../marketplace/images/trust-connect.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

2.5. If you connect successfully, you will see your account address in the top-right corner of the Marketplace screen.

<img src={require('../marketplace/images/marketplace-web3acc-trust.png').default} width="auto" height="auto" border="1"/>
<br/>

## Step 3. Get tokens

Web3 users need two types of tokens:

- SPPI tokens to pay and receive payments in Super Protocol.
- BNB tokens to pay for opBNB blockchain transactions.

Both types are necessary to place <a id="order"><span className="dashed-underline">orders</span></a>. During the testnet, you can request free tokens in the **Account** setting.

<img src={require('../marketplace/images/marketplace-trust-account-menu.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

There is a limit to the daily amount of tokens you can get. Check the [Testnet Limitations](/marketplace/limitations).

## Step 4. Import SPPI tokens (optional)

To see your SPPI token balance in Trust Wallet, import the token.

4.1. Open Trust Wallet, go to the **Crypto** tab and click **Manage crypto** at the bottom of the list.

<img src={require('../marketplace/images/trust-import-sppi-1.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

4.2. Click **Don't see your crypto? Import**.

<img src={require('../marketplace/images/trust-import-sppi-2.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

4.3. Find **OpBNB** in the list of networks.

<img src={require('../marketplace/images/trust-import-sppi-3.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

4.4. Add the following address: `0xDb8E4557E34256d3E8bBA0f7796Cf633a8F08C27`. Ensure the Super Protocol Incentives Token (SPPI) is found. Click **Add token**.

<img src={require('../marketplace/images/trust-import-sppi-4.png').default} width="auto" height="auto" border="1"/>
<br/>
<br/>

4.5. Check that SPPI has appeared in the **Tokens** tab.

<img src={require('../marketplace/images/trust-import-sppi-5.png').default} width="auto" height="auto" border="1"/>
<br/>

## Contact Super Protocol

If you face any issues, contact Super Protocol on [Discord](https://discord.gg/superprotocol) or via the [contact form](https://superprotocol.zendesk.com/hc/en-us/requests/new).
Loading