Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion build/starknet-privacy/anonymous-defi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The helper is needed because the output amount is only known after the Vesu call

### Interface sketch (Cairo)

The following excerpt shows the **shape** of an invoke helper for reference. **Most users will interact through existing deployed helpers** (like the Vesu lending helper above), not write their own. Teams building new DeFi integrations can use this as a starting point—a full guide will ship with the SDK:
The following excerpt shows the **shape** of an invoke helper for reference. **Most users will interact through existing deployed helpers** (like the Vesu lending helper above), not write their own. Teams building new DeFi integrations can use this as a starting point—for working helper integrations (Vesu lending, swaps, escrow), see the [DeFi helper examples in STRK20 by Example](https://strk20-by-example.org/helpers/vesu-lending-helper):

```cairo
pub enum LendingOperation { Deposit, Withdraw }
Expand Down
13 changes: 10 additions & 3 deletions build/starknet-privacy/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ and enterprises can understand how Starknet Privacy works.
- **Live on mainnet:** the privacy pool contract is deployed at
[`0x0403…812a`](https://voyager.online/contract/0x040337b1af3c663e86e333bab5a4b28da8d4652a15a69beee2b677776ffe812a).
The contract source is readable on Voyager.
- **SDK not yet public:** the TypeScript SDK and proving stack are not open
sourced yet. When they ship, operational guides (install, quickstart,
end-to-end usage) will be added here.
- **SDK now open source:** the TypeScript SDK and proving stack are available in the
[starknet-privacy repo](https://github.com/starkware-libs/starknet-privacy).
For hands-on integration guides (install, quickstart, end-to-end flows), see
[STRK20 by Example](https://strk20-by-example.org/).

## Why Starknet Privacy?

Expand All @@ -44,6 +45,12 @@ For the latest maintained cross-protocol comparison grid, use [privacygrid.dev](
<Card title="Protocol deep-dives" icon="book" href="/build/starknet-privacy/architecture">
Architecture, flows, and cryptography in these docs
</Card>
<Card title="STRK20 by Example" icon="code" href="https://strk20-by-example.org/">
Hands-on integration hub: runnable SDK examples, DeFi helpers, and wallet integration guides
</Card>
<Card title="SDK source" icon="github" href="https://github.com/starkware-libs/starknet-privacy">
TypeScript SDK and proving stack in the starknet-privacy repo
</Card>
</CardGroup>

## What you get
Expand Down
37 changes: 37 additions & 0 deletions build/starknet-privacy/strk20-by-example.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "STRK20 by Example"
description: "Hands-on hub of runnable examples for integrating STRK20 confidential transfers"
icon: code
---

These docs explain **how Starknet Privacy works**. When you are ready to build,
[**STRK20 by Example**](https://strk20-by-example.org/) is the hands-on companion:
a hub of runnable examples for teams integrating STRK20 into their apps, built on
the open-source [starknet-privacy SDK](https://github.com/starkware-libs/starknet-privacy).

## What you'll find

<CardGroup cols={2}>
<Card title="SDK examples" icon="cube" href="https://strk20-by-example.org/sdk/getting-started">
Setup, registration, deposits, transfers, withdrawals, note discovery,
proving configuration, and multi-operation batches
</Card>
<Card title="DeFi helpers" icon="arrows-rotate" href="https://strk20-by-example.org/helpers/privacy-invoke">
Privacy Invoke, Vesu lending, swaps, and escrow — working open-note
helper integrations
</Card>
<Card title="Wallet integration" icon="wallet" href="https://strk20-by-example.org/starknet-wallet-api/overview">
Starknet Wallet API and starknet.js patterns for privacy-enabled dApps
</Card>
<Card title="Example app" icon="rocket" href="https://strk20-by-example.org/app/anonymous-airdrop">
An end-to-end anonymous airdrop application combining the pieces
</Card>
</CardGroup>

## How it relates to these docs

| You want to... | Go to |
| --- | --- |
| Understand the protocol (notes, channels, proofs, compliance) | These docs — start with the [overview](/build/starknet-privacy/overview) |
| Integrate STRK20 into your app with working code | [STRK20 by Example](https://strk20-by-example.org/) |
| Read the SDK and proving stack source | [starknet-privacy repo](https://github.com/starkware-libs/starknet-privacy) |
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -1106,7 +1106,8 @@
{
"group": "Getting started",
"pages": [
"build/starknet-privacy/overview"
"build/starknet-privacy/overview",
"build/starknet-privacy/strk20-by-example"
]
},
{
Expand Down
1 change: 1 addition & 0 deletions learn/cheatsheets/tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ are Starknet's various software development kits (SDKs)
* [Dojo](https://www.dojoengine.org/) is a developer friendly framework for building provable Games, Autonomous Worlds and other Applications that are natively composable, extensible, permissionless and persistent.
* [Chipi SDK](https://sdk.chipipay.com/introduction) is an open-source developer toolkit that enables Starknet applications to create non-custodial wallets using any social login (Google, Apple, Telegram, etc.), sponsor transactions via integration with [AVNU's Paymaster](/learn/cheatsheets/integrations#infrastructure), and build with their favourite auth provider with no black boxes.
* [Cavos](https://aegis.cavos.xyz/) is a wallet infrastructure service that enables instant wallet creation, gasless transactions, multi-provider authentication, and cross-platform SDKs
* [STRK20 by Example](https://strk20-by-example.org/) is a one-stop hub of runnable examples for integrating STRK20 confidential transfers into apps, covering the [starknet-privacy SDK](https://github.com/starkware-libs/starknet-privacy) (deposits, transfers, withdrawals, note discovery), DeFi helpers, and wallet integration.

## AI tools

Expand Down
Loading