Skip to content

Commit fca6789

Browse files
authored
Merge pull request #978 from LIT-Protocol/chore/doc-updates
Formatting Updates for Naga docs
2 parents f2f4182 + 359ee4a commit fca6789

20 files changed

+213
-191
lines changed

docs/sdk/auth-context-consumption/encrypt-and-decrypt.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ console.log("🧔🏻‍♂️ BobsAccount:", BobsAccount.address);
7878
Alice decides who can decrypt her encrypted data
7979

8080
<Tip>
81-
See SDK Reference for more details on the Access Control Conditions Builder. [Access Control Conditions Builder Reference](/sdk/sdk-reference/access-control-conditions/functions/createAccBuilder)
81+
See the [Access Control Conditions Builder Reference API](/sdk/sdk-reference/access-control-conditions/functions/createAccBuilder) for more details on how to build access control conditions.
8282
</Tip>
8383

8484
### Build Access Control Conditions

docs/sdk/auth-context-consumption/pkp-sign.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ description: "Use your PKP to sign a message with the selected chain and scheme.
44
---
55

66
<Tip>
7-
See SDK Reference for more details on the PKP Sign. [PKP Sign
8-
Reference](/sdk/sdk-reference/lit-client/functions/createLitClient#chain-raw-pkpsign)
7+
See the [PKP Sign Reference API](/sdk/sdk-reference/lit-client/functions/createLitClient#chain-raw-pkpsign) for more details on how to sign a message with your PKP.
98
</Tip>
109

1110
# Prerequisites

docs/sdk/auth/pkp-custom-auth/pkp-custom-auth.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ description: "Implement custom PKP authentication methods with Lit Actions"
1515

1616
Custom Authentication allows <b>dApp owners</b> to provide PKPs (Programmable Key Pairs) to their users without requiring them to understand blockchain technology or manage private keys. Instead of forcing users to learn new authentication methods, you can leverage your existing authentication systems (OAuth, APIs, databases) while providing them with powerful web3 capabilities.
1717

18-
This demonstrates the complete <b>dApp-centric custom authentication</b> flow from both perspectives: the <b>Site Owner</b> who sets up the system and the User who interacts with it.
18+
This demonstrates the complete <b>dApp-centric custom authentication</b> flow from both perspectives: the <b>Site Owner</b> who sets up the system and the <b>User</b> who interacts with it.
1919

2020
# Overview
2121

2222
In this example:
2323

24-
- site owners control the PKP minting process and provide immutable validation logic via IPFS.
24+
- Site owners control the PKP minting process and provide immutable validation logic via IPFS.
2525
- Users get pre-minted PKPs and authenticate through the site owner's validation Lit Action.
2626

2727
# Site Owner Walkthrough

docs/sdk/auth/pkp-native-auth/pkp-discord-auth.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ description: "Discord Authentication uses your Discord account to authenticate v
4949
</Step>
5050

5151
<Step title="Generate Auth Context">
52-
Use your newly minted PKP to create an AuthContext. This method will cache two things:
52+
Use your PKP's public key to create an AuthContext. This method will cache two things:
5353
1. session key pair - a temporary cryptographic key pair generated on the client side that acts as a temporary identity for the client application. It consists of:
5454
- A public key - shared with the Lit nodes
5555
- A secret key (private key) - kept securely on the client
@@ -59,7 +59,7 @@ Use your newly minted PKP to create an AuthContext. This method will cache two t
5959

6060
const authContext = await authManager.createPkpAuthContext({
6161
authData: authData, // <-- Retrieved earlier
62-
pkpPublicKey: pkpInfo.pubkey, // <-- Minted earlier
62+
pkpPublicKey: pkpInfo.pubkey,
6363
authConfig: {
6464
resources: [
6565
["pkp-signing", "*"],

docs/sdk/auth/pkp-native-auth/pkp-eoa-auth.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ description: "Externally Owned Account (EOA) authentication uses your existing E
3838

3939
<Step title="Authenticate with EOA">
4040

41-
Use the WalletClientAuthenticator/ViemAccountAuthenticator to authenticate your connected wallet and generate auth data.
41+
Use the `WalletClientAuthenticator` or `ViemAccountAuthenticator` to authenticate your connected wallet and generate auth data.
4242

4343
<CodeGroup>
4444
```ts wagmi
@@ -97,17 +97,17 @@ You can select an existing PKP associated with your account or mint a new one.
9797
</Step>
9898

9999
<Step title="Generate Auth Context">
100-
Use your newly minted PKP to create an AuthContext. This method will cache two things:
100+
Use your PKP's public key to create an AuthContext. This method will cache two things:
101101
1. session key pair - a temporary cryptographic key pair generated on the client side that acts as a temporary identity for the client application. It consists of:
102102
- A public key - shared with the Lit nodes
103103
- A secret key (private key) - kept securely on the client
104-
2. Delegation AuthSig aka. the inner auth sig - a cryptographic attestation from the Lit Protocol nodes that authorises your session key to act on behalf of your PKP.
104+
2. Delegation AuthSig (aka. the inner auth sig) - a cryptographic attestation from the Lit Protocol nodes that authorises your session key to act on behalf of your PKP.
105105

106106
```ts
107107

108108
const authContext = await authManager.createPkpAuthContext({
109109
authData: authData, // <-- Retrieved earlier
110-
pkpPublicKey: pkpInfo.pubkey, // <-- Minted earlier
110+
pkpPublicKey: pkpInfo.pubkey,
111111
authConfig: {
112112
resources: [
113113
["pkp-signing", "*"],

docs/sdk/auth/pkp-native-auth/pkp-google-auth.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ description: "Google Authentication uses your Google account to authenticate via
4949
</Step>
5050

5151
<Step title="Generate Auth Context">
52-
Use your newly minted PKP to create an AuthContext. This method will cache two things:
52+
Use your PKP's public key to create an AuthContext. This method will cache two things:
5353
1. session key pair - a temporary cryptographic key pair generated on the client side that acts as a temporary identity for the client application. It consists of:
5454
- A public key - shared with the Lit nodes
5555
- A secret key (private key) - kept securely on the client
@@ -59,7 +59,7 @@ Use your newly minted PKP to create an AuthContext. This method will cache two t
5959

6060
const authContext = await authManager.createPkpAuthContext({
6161
authData: authData, // <-- Retrieved earlier
62-
pkpPublicKey: pkpInfo.pubkey, // <-- Minted earlier
62+
pkpPublicKey: pkpInfo.pubkey,
6363
authConfig: {
6464
resources: [
6565
["pkp-signing", "*"],

docs/sdk/auth/pkp-native-auth/pkp-stytch-2fa-totp-auth.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Stytch TOTP 2FA Authentication is a secondary authentication metho
66
# Prerequisites
77

88
<Warning>
9-
⚠️ Backend Required: This authentication method requires a backend service
9+
Backend Required: This authentication method requires a backend service
1010
that handles Stytch Email OTP operations. The auth service already has the
1111
implementation in place with the `/stytch/email/send-otp` and
1212
`/stytch/email/verify-otp` endpoints, but they are disabled by default. Simply
@@ -121,7 +121,7 @@ const authData = await StytchWhatsAppOtpAuthenticator.authenticate({
121121

122122
<Step title="Generate Auth Context">
123123

124-
Use your newly minted PKP to create an AuthContext. This method will cache two things:
124+
Use your PKP's public key to create an AuthContext. This method will cache two things:
125125

126126
1. session key pair - a temporary cryptographic key pair generated on the client side that acts as a temporary identity for the client application. It consists of:
127127
- A public key - shared with the Lit nodes
@@ -131,7 +131,7 @@ Use your newly minted PKP to create an AuthContext. This method will cache two t
131131
```ts
132132
const authContext = await authManager.createPkpAuthContext({
133133
authData: authData, // <-- Retrieved earlier
134-
pkpPublicKey: pkpInfo.pubkey, // <-- Minted earlier
134+
pkpPublicKey: pkpInfo.pubkey,
135135
authConfig: {
136136
resources: [
137137
["pkp-signing", "*"],

docs/sdk/auth/pkp-native-auth/pkp-stytch-email-otp-auth.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Stytch Email OTP Authentication uses Stytch's Email OTP service to
66
# Prerequisites
77

88
<Warning>
9-
⚠️ Backend Required: This authentication method requires a backend service that handles Stytch Email OTP operations. The auth service already has the implementation in place with the `/stytch/email/send-otp` and `/stytch/email/verify-otp` endpoints, but they are disabled by default. Simply run your auth service at the configured URL to enable Stytch Email OTP functionality.
9+
Backend Required: This authentication method requires a backend service that handles Stytch Email OTP operations. The auth service already has the implementation in place with the `/stytch/email/send-otp` and `/stytch/email/verify-otp` endpoints, but they are disabled by default. Simply run your auth service at the configured URL to enable Stytch Email OTP functionality.
1010
</Warning>
1111

1212
<Note>
@@ -75,7 +75,7 @@ description: "Stytch Email OTP Authentication uses Stytch's Email OTP service to
7575
</Step>
7676

7777
<Step title="Generate Auth Context">
78-
Use your newly minted PKP to create an AuthContext. This method will cache two things:
78+
Use your PKP's public key to create an AuthContext. This method will cache two things:
7979
1. session key pair - a temporary cryptographic key pair generated on the client side that acts as a temporary identity for the client application. It consists of:
8080
- A public key - shared with the Lit nodes
8181
- A secret key (private key) - kept securely on the client
@@ -85,7 +85,7 @@ Use your newly minted PKP to create an AuthContext. This method will cache two t
8585

8686
const authContext = await authManager.createPkpAuthContext({
8787
authData: authData, // <-- Retrieved earlier
88-
pkpPublicKey: pkpInfo.pubkey, // <-- Minted earlier
88+
pkpPublicKey: pkpInfo.pubkey,
8989
authConfig: {
9090
resources: [
9191
["pkp-signing", "*"],

docs/sdk/auth/pkp-native-auth/pkp-stytch-sms-otp-auth.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Stytch SMS OTP Authentication uses Stytch's SMS OTP service to aut
66
# Prerequisites
77

88
<Warning>
9-
⚠️ Backend Required: This authentication method requires a backend service
9+
Backend Required: This authentication method requires a backend service
1010
that handles Stytch Email OTP operations. The auth service already has the
1111
implementation in place with the `/stytch/email/send-otp` and
1212
`/stytch/email/verify-otp` endpoints, but they are disabled by default. Simply
@@ -82,7 +82,7 @@ const authData = await StytchSmsOtpAuthenticator.authenticate({
8282

8383
<Step title="Generate Auth Context">
8484

85-
Use your newly minted PKP to create an AuthContext. This method will cache two things:
85+
Use your PKP's public key to create an AuthContext. This method will cache two things:
8686

8787
1. session key pair - a temporary cryptographic key pair generated on the client side that acts as a temporary identity for the client application. It consists of:
8888
- A public key - shared with the Lit nodes
@@ -92,7 +92,7 @@ Use your newly minted PKP to create an AuthContext. This method will cache two t
9292
```ts
9393
const authContext = await authManager.createPkpAuthContext({
9494
authData: authData, // <-- Retrieved earlier
95-
pkpPublicKey: pkpInfo.pubkey, // <-- Minted earlier
95+
pkpPublicKey: pkpInfo.pubkey,
9696
authConfig: {
9797
resources: [
9898
["pkp-signing", "*"],

docs/sdk/auth/pkp-native-auth/pkp-stytch-whatsapp-otp-auth.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: "Enter your phone number to receive a one-time password (OTP) via W
66
# Prerequisites
77

88
<Warning>
9-
⚠️ Backend Required: This authentication method requires a backend service
9+
Backend Required: This authentication method requires a backend service
1010
that handles Stytch Email OTP operations. The auth service already has the
1111
implementation in place with the `/stytch/email/send-otp` and
1212
`/stytch/email/verify-otp` endpoints, but they are disabled by default. Simply
@@ -83,7 +83,7 @@ const authData = await StytchWhatsAppOtpAuthenticator.authenticate({
8383

8484
<Step title="Generate Auth Context">
8585

86-
Use your newly minted PKP to create an AuthContext. This method will cache two things:
86+
Use your PKP's public key to create an AuthContext. This method will cache two things:
8787

8888
1. session key pair - a temporary cryptographic key pair generated on the client side that acts as a temporary identity for the client application. It consists of:
8989
- A public key - shared with the Lit nodes
@@ -93,7 +93,7 @@ Use your newly minted PKP to create an AuthContext. This method will cache two t
9393
```ts
9494
const authContext = await authManager.createPkpAuthContext({
9595
authData: authData, // <-- Retrieved earlier
96-
pkpPublicKey: pkpInfo.pubkey, // <-- Minted earlier
96+
pkpPublicKey: pkpInfo.pubkey,
9797
authConfig: {
9898
resources: [
9999
["pkp-signing", "*"],

0 commit comments

Comments
 (0)