Skip to content

Commit 815d4d3

Browse files
Edit all builder quickstarts (#2849)
1 parent e6949f6 commit 815d4d3

96 files changed

Lines changed: 428 additions & 424 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/pages/quickstart/builder/choices.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,6 @@ export const TOGGLE: DisplayChoice[] = [
6262
]
6363

6464
export const WALLET_AGGREGATOR_TOGGLE: DisplayChoice[] = [
65-
{ key: NO, displayName: 'Social Logins' },
65+
{ key: NO, displayName: 'Social Sign-in' },
6666
{ key: YES, displayName: 'Wallet Aggregator' },
6767
]
Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,11 @@
11
### MetaMask Embedded Wallets Android quickstart
22

3-
This quickstart is designed to help you quickly integrate MetaMask Embedded Wallet SDKs in your
4-
Android app.
3+
This quickstart shows you how to add social sign-in and wallet connection functionality to your Android application,
4+
using the MetaMask Embedded Wallets SDK (Web3Auth).
55

6-
If you need help, visit the [Web3Auth community](https://web3auth.io/community/c/help-pnp/pnp-android/16).
6+
Clone the Android quickstart application to follow along with a complete example.
7+
You can run the example in Android Studio.
78

8-
:::tip build locally
9-
10-
To build the project locally:
11-
12-
- Clone the MetaMask Embedded Wallets Android quickstart application.
13-
14-
```shell npm2yarn
15-
npx degit Web3Auth/web3auth-android-examples/android-quick-start w3a-android-quick-start
16-
```
17-
18-
- Change to the quickstart directory and run the project in Android Studio.
19-
20-
```shell npm2yarn
21-
cd w3a-android-quick-start
22-
```
23-
24-
:::
9+
```bash
10+
npx degit Web3Auth/web3auth-android-examples/android-quick-start w3a-android-quick-start
11+
```

src/pages/quickstart/builder/embedded-wallets/android/stepContent/blockchainCalls.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22

33
After the user signs in, the SDK provides a user-scoped private key and session ID.
44

5-
Use the private key to interact with chains such as [Ethereum](https://ethereum.org/) to make
6-
blockchain calls, like fetching a user's account balance, signing or sending
7-
transactions, and reading or writing to smart contracts.
5+
Use the private key to make blockchain calls, like fetching a user's account balance,
6+
signing or sending transactions, and reading or writing to smart contracts.
87

9-
This quickstart includes a basic EVM-based example for your reference.
8+
This quickstart makes calls to Ethereum as an example.
109

11-
:::info Connect any Blockchain
10+
:::tip Connect any blockchain
1211

13-
Refer to the [blockchain documentation](/embedded-wallets/connect-blockchain/) to learn more about making calls on
14-
any supported blockchain.
12+
See the [Embedded Wallets documentation](/embedded-wallets/connect-blockchain)
13+
to learn more about making calls on any supported blockchain.
1514

1615
:::

src/pages/quickstart/builder/embedded-wallets/android/stepContent/configureDeepLink.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Configure your deeplink and allowlist
22

3-
Open your app's `AndroidManifest.xml` file and add the following deeplink intent filter to your
3+
In the `AndroidManifest.xml` file, add the following deeplink intent filter to your
44
sign-in activity:
55

66
```xml
@@ -21,5 +21,5 @@ Follow these steps to add your app to the allowlist:
2121

2222
2. Add `{YOUR_APP_PACKAGE_NAME}://auth` to **Allowlist URLs**.
2323

24-
3. Copy the `Client ID` and paste it inside the `res/values/strings.xml` file. It will be used as
24+
3. Copy the client ID and paste it inside the `res/values/strings.xml` file. It will be used as
2525
`R.string.web3auth_project_id` during initialization.

src/pages/quickstart/builder/embedded-wallets/android/stepContent/enableInternetUsage.mdx

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
### Enable internet usage
22

3-
Open your app's `AndroidManifest.xml` file and add the following permission:
4-
5-
```xml
6-
<uses-permission android:name="android.permission.INTERNET" />
7-
```
3+
To enable your app to perform network operations, add the `INTERNET` permission to the `AndroidManifest.xml` file.
84

95
:::note
106

src/pages/quickstart/builder/embedded-wallets/android/stepContent/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ 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'
7-
import * as login from './login.mdx'
8-
import * as logout from './logout.mdx'
7+
import * as signin from './signin.mdx'
8+
import * as signout from './signout.mdx'
99
import * as androidQuickStart from './androidQuickStart.mdx'
1010
import * as requirements from './requirements.mdx'
1111
import * as enableInternetUsage from './enableInternetUsage.mdx'
@@ -23,10 +23,10 @@ const STEPS = toSteps({
2323
configureDeepLink,
2424
registerApp,
2525
initialize,
26-
login,
26+
signin,
2727
getUserInfo,
2828
blockchainCalls,
29-
logout,
29+
signout,
3030
})
3131

3232
export default STEPS
Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
### Create and initialize the `Web3Auth` instance
1+
### Initialize Web3Auth
22

3-
You'll need a `clientId` and `network` to initialize the `Web3Auth` class. You can initialize it
4-
on-demand on a user interaction (like button click), or when the screen is initialized.
3+
Initialize a `Web3Auth` instance with your project's client ID and your target network
4+
(this quickstart uses `SAPPHIRE_MAINNET`).
55

6-
You can get your `clientId` from the previous step, whereas `network` signifies the type of
7-
network(`SAPPHIRE_MAINNET` or `SAPPHIRE_DEVNET`) you want to initialize `Web3Auth` with.
6+
You can initialize `Web3Auth` upon a user interaction (like a button click), or when the screen loads.
87

9-
:::info SDK reference
8+
:::info
109

11-
Read more about [Android SDK](/embedded-wallets/sdk/android).
10+
See the [Embedded Wallets Android SDK documentation](/embedded-wallets/sdk/android) for more information.
1211

1312
:::

src/pages/quickstart/builder/embedded-wallets/android/stepContent/installation.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
### Install the MetaMask Embedded Wallets Android SDK
1+
### Install the Embedded Wallets SDK
22

3-
Add the Android SDK to the dependency list of your app-level `build.gradle`
4-
file. Add the latest `com.github.Web3Auth:web3auth-android-sdk` package.
3+
Add the MetaMask Embedded Wallets (Web3Auth) Android SDK to the dependency list of the app-level `build.gradle` file.
4+
Ensure you're using the latest `com.github.Web3Auth:web3auth-android-sdk` package.
55

66
:::warning Update to the latest SDK
77

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,3 @@
11
### Add the Jitpack repository
22

3-
In your project-level `build.gradle` or `settings.gradle` file, add the JitPack repository.
4-
5-
```groovy
6-
dependencyResolutionManagement {
7-
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
8-
repositories {
9-
google()
10-
mavenCentral()
11-
maven { url "https://jitpack.io" } // <-- Add this line
12-
}
13-
}
14-
```
3+
In the app-level `build.gradle` or `settings.gradle` file, add the JitPack repository, `https://jitpack.io`.

src/pages/quickstart/builder/embedded-wallets/android/stepContent/login.mdx

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)