Skip to content

Commit 2d4a124

Browse files
authored
Merge branch 'main' into permissioned-signer
2 parents f61fa39 + 9c97f77 commit 2d4a124

File tree

101 files changed

+4705
-4810
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+4705
-4810
lines changed

.github/workflows/link-check.yml

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ jobs:
4747
--exclude '.*%7BmenuImage%7D.*'
4848
--exclude '.*imageUrl.*'
4949
--exclude '^(file:|[./]).*\/network\/faucet.mdx$'
50+
--exclude '^https://x\.com/.*'
5051
--accept '403,401,429'
5152
--retry-wait-time 1
5253
--max-retries 2

README.md

+3-15
Original file line numberDiff line numberDiff line change
@@ -64,30 +64,18 @@ pnpm install
6464

6565
Ensure you have configured your `.env` properly under `apps/nextra/.env`. There is a `.env.example` there that you can duplicate and rename to `.env` for simplicity.
6666

67-
To ensure you have the right setup, you can run:
68-
69-
```sh
70-
pnpm prebuild
71-
```
72-
7367
2. Build Nextra
7468

7569
```bash
76-
npx turbo run build --filter={apps/nextra}...
70+
pnpm run build
7771
```
7872

7973
This will build `apps/nextra` and all local packages it depends on.
8074

81-
3. Navigate to the correct subdirectory
82-
83-
```sh
84-
cd apps/nextra
85-
```
86-
87-
4. Run the development server
75+
3. Run the development server
8876

8977
```sh
90-
pnpm dev
78+
pnpm run dev
9179
```
9280

9381
## Debugging

apps/nextra/next.config.mjs

+24-4
Original file line numberDiff line numberDiff line change
@@ -1090,22 +1090,42 @@ export default withBundleAnalyzer(
10901090
},
10911091
{
10921092
source: "/tutorials/build-e2e-dapp/add-wallet-support",
1093-
destination: "/en/build/guides/build-e2e-dapp/3-add-wallet-support",
1093+
destination: "/en/build/guides/build-e2e-dapp/2-set-up-react-app",
1094+
permanent: true,
1095+
},
1096+
{
1097+
source: "/tutorials/build-e2e-dapp/3-add-wallet-support",
1098+
destination: "/en/build/guides/build-e2e-dapp/2-set-up-react-app",
10941099
permanent: true,
10951100
},
10961101
{
10971102
source: "/tutorials/build-e2e-dapp/fetch-data-from-chain",
1098-
destination: "/en/build/guides/build-e2e-dapp/4-fetch-data-from-chain",
1103+
destination: "/en/build/guides/build-e2e-dapp/3-fetch-data-from-chain",
1104+
permanent: true,
1105+
},
1106+
{
1107+
source: "/tutorials/build-e2e-dapp/4-fetch-data-from-chain",
1108+
destination: "/en/build/guides/build-e2e-dapp/3-fetch-data-from-chain",
10991109
permanent: true,
11001110
},
11011111
{
11021112
source: "/tutorials/build-e2e-dapp/submit-data-to-chain",
1103-
destination: "/en/build/guides/build-e2e-dapp/5-submit-data-to-chain",
1113+
destination: "/en/build/guides/build-e2e-dapp/4-submit-data-to-chain",
1114+
permanent: true,
1115+
},
1116+
{
1117+
source: "/tutorials/build-e2e-dapp/5-submit-data-to-chain",
1118+
destination: "/en/build/guides/build-e2e-dapp/4-submit-data-to-chain",
11041119
permanent: true,
11051120
},
11061121
{
11071122
source: "/tutorials/build-e2e-dapp/handle-tasks",
1108-
destination: "/en/build/guides/build-e2e-dapp/6-handle-tasks",
1123+
destination: "/en/build/guides/build-e2e-dapp/5-handle-tasks",
1124+
permanent: true,
1125+
},
1126+
{
1127+
source: "/tutorials/build-e2e-dapp/6-handle-tasks",
1128+
destination: "/en/build/guides/build-e2e-dapp/5-handle-tasks",
11091129
permanent: true,
11101130
},
11111131
{

apps/nextra/pages/en/build/cli/running-a-local-network.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ called \`Result::unwrap()\` on an \`Err\` value: Os { code: 24, kind: Uncategori
9696
This means there were too many open files on your system. On many Unix systems you can increase the maximum number of open files by adding something like this to your `.zshrc`:
9797
9898
```bash filename="Terminal"
99-
ulimit -n 32768
99+
ulimit -n 1048576
100100
```
101101
102102
### Docker is not available

apps/nextra/pages/en/build/guides/aptos-keyless/federated-keyless/_meta.tsx

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ export default {
55
"integration-guide": {
66
title: "Integration Guide",
77
},
8+
"simple-example": {
9+
title: "Simple Example",
10+
},
811
other: {
912
title: "FAQs",
1013
},

apps/nextra/pages/en/build/guides/aptos-keyless/federated-keyless/other.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ title: "FAQ"
66

77
**What if I stop using my IAM for my application? What if I switch IAM providers?**
88

9-
- An account address depends on values of several variables that are specific to an IAM service, including `aud` (client ID) and `iss` (issuer). If these values are changed, then a different address will be derived.
10-
- If you want to switch IAM providers, you will need to develop an account migration flow, resulting in a key rotation from the account derived from the prior IAM provider to the account derived from the new IAM provider.
11-
- We recommend allowing your users to add a secondary authentication method to their accounts (e.g., back-up private key) so that they can maintain access should the authentication path into their account via Federated Keyless be disrupted via a service provider change. In order to implement this, you need to do a key rotation to a multikey account. For relevant documentation see [key rotation](https://aptos.dev/en/build/guides/key-rotation) and [multikey SDK](https://aptos-labs.github.io/aptos-ts-sdk/@aptos-labs/ts-sdk-1.29.1/classes/MultiKeyAccount.html).
9+
- An account address depends on values of several variables that are specific to an IAM service, including `aud` (client ID) and `iss` (issuer). If these values are changed, then a different address will be derived.
10+
- If you want to switch IAM providers, you will need to develop an account migration flow, resulting in a key rotation from the account derived from the prior IAM provider to the account derived from the new IAM provider.
11+
- We recommend allowing your users to add a secondary authentication method to their accounts (e.g., back-up private key) so that they can maintain access should the authentication path into their account via Federated Keyless be disrupted via a service provider change. In order to implement this, you need to do a key rotation to a multikey account. For relevant documentation see [key rotation](https://aptos.dev/en/build/guides/key-rotation) and [multikey SDK](https://aptos-labs.github.io/aptos-ts-sdk/@aptos-labs/ts-sdk-1.35.0/classes/MultiKeyAccount.html).
1212

1313
**Does using an IAM cost money?**
1414

@@ -20,4 +20,4 @@ title: "FAQ"
2020

2121
**I use an open source IAM like Keycloak. Can I use Federated Keyless?**
2222

23-
- Not today. Due to the trust placed in the IAM to have sufficient uptime and security standards, we have limited the accepted IAM set to the currently supported issuers. If you believe your provider should be included for consideration, please consider raising an AIP or contact us in the Keyless developers [telegram](https://t.me/+h5CN-W35yUFiYzkx).
23+
- Not today. Due to the trust placed in the IAM to have sufficient uptime and security standards, we have limited the accepted IAM set to the currently supported issuers. If you believe your provider should be included for consideration, please consider raising an AIP or contact us in the Keyless developers [telegram](https://t.me/+h5CN-W35yUFiYzkx).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "Federated Keyless Simple Example"
3+
---
4+
5+
# Federated Keyless Simple Example
6+
7+
The Federated Keyless Example shows how to set up a Federated Keyless account using Auth0 as the IAM provider.
8+
9+
Explore the code in [aptos-keyless-example repository](https://github.com/aptos-labs/aptos-keyless-example/tree/main/examples/federated-keyless-example/).
10+
11+
The Keyless Simple Example is currently undergoing maintenance. Please check back later.

apps/nextra/pages/en/build/guides/aptos-keyless/oidc-support.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Aptos Keyless supports the following IdPs and IAM providers on our network(s). S
1414
| Apple | No | Live | Live | Live |
1515
| Auth0 | Yes | Live | Live | Live |
1616
| Cognito | Yes | Live | Live | Live |
17-
| Firebase | Yes | In review | - | - |
1817
| Microsoft | No | In review | - | - |
1918
| Github | No | In review | - | - |
2019
| Facebook | No | In review | - | - |

apps/nextra/pages/en/build/guides/aptos-keyless/simple-example.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ title: "Keyless Simple Example"
44

55
# Keyless Simple Example
66

7-
Explore the code in [aptos-keyless-example repository](https://github.com/aptos-labs/aptos-keyless-example/).
7+
Explore the code in [aptos-keyless-example repository](https://github.com/aptos-labs/aptos-keyless-example/tree/main/examples/keyless-example/).
88

99
The Keyless Simple Example is currently undergoing maintenance. Please check back later.
1010

11-
This is a live Keyless example on CodeSandbox. Follow the instructions in the `README.md` to add your own Google `client_id`. Explore the code in [aptos-keyless-example repository](https://github.com/aptos-labs/aptos-keyless-example/).
11+
This is a live Keyless example on StackBlitz. Follow the instructions in the `README.md` to add your own Google `client_id`. Explore the code in [aptos-keyless-example repository](https://github.com/aptos-labs/aptos-keyless-example/tree/main/examples/keyless-example/).
1212

1313
<br/>
1414

apps/nextra/pages/en/build/guides/build-e2e-dapp.mdx

+20-17
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,49 @@
22

33
A common way to learn a new framework or programming language is to build a simple todo list. In this tutorial, we will learn how to build an end-to-end todo list dapp, starting from the smart contract side through the front-end side and finally use of a wallet to interact with the two.
44

5-
See the completed code in the [my_first_dapp](https://github.com/aptos-labs/aptos-core/tree/main/aptos-move/move-examples/my_first_dapp).
5+
See the completed code in the [source-code](https://github.com/aptos-labs/developer-docs/tree/main/apps/nextra/pages/en/build/guides/build-e2e-dapp).
66

77
## Chapters
88

99
After meeting the [prerequisites](#prerequisites) and [getting set up](#setup) as described below, you will follow this tutorial in this order:
1010

1111
1. [Create a smart contract](build-e2e-dapp/1-create-smart-contract.mdx)
12-
2. [Set up React app](build-e2e-dapp/2-set-up-react-app.mdx)
13-
3. [Add Wallet support](build-e2e-dapp/3-add-wallet-support.mdx)
14-
4. [Fetch Data from Chain](build-e2e-dapp/4-fetch-data-from-chain.mdx)
15-
5. [Submit data to chain](build-e2e-dapp/5-submit-data-to-chain.mdx)
16-
6. [Handle Tasks](build-e2e-dapp/6-handle-tasks.mdx)
12+
2. [Set up a frontend](build-e2e-dapp/2-set-up-the-frontend.mdx)
13+
3. [Fetch Data from Chain](build-e2e-dapp/3-fetch-data-from-chain.mdx)
14+
4. [Submit data to chain](build-e2e-dapp/4-submit-data-to-chain.mdx)
15+
5. [Handle Tasks](build-e2e-dapp/5-handle-tasks.mdx)
1716

1817
## Prerequisites
1918

2019
You must have:
2120

22-
- [Aptos CLI](../cli.mdx)
23-
- [Aptos TypeScript SDK](../sdks/ts-sdk.mdx)
24-
- [Aptos Wallet Adapter](../sdks/wallet-adapter.mdx)
25-
- [Create React App](https://create-react-app.dev/)
2621
- [node and npm](https://nodejs.org/en/)
2722

2823
Although we will explain some React decisions, we are not going to deep dive into how React works; so we assume you have some previous experience with React.
2924

3025
## Setup
3126

32-
In this section, we will create a `my-first-dapp` directory to hold our project files, both client-side code (React based)and the Move code (our smart contract).
27+
In this section, we will create a `my-first-dapp` directory to hold our project files, both client-side code (React based) and the Move code (our smart contract).
28+
29+
For that, we will be using [create-aptos-dapp](../create-aptos-dapp.mdx) to create the project.
3330

3431
1. Open a terminal and navigate to the desired directory for the project (for example, the `Desktop` directory).
35-
2. Create a new directory called `my-first-dapp`, for example:
32+
2. Run `npx create-aptos-dapp@latest` to create the project.
3633

3734
```bash filename="Terminal"
38-
mkdir my-first-dapp
35+
npx create-aptos-dapp@latest
3936
```
4037

41-
3. Navigate into that directory:
38+
3. Follow the instructions to create the project.
39+
- Choose a name for the project, for example `my-first-dapp`.
40+
- Choose the `Full-stack project` option.
41+
- Choose the `Boilerplate Template` option.
42+
- For simplicity, choose not to use Surf.
43+
- Choose the `Vite app` framework option.
44+
- Choose the `Devnet` network option.
4245

43-
```bash filename="Terminal"
44-
cd my-first-dapp
45-
```
46+
The tool will create the project in a directory with the same name as the project and install the required dependencies.
47+
48+
Follow the `Next Steps` instructions.
4649

4750
Now let's [create a smart contract](build-e2e-dapp/1-create-smart-contract.mdx).

0 commit comments

Comments
 (0)