Skip to content

docs: update policies and session key docs #1596

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.

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
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

avarobinson
Copy link
Collaborator

@avarobinson avarobinson commented May 6, 2025

Copy changes for policies and session key docs.

Pull Request Checklist


PR-Codex overview

This PR focuses on updating documentation related to smart wallet policies, specifically enhancing the section on onchain policies using session keys, and restructuring the content for clarity and better organization.

Detailed summary

  • Deleted offchain-policy-configuration.mdx.
  • Updated slug and path for key-concepts-and-examples.mdx.
  • Changed title to Onchain policies using session keys.
  • Expanded explanation of policies and session keys.
  • Added structured sections for scoped permissions and examples.
  • Revised descriptions for key concepts and use cases.
  • Improved clarity and organization of policy features.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

vercel bot commented May 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
aa-sdk-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2025 7:04pm
aa-sdk-ui-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2025 7:04pm

Copy link

github-actions bot commented May 6, 2025

🌿 Documentation Preview

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview May 16, 2025, 7:05 PM

blakecduncan
blakecduncan previously approved these changes May 6, 2025
Copy link
Collaborator

@blakecduncan blakecduncan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just on question in the pr but not blocking.

Also, do we need to make these updates in this site and the new docs site?

dphilipson
dphilipson previously approved these changes May 6, 2025
Copy link
Contributor

@dphilipson dphilipson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Blu-J
Blu-J previously approved these changes May 12, 2025
@github-actions github-actions bot temporarily deployed to docs-preview May 12, 2025 18:25 Inactive
@github-actions github-actions bot temporarily deployed to docs-preview May 16, 2025 03:29 Inactive
Blu-J
Blu-J previously approved these changes May 16, 2025
dphilipson
dphilipson previously approved these changes May 16, 2025
Copy link
Contributor

@dphilipson dphilipson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Little bit more typos, but otherwise looks great!

Smart Wallet Policies are programmatic rules enforced through the offchain policy engine and/or onchain smart contract modules. They govern how a smart wallet interacts with the blockchain, from transaction execution to signer permissions. Unlike traditional embedded wallets, Alchemy Smart Wallets allow you to embed logic that restricts or automates behavior verifiably onchain.
# **Key Concepts & Examples**

Smart Wallet Policies are programmatic rules enforced through onchain smart contract modules and/or the offchain policiy engine. They govern how a smart wallet interacts with the blockchain, from transaction execution to signer permissions. Unlike traditional embedded wallets, Alchemy Smart Wallets allow you to embed logic that restricts or automates behavior verifiably onchain.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: "policiy" -> "policy"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated this as a commit suggestion.


- **Chain Restrictions:** Limit [transactions](/wallets/react/quickstart#2-get-your-alchemy-api-key) to only certain chains
- **Multi-Factor Authentication:** Mandate [MFA](/wallets/react/mfa/setup-mfa) via an authenticator app like Authy
- **Gas Sponsorship Rules:** [Define custom conditions](/wallets/react/sponsor-gas#create-a-gas-manager-policy) for gas sponsorship (e.g. sponsor up to $10 in gas, or first 10 transactions, allowlist/blocklist senders for sponsorship, custom rules, etc.).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Nit) elsewhere in the docs we use "denylist" instead of "blocklist".

@Blu-J Blu-J dismissed stale reviews from dphilipson and themself via a576fd9 May 16, 2025 19:03
@github-actions github-actions bot temporarily deployed to docs-preview May 16, 2025 19:03 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants