Skip to content

Commit f19d339

Browse files
committed
Edited the Android content.
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
1 parent 63749de commit f19d339

File tree

8 files changed

+44
-43
lines changed

8 files changed

+44
-43
lines changed
Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
1-
### Making Blockchain Calls
1+
### Make blockchain calls
22

3-
While using the Web3Auth Android SDK, you get the private key and sessionId within the user scope. This private key can interact with [Ethereum](https://ethereum.org/) to make any blockchain calls, like getting user's `account`, fetch `balance`, `sign transaction`, `send transaction`, `read` from and `write` to the smart contract, etc. We have added a basic EVM chain based example here for your reference.
3+
After the user signs in, the SDK provides a user-scoped private key and session ID.
4+
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, sign or send
7+
transactions, read and write to smart contracts, on so on.
8+
9+
We added a basic EVM chain based example here for your reference.
410

511
:::info Connect any Blockchain
612

7-
Refer to the [Blockchain Documentation](/connect-blockchain/) to know more about how to make calls on any blockchain.
13+
Refer to the [Blockchain Documentation](/connect-blockchain/) to learn more about making calls on
14+
any supported blockchain.
815

916
:::
Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
### Configure Deep Link & Whitelist
1+
### Configure your deeplink and whitelist
22

3-
Open your app's `AndroidManifest.xml` file and add the following deep link intent filter to your sign-in activity:
3+
Open your app's `AndroidManifest.xml` file and add the following deeplink intent filter to your
4+
sign-in activity:
45

56
```xml
67
<intent-filter>
@@ -14,16 +15,11 @@ Open your app's `AndroidManifest.xml` file and add the following deep link inten
1415
</intent-filter>
1516
```
1617

17-
:::info Whitelist your app
18+
Follow these steps to add your app to the whitelist:
1819

19-
In order to whitelist your App, you'll need to create a project in the [Developer Dashboard](https://dashboard.web3auth.io).
20+
1. In the [Developer dashboard](https://dashboard.web3auth.io/), select your project.
2021

21-
- Go to [Developer Dashboard](https://dashboard.web3auth.io/), select your Web3Auth project.
22+
2. Add `{YOUR_APP_PACKAGE_NAME}://auth` to **Whitelist URLs**.
2223

23-
- Add `{YOUR_APP_PACKAGE_NAME}://auth` to **Whitelist URLs**.
24-
25-
- Copy the `Client ID` and paste it inside `res/values/strings.xml` file.
26-
27-
- It will be used as `R.string.web3auth_project_id` during initialization.
28-
29-
:::
24+
3. Copy the `Client ID` and paste it inside the `res/values/strings.xml` file. It will be used as
25+
`R.string.web3auth_project_id` during initialization.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
### Create and initialize the Web3Auth instance
1+
### Create and initialize the `Web3Auth` instance
22

3-
Let's now create an instance of the `Web3Auth`.
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.
45

5-
We need `clientId` and `network` to initialize the Web3Auth class. You can get your `clientId` from registering (above), whereas `network` signifies the type of network(`SAPPHIRE_MAINNET` or `SAPPHIRE_DEVNET`) you want to initialize web3auth with.
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.
68

7-
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 when the screen is initialized.
8-
9-
:::info sdk reference
9+
:::info SDK reference
1010

1111
Read more about [Android SDK](/embedded-wallets/sdk/android).
1212

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
### Logging in your User
1+
### Sign in your user
22

3-
Use the `login` function in the Web3Auth Instance to log in user. Just create a button that triggers the `login` for the user of the login method of their choice.
3+
Use the `Web3Auth` instance [`login`](/embedded-wallets/sdk/android/usage#logging-in-a-user) function
4+
to sign in the user. You can create a button that triggers the `login` function for the sign in
5+
method of their choice.
46

5-
After a successful user login, Web3Auth will redirect back to your app, with a payload stored in the state of the Web3Auth Instance.
6-
7-
:::info SDK Reference
8-
9-
- [`login()` function](/embedded-wallets/sdk/android/usage#logging-in-a-user).
10-
11-
:::
7+
After a successful sign-in, the SDK stores the session state internally, and the user is redirected
8+
back to your app.
Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
### Log the user out
1+
### Sign out the user
22

3-
Use the `logout` function of the Web3Auth Instance to log the user out.
4-
5-
:::info SDK Reference
6-
7-
- [`logout()` function](/embedded-wallets/sdk/android/usage#logging-out-a-user).
8-
9-
:::
3+
Use the [`logout`](/embedded-wallets/sdk/android/usage#logging-out-a-user) function to sign the user out.
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
### Get User Info
1+
### Get user information
22

3-
Once logged in, Web3Auth state exposes some information about your logged in user. This is fetched directly from the JWT token and Web3Auth doesn't store this info anywhere.
3+
After the user signs in, the Web3Auth session state exposes user information derived from the JWT token,
4+
and doesn't store this information.
45

56
This information can help you identify your users and provide a more personalized experience.

src/pages/quickstart/commonSteps/registerApp.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ mediaContent:
55
url: '/img/embedded-wallets/web3auth-dashboard/web3auth-client-id.png'
66
---
77

8-
### Get your Client ID from the Web3Auth Dashboard
8+
### Get your client ID from the Web3Auth dashboard
99

10-
Visit the Web3Auth Dashboard and create a new project. Use the Client ID of the project to start your integration.
10+
Visit the Web3Auth dashboard and create a new project. Use the client ID of the project to start your
11+
integration.
1112

1213
<a
1314
className="button"
1415
href="https://dashboard.web3auth.io"
1516
target="_blank"
1617
rel="noreferrer noopener">
17-
<span>Go to the Developer Dashboard</span>
18+
<span>Go to the Developer dashboard</span>
1819
</a>

src/pages/quickstart/styles.module.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,11 @@ input:checked+.slider::before {
289289
line-height: 1.6;
290290
}
291291

292+
.stepBody strong,
293+
.stepBody b {
294+
font-weight: 700;
295+
}
296+
292297
.w3DropdownMenu li {
293298
padding: 4px 12px;
294299
cursor: pointer;

0 commit comments

Comments
 (0)