Skip to content

Commit 4f8d0de

Browse files
committed
update integration builder structure
1 parent 8691e61 commit 4f8d0de

242 files changed

Lines changed: 480 additions & 6228 deletions

File tree

Some content is hidden

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

src/common/hostedFileLinks.json

Lines changed: 58 additions & 129 deletions
Large diffs are not rendered by default.

src/common/maps.tsx

Lines changed: 22 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,144 +1,37 @@
11
export const quickStartHostedLinks = {
22
// PNP Modal SDK
3-
PNP_MODAL_ANGULAR: "https://w3a.link/pnp-angular-modal-quick-start",
4-
PNP_MODAL_HTML: "https://w3a.link/pnp-vanillajs-modal-quick-start",
5-
PNP_MODAL_NEXTJS: "https://w3a.link/pnp-nextjs-modal-quick-start",
6-
PNP_MODAL_REACT: "https://w3a.link/pnp-react-modal-quick-start",
7-
PNP_MODAL_REACT_HOOKS: "https://w3a.link/pnp-react-hooks-modal-quick-start",
8-
PNP_MODAL_VUE: "https://w3a.link/pnp-vue-modal-quick-start",
9-
PNP_MODAL_VUE_COMPOSABLES: "https://w3a.link/pnp-vue-composables-modal-quick-start",
10-
// PNP No Modal SDK
11-
PNP_NO_MODAL_ANGULAR: "https://w3a.link/pnp-angular-no-modal-quick-start",
12-
PNP_NO_MODAL_NEXTJS: "https://w3a.link/pnp-nextjs-no-modal-quick-start",
13-
PNP_NO_MODAL_REACT: "https://w3a.link/pnp-react-no-modal-quick-start",
14-
PNP_NO_MODAL_REACT_HOOKS: "https://w3a.link/pnp-react-hooks-no-modal-quick-start",
15-
PNP_NO_MODAL_VUE: "https://w3a.link/pnp-vue-no-modal-quick-start",
16-
PNP_NO_MODAL_VUE_COMPOSABLES: "https://w3a.link/pnp-vue-composables-no-modal-quick-start",
17-
PNP_NO_MODAL_HTML: "https://w3a.link/pnp-vanillajs-no-modal-quick-start",
18-
// PNP Android SDK
19-
PNP_ANDROID_ANDROID: "https://w3a.link/pnp-android-quick-start",
20-
// PNP iOS SDK
21-
PNP_IOS_IOS: "https://w3a.link/pnp-ios-quick-start", // https://w3a.link/pnp-ios-quick-start",
22-
// PNP React Native SDK
23-
PNP_REACT_NATIVE_ANDROID: "https://w3a.link/pnp-react-native-android-quick-start",
24-
PNP_REACT_NATIVE_IOS: "https://w3a.link/pnp-react-native-ios-quick-start",
25-
// PNP Flutter SDK
26-
PNP_FLUTTER_ANDROID: "https://w3a.link/pnp-flutter-android-quick-start",
27-
PNP_FLUTTER_IOS: "https://w3a.link/pnp-flutter-ios-quick-start",
28-
// PNP Unity SDK
29-
PNP_UNITY_ANDROID: "https://w3a.link/pnp-unity-android-quick-start",
30-
PNP_UNITY_IOS: "", // "https://w3a.link/pnp-unity-ios-quick-start"
31-
PNP_UNITY_WEBGL: "https://w3a.link/pnp-unity-webgl-quick-start",
32-
// SFA JS SDK
33-
SFA_WEB_ANGULAR: "https://w3a.link/sfa-angular-quick-start",
34-
SFA_WEB_NEXTJS: "https://w3a.link/sfa-nextjs-quick-start",
35-
SFA_WEB_REACT: "https://w3a.link/sfa-react-quick-start",
36-
SFA_WEB_VUE: "https://w3a.link/sfa-vue-quick-start",
37-
SFA_WEB_HTML: "https://w3a.link/sfa-vanillajs-quick-start",
38-
// SFA React Native SDK
39-
SFA_REACT_NATIVE_ANDROID: "https://w3a.link/sfa-react-native-android-quick-start",
40-
SFA_REACT_NATIVE_IOS: "https://w3a.link/sfa-react-native-ios-quick-start",
41-
// SFA Android SDK
42-
SFA_ANDROID_ANDROID: "https://w3a.link/sfa-android-quick-start",
43-
// SFA iOS SDK
44-
SFA_IOS_IOS: "", // "https://w3a.link/sfa-ios-quick-start",
45-
// SFA Flutter SDK
46-
SFA_FLUTTER_ANDROID: "https://w3a.link/sfa-flutter-android-quick-start",
47-
SFA_FLUTTER_IOS: "", //"https://w3a.link/sfa-flutter-ios-quick-start",
48-
// SFA Node SDK
49-
SFA_NODE_NODE: "",
50-
// MPC Core Kit SDK
51-
MPC_CORE_KIT_WEB_ANGULAR: "https://w3a.link/mpc-core-kit-angular-quick-start",
52-
MPC_CORE_KIT_WEB_NEXTJS: "https://w3a.link/mpc-core-kit-nextjs-quick-start",
53-
MPC_CORE_KIT_WEB_REACT: "https://w3a.link/mpc-core-kit-react-quick-start",
54-
MPC_CORE_KIT_WEB_VUE: "https://w3a.link/mpc-core-kit-vue-quick-start",
55-
MPC_CORE_KIT_REACT_NATIVE_IOS: "",
56-
MPC_CORE_KIT_REACT_NATIVE_ANDROID: "https://w3a.link/mpc-core-kit-rn-quick-start",
57-
MPC_CORE_KIT_NODE_NODE: "",
3+
ANGULAR: "https://w3a.link/pnp-angular-modal-quick-start",
4+
HTML: "https://w3a.link/pnp-vanillajs-modal-quick-start",
5+
NEXTJS: "https://w3a.link/pnp-nextjs-modal-quick-start",
6+
REACT: "https://w3a.link/pnp-react-modal-quick-start",
7+
VUE: "https://w3a.link/pnp-vue-modal-quick-start",
8+
ANDROID: "https://w3a.link/pnp-android-quick-start",
9+
IOS: "https://w3a.link/pnp-ios-quick-start", // https://w3a.link/pnp-ios-quick-start",
10+
REACT_NATIVE: "https://w3a.link/pnp-react-native-android-quick-start",
11+
FLUTTER: "https://w3a.link/pnp-flutter-android-quick-start",
12+
UNITY: "https://w3a.link/pnp-unity-android-quick-start",
5813
};
5914

6015
export const quickStartSourceCode = {
61-
// PNP Modal SDK
62-
PNP_MODAL_REACT:
16+
REACT:
6317
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-modal-sdk/quick-starts/react-modal-quick-start",
64-
PNP_MODAL_ANGULAR:
18+
ANGULAR:
6519
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-modal-sdk/quick-starts/angular-modal-quick-start",
66-
PNP_MODAL_VUE:
67-
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-modal-sdk/quick-starts/vue-modal-quick-start",
68-
PNP_MODAL_NEXTJS:
20+
VUE: "https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-modal-sdk/quick-starts/vue-modal-quick-start",
21+
NEXTJS:
6922
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-modal-sdk/quick-starts/nextjs-modal-quick-start",
70-
PNP_MODAL_NUXTJS:
23+
NUXTJS:
7124
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-modal-sdk/quick-starts/nuxt-modal-quick-start",
72-
PNP_MODAL_HTML:
73-
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-modal-sdk/quick-starts/vanillajs-modal-quick-start",
74-
// PNP No Modal SDK
75-
76-
PNP_NO_MODAL_REACT:
77-
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/quick-starts/react-no-modal-quick-start",
78-
PNP_NO_MODAL_ANGULAR:
79-
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/quick-starts/angular-no-modal-quick-start",
80-
PNP_NO_MODAL_VUE:
81-
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/quick-starts/vue-no-modal-quick-start",
82-
PNP_NO_MODAL_NEXTJS:
83-
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/quick-starts/nextjs-no-modal-quick-start",
84-
PNP_NO_MODAL_NUXTJS:
85-
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/quick-starts/nuxt-no-modal-quick-start",
86-
PNP_NO_MODAL_HTML:
87-
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-no-modal-sdk/quick-starts/vanillajs-no-modal-quick-start",
88-
// PNP Android SDK
89-
PNP_ANDROID:
25+
HTML: "https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/web-modal-sdk/quick-starts/vanillajs-modal-quick-start",
26+
ANDROID:
9027
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/android/android-quick-start",
91-
// PNP iOS SDK
92-
PNP_IOS: "https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/ios/ios-quick-start",
93-
// PNP React Native SDK
94-
PNP_REACT_NATIVE:
28+
IOS: "https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/ios/ios-quick-start",
29+
REACT_NATIVE:
9530
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/react-native/rn-bare-quick-start",
96-
// PNP Flutter SDK
97-
PNP_FLUTTER:
31+
FLUTTER:
9832
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/flutter/flutter-quick-start",
99-
// PNP Unity SDK
100-
PNP_UNITY: "https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/unity/unity-quick-start",
101-
// PNP Unity SDK
102-
PNP_UNREAL: "https://github.com/Web3Auth/web3auth-unreal-example/tree/master",
103-
// SFA JS SDK
104-
SFA_WEB_REACT:
105-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-web/quick-starts/sfa-react-quick-start",
106-
SFA_WEB_ANGULAR:
107-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-web/quick-starts/sfa-angular-quick-start",
108-
SFA_WEB_VUE:
109-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-web/quick-starts/sfa-vue-quick-start",
110-
SFA_WEB_NEXTJS:
111-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-web/quick-starts/sfa-nextjs-quick-start",
112-
SFA_WEB_HTML:
113-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-web/quick-starts/sfa-vanillajs-quick-start",
114-
// SFA React Native SDK
115-
SFA_REACT_NATIVE:
116-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-react-native/sfa-rn-bare-quick-start",
117-
// SFA Android SDK
118-
SFA_ANDROID:
119-
"https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/android/android-quick-start",
120-
// SFA iOS SDK
121-
SFA_IOS:
122-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-ios/sfa-ios-quick-start",
123-
// SFA Flutter SDK
124-
SFA_FLUTTER:
125-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-flutter/sfa_flutter_quick_start",
126-
// SFA Node SDK
127-
SFA_NODE:
128-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-node/sfa-node-quick-start",
129-
// MPC Core Kit SDK
130-
MPC_CORE_KIT_WEB_REACT:
131-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit-web/quick-starts/mpc-core-kit-react-quick-start",
132-
MPC_CORE_KIT_WEB_ANGULAR:
133-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit-web/quick-starts/mpc-core-kit-angular-quick-start",
134-
MPC_CORE_KIT_WEB_VUE:
135-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit-web/quick-starts/mpc-core-kit-vue-quick-start",
136-
MPC_CORE_KIT_WEB_NEXTJS:
137-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit-web/quick-starts/mpc-core-kit-nextjs-quick-start",
138-
MPC_CORE_KIT_REACT_NATIVE:
139-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit-react-native/mpc-core-kit-rn-quick-start",
140-
MPC_CORE_KIT_NODE:
141-
"https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit-node/mpc-core-kit-node-quick-start",
33+
UNITY: "https://github.com/Web3Auth/web3auth-pnp-examples/tree/main/unity/unity-quick-start",
34+
UNREAL: "https://github.com/Web3Auth/web3auth-unreal-example/tree/master",
14235
};
14336

14437
export interface GuidesInterface {

src/pages/quick-start/builder/pnp/android/index.ts renamed to src/pages/quick-start/builder/android/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import hostedFileLinks from "../../../../../common/hostedFileLinks.json";
2-
import { ReplaceFileAggregator } from "../../../utils";
1+
import hostedFileLinks from "../../../../common/hostedFileLinks.json";
2+
import { ReplaceFileAggregator } from "../../utils";
33
import getSteps from "./steps";
44

55
const framework = {

src/pages/quick-start/builder/pnp/android/stepContent/androidQuickStart.mdx renamed to src/pages/quick-start/builder/android/stepContent/androidQuickStart.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
title: Web3Auth PnP Android Quick Start
33
---
44

5-
This guide is designed to help you quickly integrate a basic instance of Web3Auth Plug and Play in your Android app.
5+
This guide is designed to help you quickly integrate a basic instance of Web3Auth Plug and Play in
6+
your Android app.
67

7-
If you face any problem anytime, you can always find help in the [Web3Auth Community](https://web3auth.io/community/c/help-pnp/pnp-android/16).
8+
If you face any problem anytime, you can always find help in the
9+
[Web3Auth Community](https://web3auth.io/community/c/help-pnp/pnp-android/16).
810

911
:::tip building locally
1012

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Making Blockchain Calls
3+
---
4+
5+
While using the Web3Auth Android SDK, you get the private key and sessionId within the user scope.
6+
This private key can interact with [Ethereum](https://ethereum.org/) to make any blockchain calls,
7+
like getting user's `account`, fetch `balance`, `sign transaction`, `send transaction`, `read` from
8+
and `write` to the smart contract, etc. We have added a basic EVM chain based example here for your
9+
reference.
10+
11+
:::info Connect any Blockchain
12+
13+
Refer to the [Blockchain Documentation](/connect-blockchain/) to know more about how to make calls
14+
on any blockchain.
15+
16+
:::

src/pages/quick-start/builder/pnp/android/stepContent/configureDeepLink.mdx renamed to src/pages/quick-start/builder/android/stepContent/configureDeepLink.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: Configure Deep Link & Whitelist
33
---
44

5-
Open your app's `AndroidManifest.xml` file and add the following deep link intent filter to your sign-in activity:
5+
Open your app's `AndroidManifest.xml` file and add the following deep link intent filter to your
6+
sign-in activity:
67

78
```xml
89
<intent-filter>
@@ -18,7 +19,8 @@ Open your app's `AndroidManifest.xml` file and add the following deep link inten
1819

1920
:::info Whitelist your app
2021

21-
In order to whitelist your App, you'll need to create a project in the [Developer Dashboard](https://dashboard.web3auth.io).
22+
In order to whitelist your App, you'll need to create a project in the
23+
[Developer Dashboard](https://dashboard.web3auth.io).
2224

2325
- Go to [Developer Dashboard](https://dashboard.web3auth.io/), select your Web3Auth project.
2426

src/pages/quick-start/builder/pnp/android/stepContent/enableInternetUsage.mdx renamed to src/pages/quick-start/builder/android/stepContent/enableInternetUsage.mdx

File renamed without changes.

src/pages/quick-start/builder/pnp/android/stepContent/index.ts renamed to src/pages/quick-start/builder/android/stepContent/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import * as getUserInfo from "../../../../commonSteps/getUserInfo.mdx";
2-
import * as registerApp from "../../../../commonSteps/registerApp.mdx";
3-
import { toSteps } from "../../../../utils";
1+
import * as getUserInfo from "../../../commonSteps/getUserInfo.mdx";
2+
import * as registerApp from "../../../commonSteps/registerApp.mdx";
3+
import { toSteps } from "../../../utils";
44
import * as blockchainCalls from "./blockchainCalls.mdx";
55
import * as jitpack from "./jitpack.mdx";
66
import * as installation from "./installation.mdx";

src/pages/quick-start/builder/pnp/android/stepContent/initialize.mdx renamed to src/pages/quick-start/builder/android/stepContent/initialize.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ title: Create and initialize the Web3Auth instance
44

55
Let's now create an instance of the `Web3Auth`.
66

7-
We need `clientId` and `network` to initialize the Web3Auth class. You can get your `clientId` from registering (above), whereas `network` signifies
8-
the type of network(`SAPPHIRE_MAINNET` or `SAPPHIRE_DEVNET`) you want to initialize web3auth with.
7+
We need `clientId` and `network` to initialize the Web3Auth class. You can get your `clientId` from
8+
registering (above), whereas `network` signifies the type of network(`SAPPHIRE_MAINNET` or
9+
`SAPPHIRE_DEVNET`) you want to initialize web3auth with.
910

10-
Now, let's create an instance of the `Web3Auth` class. It can be initialized on-demand when the user interactions are input (like button click) or
11-
when the screen is initialized.
11+
Now, let's create an instance of the `Web3Auth` class. It can be initialized on-demand when the user
12+
interactions are input (like button click) or when the screen is initialized.
1213

1314
:::info sdk reference
1415

src/pages/quick-start/builder/pnp/android/stepContent/installation.mdx renamed to src/pages/quick-start/builder/android/stepContent/installation.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
title: Installation
33
---
44

5-
Add Web3Auth's Android SDK to the dependency list. In your app-level `build.gradle` dependencies section, add the latest
6-
`com.github.Web3Auth:web3auth-android-sdk`.
5+
Add Web3Auth's Android SDK to the dependency list. In your app-level `build.gradle` dependencies
6+
section, add the latest `com.github.Web3Auth:web3auth-android-sdk`.
77

88
:::warning Update to the Latest-SDK
99

10-
Please use the **[latest version](https://github.com/Web3Auth/web3auth-android-sdk/releases)** of Web3Auth's Android SDK.
10+
Please use the **[latest version](https://github.com/Web3Auth/web3auth-android-sdk/releases)** of
11+
Web3Auth's Android SDK.
1112

1213
:::

0 commit comments

Comments
 (0)