Skip to content

chore: standardize Openfort/Shield env var names #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joalavedra wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: standardize Openfort/Shield env var names #318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/playwright.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ jobs:

- name: Build auth-sample for production
env:
NEXT_PUBLIC_OPENFORT_PUBLIC_KEY: ${{ vars.NEXT_PUBLIC_OPENFORT_PUBLIC_KEY }}
NEXT_PUBLIC_SHIELD_API_KEY: ${{ vars.NEXT_PUBLIC_SHIELD_API_KEY }}
NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY: ${{ vars.NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY }}
NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY: ${{ vars.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY }}
NEXT_PUBLIC_POLICY_ID: ${{ vars.NEXT_PUBLIC_POLICY_ID }}
NEXT_PUBLIC_CHAIN_ID: ${{ vars.NEXT_PUBLIC_CHAIN_ID }}
NEXT_PUBLIC_CONTRACT_ID: ${{ vars.NEXT_PUBLIC_CONTRACT_ID }}
Expand All @@ -58,8 +58,8 @@ jobs:
NEXTAUTH_SHIELD_ENCRYPTION_SHARE: ${{ secrets.NEXTAUTH_SHIELD_ENCRYPTION_SHARE }}
NEXTAUTH_SHIELD_SECRET_KEY: ${{ secrets.NEXTAUTH_SHIELD_SECRET_KEY }}
E2E_TESTS_PASSWORD: ${{ secrets.E2E_TESTS_PASSWORD }}
NEXT_PUBLIC_OPENFORT_PUBLIC_KEY: ${{ vars.NEXT_PUBLIC_OPENFORT_PUBLIC_KEY }}
NEXT_PUBLIC_SHIELD_API_KEY: ${{ vars.NEXT_PUBLIC_SHIELD_API_KEY }}
NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY: ${{ vars.NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY }}
NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY: ${{ vars.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY }}
NEXT_PUBLIC_POLICY_ID: ${{ vars.NEXT_PUBLIC_POLICY_ID }}
NEXT_PUBLIC_CHAIN_ID: ${{ vars.NEXT_PUBLIC_CHAIN_ID }}
NEXT_PUBLIC_CONTRACT_ID: ${{ vars.NEXT_PUBLIC_CONTRACT_ID }}
Expand Down
4 changes: 2 additions & 2 deletions examples/apps/auth-sample/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
NEXTAUTH_OPENFORT_SECRET_KEY=
NEXT_PUBLIC_OPENFORT_PUBLIC_KEY=
NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY=
NEXT_PUBLIC_OPENFORT_RPC_URL=https://api.openfort.io/rpc
NEXT_PUBLIC_SHIELD_API_KEY=
NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY=

NEXTAUTH_SHIELD_ENCRYPTION_SHARE=
NEXTAUTH_SHIELD_SECRET_KEY=
Expand Down
4 changes: 2 additions & 2 deletions examples/apps/auth-sample/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ cp .env.example .env.local
```sh
# Add your Openfort keys to .env.local
NEXTAUTH_OPENFORT_SECRET_KEY=
NEXT_PUBLIC_OPENFORT_PUBLIC_KEY=
NEXT_PUBLIC_SHIELD_API_KEY=
NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY=
NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY=

NEXTAUTH_SHIELD_ENCRYPTION_SHARE=
NEXTAUTH_SHIELD_SECRET_KEY=
Expand Down
2 changes: 1 addition & 1 deletion examples/apps/auth-sample/src/components/Authorizations7702/Authorizations7702.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ const Authorizations7702: React.FC<{
const handleSignAuthorization = async () => {
try {
setLoading(true)
const openfortKey = process.env.NEXT_PUBLIC_OPENFORT_PUBLIC_KEY!
const openfortKey = process.env.NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY!
const openfortRpcUrl = `${process.env.NEXT_PUBLIC_BACKEND_URL || 'https://api.openfort.io'}/rpc/${appChain.id}`
const openfortTransport = http(openfortRpcUrl, {
fetchOptions: {
Expand Down
6 changes: 3 additions & 3 deletions examples/apps/auth-sample/src/pages/api/protected-create-encryption-session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
const shieldProjectResponse = await fetch(`${shieldUrl}/project`, {
headers: {
'Content-Type': 'application/json',
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_API_KEY!,
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY!,
'x-api-secret': process.env.NEXTAUTH_SHIELD_SECRET_KEY!,
},
})
Expand All @@ -32,7 +32,7 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
const res = await fetch(`${shieldUrl}/project/otp`, {
headers: {
'Content-Type': 'application/json',
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_API_KEY!,
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY!,
'x-api-secret': process.env.NEXTAUTH_SHIELD_SECRET_KEY!,
},
method: 'POST',
Expand All @@ -48,7 +48,7 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
const response = await fetch(`${shieldUrl}/project/encryption-session`, {
headers: {
'Content-Type': 'application/json',
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_API_KEY!,
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY!,
'x-api-secret': process.env.NEXTAUTH_SHIELD_SECRET_KEY!,
},
method: 'POST',
Expand Down
2 changes: 1 addition & 1 deletion examples/apps/auth-sample/src/pages/api/request-otp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
const response = await fetch(`${shieldUrl}/project/otp`, {
headers: {
'Content-Type': 'application/json',
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_API_KEY!,
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY!,
'x-api-secret': process.env.NEXTAUTH_SHIELD_SECRET_KEY!,
},
method: 'POST',
Expand Down
2 changes: 1 addition & 1 deletion examples/apps/auth-sample/src/utils/openfortAdminConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const openfort = (() => {
}
return new Openfort(process.env.NEXTAUTH_OPENFORT_SECRET_KEY, {
basePath: process.env.NEXT_PUBLIC_BACKEND_URL,
publishableKey: process.env.NEXT_PUBLIC_OPENFORT_PUBLIC_KEY,
publishableKey: process.env.NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY,
})
})()

Expand Down
4 changes: 2 additions & 2 deletions examples/apps/auth-sample/src/utils/openfortConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ export const passkeyRpName = process.env.NEXT_PUBLIC_PASSKEY_RP_NAME ?? 'Openfor

const openfort = new Openfort({
baseConfiguration: {
publishableKey: process.env.NEXT_PUBLIC_OPENFORT_PUBLIC_KEY!,
publishableKey: process.env.NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY!,
},
shieldConfiguration: {
shieldPublishableKey: process.env.NEXT_PUBLIC_SHIELD_API_KEY!,
shieldPublishableKey: process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY!,
passkeyRpId: passkeyRpId,
debug: true,
passkeyRpName: passkeyRpName,
Expand Down
4 changes: 2 additions & 2 deletions examples/apps/firebase-next-app/.env.local.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ NEXTAUTH_OPENFORT_SECRET_KEY=
NEXTAUTH_SHIELD_SECRET_KEY=
NEXTAUTH_SHIELD_ENCRYPTION_SHARE=

NEXT_PUBLIC_OPENFORT_PUBLIC_KEY=
NEXT_PUBLIC_SHIELD_API_KEY=
NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY=
NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY=


NEXT_PUBLIC_POLICY_ID=
Expand Down
4 changes: 2 additions & 2 deletions examples/apps/firebase-next-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ NEXTAUTH_OPENFORT_SECRET_KEY=
NEXTAUTH_SHIELD_SECRET_KEY=
NEXTAUTH_SHIELD_ENCRYPTION_SHARE=

NEXT_PUBLIC_SHIELD_API_KEY=
NEXT_PUBLIC_OPENFORT_PUBLIC_KEY=
NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY=
NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY=
```

**2. Create a Policy**
Expand Down
2 changes: 1 addition & 1 deletion examples/apps/firebase-next-app/src/pages/api/protected-create-encryption-session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default async function handler(_req: NextApiRequest, res: NextApiResponse
const response = await fetch(`${shieldUrl}/project/encryption-session`, {
headers: {
'Content-Type': 'application/json',
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_API_KEY!,
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY!,
'x-api-secret': process.env.NEXTAUTH_SHIELD_SECRET_KEY!,
},
method: 'POST',
Expand Down
6 changes: 3 additions & 3 deletions examples/apps/firebase-next-app/src/utils/openfortConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ export const backendUrl = process.env.NEXT_PUBLIC_BACKEND_URL
export const iframeUrl = process.env.NEXT_PUBLIC_IFRAME_URL

const baseConfiguration: OpenfortConfiguration = {
publishableKey: process.env.NEXT_PUBLIC_OPENFORT_PUBLIC_KEY!,
publishableKey: process.env.NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY!,
}
const shieldConfiguration: ShieldConfiguration = {
debug: true,
shieldPublishableKey: process.env.NEXT_PUBLIC_SHIELD_API_KEY!,
shieldPublishableKey: process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY!,
}

if (!process.env.NEXT_PUBLIC_OPENFORT_PUBLIC_KEY || !process.env.NEXT_PUBLIC_SHIELD_API_KEY) {
if (!process.env.NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY || !process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY) {
throw new Error('Missing Openfort environment variables')
}

Expand Down
4 changes: 2 additions & 2 deletions examples/apps/wallet-libraries/next-wagmi/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
NEXT_PUBLIC_OPENFORT_PUBLIC_KEY=
NEXT_PUBLIC_SHIELD_API_KEY=
NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY=
NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY=

NEXTAUTH_SHIELD_ENCRYPTION_SHARE=
NEXTAUTH_SHIELD_SECRET_KEY=
Expand Down
4 changes: 2 additions & 2 deletions examples/apps/wallet-libraries/next-wagmi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ cp .env.example .env.local
```sh
# Add your Openfort keys to .env.local
NEXTAUTH_OPENFORT_SECRET_KEY=
NEXT_PUBLIC_OPENFORT_PUBLIC_KEY=
NEXT_PUBLIC_SHIELD_API_KEY=
NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY=
NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY=

NEXTAUTH_SHIELD_ENCRYPTION_SHARE=
NEXTAUTH_SHIELD_SECRET_KEY=
Expand Down
2 changes: 1 addition & 1 deletion ...apps/wallet-libraries/next-wagmi/src/app/api/protected-create-encryption-session/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export async function POST(_request: Request) {
const response = await fetch(`${shieldUrl}/project/encryption-session`, {
headers: {
'Content-Type': 'application/json',
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_API_KEY!,
'x-api-key': process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY!,
'x-api-secret': process.env.NEXTAUTH_SHIELD_SECRET_KEY!,
},
method: 'POST',
Expand Down
4 changes: 2 additions & 2 deletions examples/apps/wallet-libraries/next-wagmi/src/openfort.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ export const iframeUrl = process.env.NEXT_PUBLIC_IFRAME_URL

export const openfortInstance = new Openfort({
baseConfiguration: {
publishableKey: process.env.NEXT_PUBLIC_OPENFORT_PUBLIC_KEY!,
publishableKey: process.env.NEXT_PUBLIC_OPENFORT_PUBLISHABLE_KEY!,
},
shieldConfiguration: {
shieldPublishableKey: process.env.NEXT_PUBLIC_SHIELD_API_KEY!,
shieldPublishableKey: process.env.NEXT_PUBLIC_SHIELD_PUBLISHABLE_KEY!,
},
overrides: {
shieldUrl: shieldUrl,
Expand Down
4 changes: 2 additions & 2 deletions examples/apps/wallet-libraries/vite-wagmi/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
VITE_APP_OPENFORT_PUBLISHABLE_KEY=
VITE_APP_SHIELD_PUBLISHABLE_KEY=
VITE_OPENFORT_PUBLISHABLE_KEY=
VITE_SHIELD_PUBLISHABLE_KEY=
4 changes: 2 additions & 2 deletions examples/apps/wallet-libraries/vite-wagmi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ pnpm build
cp .env.example .env

# Add your Openfort keys to .env
VITE_APP_OPENFORT_PUBLISHABLE_KEY=
VITE_APP_SHIELD_PUBLISHABLE_KEY=
VITE_OPENFORT_PUBLISHABLE_KEY=
VITE_SHIELD_PUBLISHABLE_KEY=
```

## Building locally
Expand Down
4 changes: 2 additions & 2 deletions examples/apps/wallet-libraries/vite-wagmi/src/utils/openfortConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ import { Openfort } from '@openfort/openfort-js'

const openfortInstance = new Openfort({
baseConfiguration: {
publishableKey: import.meta.env.VITE_APP_OPENFORT_PUBLISHABLE_KEY,
publishableKey: import.meta.env.VITE_OPENFORT_PUBLISHABLE_KEY,
},
shieldConfiguration: {
shieldPublishableKey: import.meta.env.VITE_APP_SHIELD_PUBLISHABLE_KEY,
shieldPublishableKey: import.meta.env.VITE_SHIELD_PUBLISHABLE_KEY,
},
})

Expand Down
Loading