Skip to content

Commit f7cf09b

Browse files
authored
[Portal] Account Docs (#6442)
1 parent dd06be8 commit f7cf09b

38 files changed

+443
-244
lines changed

apps/portal/src/app/account/account-info/page.mdx

Whitespace-only changes.
Loading
Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import { DocImage, Steps, Step } from "@doc";
2-
import chooseKeyImage from "../assets/choose-key.png";
32
import allowedDomainsImage from "../assets/allowed-domains.png";
4-
import selectEditImage from "../assets/select-edit.png";
53
import { createMetadata } from "@doc";
4+
import AccessRestrictions from "./assets/access-restrictions.png";
5+
import ProjectOverview from "../assets/project-overview.png";
66

77
export const metadata = createMetadata({
88
title: "Access Restrictions",
@@ -24,32 +24,28 @@ To modify the allowed Domain Id or Bundle Ids:
2424

2525
<Steps>
2626

27-
<Step title="Go to Dashboard">
27+
<Steps>
2828

29-
Go to **[thirdweb dashboard](https://thirdweb.com/team)**
29+
<Step title="Select Project">
3030

31-
</Step>
31+
Select the project you want to set access restrictions on from the Overview section of your dashboard.
3232

33-
<Step title="Choose API Key">
34-
Choose the API Key you want to modify restrictions on.
33+
<DocImage src={ProjectOverview} alt="Project Overview" />
3534

36-
<DocImage src={chooseKeyImage} />
3735
</Step>
3836

39-
<Step title="Edit">
40-
Select `Edit` to enter editor mode.
37+
<Step title="Project Settings">
4138

42-
<DocImage src={selectEditImage} />
43-
</Step>
39+
Navigate to the project's settings and locate Domain Restrictions and Bundle ID restrictions. Add the domain or bundle id you want to restrict the project on.
4440

45-
<Step title="Edit Domains">
46-
Enter the allowed domains the "Allowed Domains" field or switch to Bundle IDs to enter allowed Bundle IDs.
41+
<DocImage src={AccessRestrictions} alt="" />
4742

48-
<DocImage src={allowedDomainsImage} />
4943
</Step>
5044

5145
<Step title="Save Changes">
52-
46+
Save your changes to apply the access restrictions.
5347
</Step>
5448

5549
</Steps>
50+
51+
</Steps>
Binary file not shown.
Loading
Loading
Binary file not shown.
Binary file not shown.

apps/portal/src/app/account/api-keys/create/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Input the domains you want to restrict your application to in Allowed Domains th
4646

4747
Store your secret key in a secure location and confirm that you have stored it by checking the checkbox then select Complete.
4848

49-
<Callout variant="warning">
49+
<Callout variant="danger" title="Secret Key">
5050
Do not share secret keys. They grant access to all thirdweb services. Secret
5151
keys should only be used in backend environments like CLI, scripts, and
5252
servers. Never expose secret keys in client-side code due to the lack of
Loading
Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { DocImage, Steps, Step } from "@doc";
2-
import chooseKeyImage from "../assets/choose-key.png";
32
import confirmDeleteImage from "../assets/confirm-delete.png";
3+
import ProjectOverview from "../assets/project-overview.png";
4+
import DeleteProject from "./assets/delete-project.png";
45
import { createMetadata } from "@doc";
56

67
export const metadata = createMetadata({
@@ -13,27 +14,30 @@ export const metadata = createMetadata({
1314
},
1415
});
1516

16-
# Delete API Key
17+
# Delete Or Transfer Project
1718

18-
Deleting an API key will invalidate it, making it no longer usable.
19+
Deleting a project also removes its associated API key, rendering it invalid and unusable. You may also choose to transfer projects to another team.
1920

2021
<Steps>
2122

22-
<Step title="Go to Dashboard">
23-
Go to **[your team's projects page](https://thirdweb.com/team)** on the dashboard.
24-
</Step>
23+
<Step title="Select Project">
2524

26-
<Step title='Choose API Key'>
27-
Choose the API Key you want to delete.
25+
Select the project you want to delete or transfer from the Overview section of your dashboard.
2826

29-
<DocImage src={chooseKeyImage} />
27+
<DocImage src={ProjectOverview} alt="Project Overview" />
3028

3129
</Step>
3230

33-
<Step title='Delete Key'>
34-
To delete an API key, select `Delete key` and confirm your intention to delete the key. The key will then be deleted.
31+
<Step title="Project Settings">
32+
33+
Navigate to the project's settings and locate "Transfer Project" or "Delete Project".
34+
35+
<DocImage src={DeleteProject} alt="Delete Project" />
36+
37+
</Step>
3538

36-
<DocImage src={confirmDeleteImage} />
39+
<Step title="Confirm Transfer or Deletion">
40+
In the UI confirm the transfer or deletion of the project.
3741
</Step>
3842

3943
</Steps>
Loading
Lines changed: 14 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
import { DocImage, Steps, Step } from "@doc";
2-
import chooseKeyImage from "../assets/choose-key.png";
3-
import selectEditImage from "../assets/select-edit.png";
4-
import allServicesImage from "../assets/all-services.png";
5-
import smartWalletAPIKeyImage from "../assets/smart-wallet-api-key.png";
2+
import ProjectOverview from '../assets/project-overview.png';
3+
import EnabledServices from './assets/enabled-services.png';
64
import { createMetadata } from "@doc";
75

86
export const metadata = createMetadata({
@@ -15,70 +13,33 @@ export const metadata = createMetadata({
1513
},
1614
});
1715

18-
# Edit enabled services on API Keys
16+
# Enabled Services
1917

20-
All services on API keys are enabled by default. If you want to disable any services or edit settings for each service:
2118

22-
<Steps>
23-
24-
<Step title="Go to Dashboard">
2519

26-
Go to **[your team's projects page](https://thirdweb.com/team)** on the dashboard.
20+
All services on API keys per project are enabled by default. If you want to disable any services or edit settings for each service:
2721

28-
</Step>
22+
<Steps>
2923

30-
<Step title="Choose API key">
24+
<Step title="Select Project">
3125

32-
Choose the API Key from which you want to enable or disable a Service.
26+
Select the project you want to edit services for from the Overview section of your dashboard.
3327

34-
<DocImage src={chooseKeyImage} />
28+
<DocImage src={ProjectOverview} alt="Project Overview" />
3529

3630
</Step>
3731

38-
<Step title="Edit">
39-
Select `Edit` to enter the editor view.
32+
<Step title="Project Settings">
4033

41-
<DocImage src={selectEditImage} />
42-
</Step>
34+
Navigate to the project's settings and locate "Enabled Services".
4335

44-
<Step title="Modify services">
45-
Navigate to the Services section and enable the service and modify any services as needed.
36+
<DocImage src={EnabledServices} alt="Enabled Services" />
4637

47-
<DocImage src={allServicesImage} />
4838
</Step>
4939

50-
<Step title="Save Changes">
40+
<Step title="Modify Services">
41+
Toggle the specified service you want on or off. Each service is on by default and toggling will turn off access to the service for the project.
5142
</Step>
52-
</Steps>
53-
54-
### Services
55-
56-
#### Storage
57-
58-
By default, Storage services are enabled upon creation of the API Key.
59-
60-
Storage provides two sub-settings enabled by default on API Key creation.
6143

62-
- Upload - Enable uploading to Storage
63-
- Download - Enable downloading from Storage
64-
65-
To disable Upload or Download:
66-
67-
1. Navigate to Settings > API Keys
68-
2. Toggle the checkboxes in the Services > Storage settings
69-
70-
#### RPC Edge
71-
72-
By default, RPC Edge services are enabled upon creation of the API Key.
73-
74-
To use RPC Edge in your application, see our [RPC Edge QuickStart](/infrastructure/rpc-edge/get-started) article.
75-
76-
#### Account abstraction services
77-
78-
By default, Account abstraction services services are enabled upon creation of the API Key.
79-
80-
To set additional rules on which transactions you want to sponsor, go to your Team > Project > Account Abstraction > Configuration page.
81-
82-
#### In-App Wallets
44+
</Steps>
8345

84-
By default, In-App Wallet services are enabled upon creation of the API Key. You can view your in-app wallet's settings in your Team > Project > Connect > In App Wallets page.

apps/portal/src/app/account/api-keys/faq/page.mdx

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

apps/portal/src/app/account/api-keys/page.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ export const metadata = createMetadata({
1212

1313
# API Keys
1414

15-
API Keys are required to use thirdweb's infrastructure services including [Storage](/infrastructure/storage/overview), [RPC Edge](/infrastructure/rpc-edge/overview), [Account Abstraction infrastructure](/connect/account-abstraction), and [In-App Wallets](/connect/in-app-wallet/overview).
15+
Each thirdweb project is equipped with an API key to use thirdweb's infrastructure services including [Storage](/infrastructure/storage/overview), [RPC Edge](/infrastructure/rpc-edge/overview), [Account Abstraction infrastructure](/connect/account-abstraction), and [In-App Wallets](/connect/in-app-wallet/overview).
16+
17+
## Services
1618

1719
API Keys allow you to:
1820

@@ -25,3 +27,9 @@ API Keys consists of two components:
2527

2628
- **Client ID**- Used to access the enabled thirdweb infrastructure services and identify your application using an app bundle ID (identifier for native apps) or domain (identifier for websites). Client IDs can be restricted to allow only specified domains and app bundle IDs to access the enabled services.
2729
- **Secret Key**- Used to access the enabled thirdweb infrastructure services by identifying and authenticating your application from a backend. **Sharing or exposing this key to others is unsafe because it grants access to all services.**
30+
31+
## Obtain API Key
32+
33+
To obtain an API Key, follow the Create Project step in the [Create API Key](/account/api-keys/create) guide.
34+
35+
You can find your API Key in the project settings of your dashboard.

apps/portal/src/app/account/billing/account-info/page.mdx

Lines changed: 0 additions & 48 deletions
This file was deleted.
Loading
Loading
Binary file not shown.
Binary file not shown.
Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import { createMetadata, DocImage } from "@doc";
2-
import opScreen1 from "./opimg1.png";
3-
import opScreen2 from "./opimg2.png";
1+
import { createMetadata, DocImage, Steps, Step } from "@doc";
2+
import TeamSettings from './assets/team-settings.png';
3+
import Credits from './assets/credits-page.png';
44

55
export const metadata = createMetadata({
6-
title: "Credits",
6+
title: "thirdweb - Credits",
77
description: "Learn about how credits will be applied to your bill",
88
image: {
99
title: "Credits",
@@ -13,33 +13,28 @@ export const metadata = createMetadata({
1313

1414
# Credits
1515

16-
Credits let you cover the costs of using thirdweb services. There are two types of credits that you can receive.
16+
Credits let you cover the costs of using thirdweb services. There are currently two types of credits available on thirdweb:
1717

18-
#### Optimism Superchain Credits
18+
- **Optimism Superchain Credits**
19+
Optimism superchain credits are redeemed from a program which aims to enable developers to create seamless web3 user onboarding experiences powered by Smart Accounts. [Learn more about the OP Superchain program.](https://thirdweb.com/grant/superchain)
1920

20-
These credits can be used to cover gas fees on Superchain networks, which are a collection of networks built on the OP stack and include the following chains:
21+
- **Service Credits**: These credits can be applied across any thirdweb service on any chain. This includes usage across In-App Wallets, RPC, and IPFS storage. To get thirdweb credits, apply to join the [startup program.](https://thirdweb.com/community/startup-program).
2122

22-
- OP Mainnet
23-
- Base
24-
- Zora
25-
- Mode
26-
- Fraxtal
23+
## View Credits
2724

28-
To get superchain credits, apply to join the [Superchain App Accelerator](https://thirdweb.com/grant/superchain?ref=blog.thirdweb.com).
25+
<Steps>
2926

30-
This program aims to enable developers to create exceptional web3 user experiences powered by Smart Accounts. You can use your OP credits to start using Account Abstraction to sponsor your users' gas fees for free. Learn more about how you can easily integrate Account Abstraction into your apps [here](https://portal.thirdweb.com/connect/account-abstraction).
27+
<Step title="Navigate to Settings">
3128

32-
#### thirdweb Credits
29+
While logged in, navigate to the **Settings** tab in your dashboard and select **Settings**.
3330

34-
These credits can be applied across any thirdweb service on any chain. This includes usage across In-App Wallets, RPC, and IPFS storage.
31+
<DocImage src={TeamSettings} alt="Team Settings" />
32+
</Step>
33+
<Step title="View Credits">
34+
Select Credits to view your available credits and usage or apply to the OP Superchain program.
35+
<DocImage src={Credits} alt="Credits dashboard" />
36+
</Step>
3537

36-
To get thirdweb credits, apply to join the [startup program.](https://thirdweb.com/community/startup-program).
38+
</Steps>
3739

38-
### Using your credits
39-
40-
You can view how many credits you have in [your team's billing page](https://thirdweb.com/team/~/~/settings/billing)
41-
42-
<DocImage src={opScreen1} />
43-
<DocImage src={opScreen2} />
44-
45-
If you have credits, you can use eligible thirdweb services normally without any extra setup. Credits will automatically be applied to your bill at the end of the month.
40+
If you have credits, you can use eligible thirdweb services normally without any extra setup. Credits will automatically be applied to your bill at the end of the month.

0 commit comments

Comments
 (0)