Skip to content
Open
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
6 changes: 3 additions & 3 deletions CROWDIN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Crowdin Translator How-To

Stellar Developer Docs use [Crowdin](https://crowdin.com/) for localization. This document provides steps and resources for managing Stellar Docusaurus Crowdin translations as a Crowdin user with a Translator role.
Stellar Developer Docs use [Crowdin](https://crowdin.com) for localization. This document provides steps and resources for managing Stellar Docusaurus Crowdin translations as a Crowdin user with a Translator role.

---

Expand Down Expand Up @@ -33,7 +33,7 @@ For more details on working within the editor, see the following documentation:
[Working in the Editor](https://support.crowdin.com/for-translators/#working-in-the-editor)

For a more in-depth look, see:
[Online Editor Guide](https://support.crowdin.com/online-editor/)
[Online Editor Guide](https://support.crowdin.com/online-editor)

---

Expand All @@ -46,7 +46,7 @@ Examples include:
- Words or phrases that should not be translated at all.

For more information, see the following documentation:
[Glossary](https://support.crowdin.com/glossary/)
[Glossary](https://support.crowdin.com/glossary)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/build/agentic-payments/mpp/charge-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ In **pull** mode (default), the client builds and signs the full transaction env

This tutorial walks through building a payment-gated API with Node.js and Express using `@stellar/mpp`.

To follow this guide, you will need [Node.js](https://nodejs.org/) installed locally. Recommend using the latest LTS version.
To follow this guide, you will need [Node.js](https://nodejs.org) installed locally. Recommend using the latest LTS version.

## Create a project

Expand Down
2 changes: 1 addition & 1 deletion docs/build/agentic-payments/x402/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ This version supports x402 v2 specification. For x402 v1 support, please use a p
- [x402 on Stellar (Landing page)](https://stellar.org/x402) — Stellar x402 overview and resources
- [x402 on Stellar (Blog)](https://stellar.org/blog/foundation-news/x402-on-stellar) — Foundation news and announcement
- [x402 protocol (Coinbase Developer Platform)](https://docs.cdp.coinbase.com/x402) — Official x402 protocol overview and spec
- [x402 protocol specification](https://www.x402.org/) — x402 Specification and Whitepaper
- [x402 protocol specification](https://www.x402.org) — x402 Specification and Whitepaper
- [Coinbase x402 GitHub](https://github.com/coinbase/x402) — Official x402 Protocol GitHub Repo
- [x402-stellar (npm)](https://www.npmjs.com/package/x402-stellar) — npm package for x402 on Stellar
- [Signing Soroban invocations](../../guides/transactions/signing-soroban-invocations.mdx) — Auth-entry signing and transaction signing on Stellar
2 changes: 1 addition & 1 deletion docs/build/agentic-payments/x402/built-on-stellar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ If you want to run your own instance of the facilitator instead of using the hos
- [@x402/stellar (npm)](https://www.npmjs.com/package/@x402/stellar) — npm package for x402 on Stellar
- [x402-stellar (repo)](https://github.com/stellar/x402-stellar) — Tools, examples, and references for x402 on Stellar
- [x402 on Stellar](./README.mdx) — Overview of the x402 protocol on Stellar
- [x402 protocol specification](https://www.x402.org/) — x402 specification and whitepaper
- [x402 protocol specification](https://www.x402.org) — x402 specification and whitepaper
- [OpenZeppelin x402 Facilitator Plugin][oz-plugin] — Source code
- [OpenZeppelin x402 Facilitator Docs][oz-facilitator-guide] — Full configuration and setup guide
- [OpenZeppelin Stellar Relayer SDK](https://github.com/OpenZeppelin/openzeppelin-relayer-sdk) — SDK for interacting with the Relayer
Expand Down
4 changes: 2 additions & 2 deletions docs/build/agentic-payments/x402/quickstart-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: [x402, x402 quickstart, x402 tutorial, 402]

This tutorial shows how to build the simplest possible paid API with Node.js and Express using the x402 packages with settlement on the Stellar network.

To follow this guide, you will need [Node.js](https://nodejs.org/) installed locally. Recommend using the latest LTS version.
To follow this guide, you will need [Node.js](https://nodejs.org) installed locally. Recommend using the latest LTS version.

## Create A Project

Expand Down Expand Up @@ -317,7 +317,7 @@ The server is set up as an MVP for machine-to-machine payments. If you want to e
- [x402 on Stellar (Landing page)](https://stellar.org/x402) - Stellar x402 overview and resources
- [x402 on Stellar (Blog)](https://stellar.org/blog/foundation-news/x402-on-stellar) - Foundation news and announcement
- [x402 protocol (Coinbase Developer Platform)](https://docs.cdp.coinbase.com/x402) - Official x402 protocol overview and spec
- [x402 protocol specification](https://www.x402.org/) - x402 Specification and Whitepaper
- [x402 protocol specification](https://www.x402.org) - x402 Specification and Whitepaper
- [Coinbase x402 GitHub](https://github.com/coinbase/x402) - Official x402 Protocol GitHub Repo
- [x402-stellar (npm)](https://www.npmjs.com/package/x402-stellar) - npm package for x402 on Stellar
- [Signing Soroban invocations](../../guides/transactions/signing-soroban-invocations.mdx) - Auth-entry signing and transaction signing on Stellar
12 changes: 6 additions & 6 deletions docs/build/apps/application-design-considerations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ Building an application with [multi-signature](../../learn/fundamentals/transact

There are several apps and services that specialize in adding additional security layers to users' accounts. Check them out if you're interested in integrating a third-party key management service:

- [Ledger](https://www.ledger.com/)
- [Trezor](https://trezor.io/)
- [StellarGuard](https://stellarguard.me/)
- [LobstrVault](https://vault.lobstr.co/)
- [Ledger](https://www.ledger.com)
- [Trezor](https://trezor.io)
- [StellarGuard](https://stellarguard.me)
- [LobstrVault](https://vault.lobstr.co)

## Application security

Expand All @@ -49,8 +49,8 @@ For more information, check out our guide to [securing web-based products](https

A wallet typically has these basic functions: key storage, account creation, transaction signing, and queries to the Stellar database. There are some services that take care of all of these functions for you, so you can build whatever you’d like around it. Check out some of these wallet services below.

- [Albedo](https://albedo.link/)
- [Freighter](https://www.freighter.app/)
- [Albedo](https://albedo.link)
- [Freighter](https://www.freighter.app)

## Account creation strategies

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ function validateChallengeTransaction({

## Sign and submit the challenge transaction

In response, the user signs the transaction. You may have noticed we present this challenge transaction to the user with our regular confirmation modal. Once they've signed the transaction, the application sends it back to the anchor with a `POST` request. If the signature checks out, the success response will contain a [JSON Web Token (JWT)](https://jwt.io/), which BasicPay stores in the `webAuthStore` store to use for future interactions with the anchor.
In response, the user signs the transaction. You may have noticed we present this challenge transaction to the user with our regular confirmation modal. Once they've signed the transaction, the application sends it back to the anchor with a `POST` request. If the signature checks out, the success response will contain a [JSON Web Token (JWT)](https://jwt.io), which BasicPay stores in the `webAuthStore` store to use for future interactions with the anchor.

```html title=/src/routes/dashboard/transfers/+page.svelte
<script>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/apps/guestbook/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Although Ye Olde Guestbook is a full-fledged application on Stellar's Testnet, i
To build this guestbook application, we'll need a few pieces.

- **Application framework:** we're using SvelteKit, opting for a type-checked project using TypeScript. SvelteKit (and Svelte on its own) is quite a capable framework, and we'll be using some of its features in this project. However, we will not be diving into those Svelte-specific areas very heavily in this tutorial. The source code of the project is freely open and available and has some decent informational comments throughout if you would like to peruse it for those purposes.
- **Frontend framework:** We're using [Skeleton](https://www.skeleton.dev/) to simplify the use of [Tailwind CSS](https://tailwindcss.com/).
- **Frontend framework:** We're using [Skeleton](https://www.skeleton.dev) to simplify the use of [Tailwind CSS](https://tailwindcss.com).
- **A way to interact with the network:** this is a TypeScript application, and we're using the `@stellar/stellar-sdk` for this. You could make traditional `fetch` requests if you wanted to, depending on your deployment decisions. In either case, we'll need the SDK to interact with keypairs and transactions. We'll also be using a data indexer to access historical network events, and we'll cover more of this at a later point in the tutorial.
- **A way to interact with a user's account:** we're foregoing the traditional wallets here, and we'll use `passkey-kit` to give our users a smart wallet to interact with. They can interact with this smart wallet (via passkey-kit) through methods they're already familiar with (thumbprints, face ID, etc.).

Expand Down
6 changes: 3 additions & 3 deletions docs/build/apps/guestbook/passkeys-prerequisites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The `PRIVATE_` and `PUBLIC_` environment variables are a SvelteKit convention, a

## Mercury

Now, on to [Mercury](https://www.mercurydata.app/). This is a data indexer, running on both Testnet and Mainnet. The team is developing some bleeding-edge data tools that are beginning to redefine what's possible with network data. One such development is the [ZephyrVM](https://docs.mercurydata.app/zephyr-full-customization/introduction): Mercury's cloud execution environment. In short, Zephyr allows you to write (Rust) programs that will run at the close of _every_ ledger on the Stellar network. Inside that program, you can access any kind of current or past data, interact with external web services, create serverless functions, and populate databases. Similar to Launchtube, we won't be _directly_ interacting with Mercury inside the Ye Olde Guestbook dapp. Those interactions will be handled by the `passkey-kit` package. Also similar to Launchtube, this one takes some setting up.
Now, on to [Mercury](https://www.mercurydata.app). This is a data indexer, running on both Testnet and Mainnet. The team is developing some bleeding-edge data tools that are beginning to redefine what's possible with network data. One such development is the [ZephyrVM](https://docs.mercurydata.app/zephyr-full-customization/introduction): Mercury's cloud execution environment. In short, Zephyr allows you to write (Rust) programs that will run at the close of _every_ ledger on the Stellar network. Inside that program, you can access any kind of current or past data, interact with external web services, create serverless functions, and populate databases. Similar to Launchtube, we won't be _directly_ interacting with Mercury inside the Ye Olde Guestbook dapp. Those interactions will be handled by the `passkey-kit` package. Also similar to Launchtube, this one takes some setting up.

The `passkey-kit` package doesn't "ship" with a Zephyr program in the published package, but it _does_ have all the Zephyr goodness you'll need in the source repository. Here's how you get that Zephyr program running on Mercury so you can access the indexed smart wallet events. By the way, these commands are probably best run _outside_ the directory where you're building your guestbook dapp.

Expand All @@ -46,7 +46,7 @@ The `passkey-kit` package doesn't "ship" with a Zephyr program in the published
cd passkey-kit/zephyr
```

2. Get an authentication token from the Mercury website. You can login to the [Testnet dashboard](https://test.mercurydata.app/) here. Click on the **Get access token** button under the "Active subscriptions" section. You'll be given a JWT which will be valid for the next seven days.
2. Get an authentication token from the Mercury website. You can login to the [Testnet dashboard](https://test.mercurydata.app) here. Click on the **Get access token** button under the "Active subscriptions" section. You'll be given a JWT which will be valid for the next seven days.

![Mercury Data JWT Token](/assets/guestbook/mercury_token.png)

Expand Down Expand Up @@ -90,6 +90,6 @@ It's possible something has gone wrong during your execution of the processes ab

1. **Generate a new Launchtube token.** It's possible the Launchtube token you're using has run out of credits. Since we're using Testnet for this tutorial, there's no harm in generating a brand new token any time by visiting `https://testnet.launchtube.xyz/gen` in your browser.
2. **Make sure your Zephyr program successfully deployed.** I've been stuck more than once with a not-working Mercury request because the Zephyr program hadn't actually deployed successfully. Make sure the `mercury-cli deploy` command's output doesn't have any errors in it.
3. **Check the [Mercury documentation](https://docs.mercurydata.app/).** It's quite good and can help you get past a lot of the hurdles you might face.
3. **Check the [Mercury documentation](https://docs.mercurydata.app).** It's quite good and can help you get past a lot of the hurdles you might face.

In any case, feel free to ask questions or drop a chat in the [`#passkeys`](https://discord.com/channels/897514728459468821/1250851135561142423) and [`#launchtube`](https://discord.com/channels/897514728459468821/1293204627361108141) channels in the Stellar Developer Discord server. There's usually somebody around who's ready and willing to help out!
2 changes: 1 addition & 1 deletion docs/build/apps/ingest-sdk/ingestion-pipeline-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ func main() {

### `config.toml`

The CDP configuration settings, this file defines the data storage which contains the pre-generated Ledger Metadata files. The [S3 Public Blockchain](https://registry.opendata.aws/aws-public-blockchain/) bucket for [Stellar Pubnet](hhttps://aws-public-blockchain.s3.us-east-2.amazonaws.com/index.html#v1.1/stellar/ledgers/pubnet/) is used in this example.
The CDP configuration settings, this file defines the data storage which contains the pre-generated Ledger Metadata files. The [S3 Public Blockchain](https://registry.opendata.aws/aws-public-blockchain) bucket for [Stellar Pubnet](hhttps://aws-public-blockchain.s3.us-east-2.amazonaws.com/index.html#v1.1/stellar/ledgers/pubnet) is used in this example.

<CodeExample>

Expand Down
2 changes: 1 addition & 1 deletion docs/build/apps/ingest-sdk/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This tutorial walks through how an application can leverage [CDP architecture](h

To use this example CDP pipeline for live Stellar network transaction data, you'll need:

- A developer workstation with [Go](https://go.dev/learn/) programming language runtime installed
- A developer workstation with [Go](https://go.dev/learn) programming language runtime installed
- An IDE to edit Go code, [VSCode](https://code.visualstudio.com/download) is good if one is needed
- A newly initialized, empty Go project folder. `mkdir pipeline; cd pipeline; go mod init example/pipeline`
- Some familiarity to the [Stellar Ledger Metadata model](../../../learn/fundamentals/stellar-data-structures/README.mdx). It is defined in an IDL format expressed in [XDR encoding](https://github.com/stellar/stellar-xdr).
Expand Down
6 changes: 3 additions & 3 deletions docs/build/apps/privacy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,17 @@ Research prototype, not audited. Do not use in production with real assets.
Proofs are generated client-side in the browser via WebAssembly — user secrets never leave the device.

- **Repo**: [NethermindEth/stellar-private-payments](https://github.com/NethermindEth/stellar-private-payments)
- **Docs**: [nethermindeth.github.io/stellar-private-payments](https://nethermindeth.github.io/stellar-private-payments/)
- **Docs**: [nethermindeth.github.io/stellar-private-payments](https://nethermindeth.github.io/stellar-private-payments)

## Confidential Tokens

Confidential Tokens let users keep token balances and transaction amounts private while keeping the sender and receiver's addresses publicly visible onchain. Confidential tokens are designed for contexts where the parties to a transaction are known, but the amounts should not be.

This makes confidential tokens well-suited for payments where parties need confidentiality without sacrificing public auditability.

The [Confidential Token Association](https://www.confidentialtoken.org/) — whose members include the Stellar Development Foundation, Nethermind, OpenZeppelin, and Zama — is developing an open standard for encryption-based onchain confidentiality compatible with existing token interfaces. Implementation on Stellar is in progress.
The [Confidential Token Association](https://www.confidentialtoken.org) — whose members include the Stellar Development Foundation, Nethermind, OpenZeppelin, and Zama — is developing an open standard for encryption-based onchain confidentiality compatible with existing token interfaces. Implementation on Stellar is in progress.

- **Website**: [confidentialtoken.org](https://www.confidentialtoken.org/)
- **Website**: [confidentialtoken.org](https://www.confidentialtoken.org)
- **Overview/demo video**: [youtube.com/watch?v=6NnDqVQYOHM](https://www.youtube.com/watch?v=6NnDqVQYOHM)

## Onchain ZK Verifiers
Expand Down
4 changes: 2 additions & 2 deletions docs/build/apps/zk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ While BN254 host functions provide the cryptographic operations needed for proof
- [Soroban SDK BN254 documentation - types and functions](https://docs.rs/soroban-sdk/latest/soroban_sdk/_migrating/v25_bn254/index.html)
- [CAP-74 proposal](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0074.md)
- [Noir Ultrahonk Soroban Verifier Contract](https://github.com/indextree/ultrahonk_soroban_contract)
- [Noir documentation (circuits)](https://noir-lang.org/docs/)
- [Risc0 documentation (circuits)](https://dev.risczero.com/)
- [Noir documentation (circuits)](https://noir-lang.org/docs)
- [Risc0 documentation (circuits)](https://dev.risczero.com)

## Poseidon

Expand Down
2 changes: 1 addition & 1 deletion docs/build/building-with-ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The skill can be installed on any AI coding tool that supports the [Agent Skills
| --- | --- |
| [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | `~/.claude/skills/` |
| [OpenCode](https://opencode.ai) | `~/.config/opencode/skills/` |
| [OpenAI Codex](https://openai.com/index/openai-codex/) | `~/.codex/skills/` |
| [OpenAI Codex](https://openai.com/index/openai-codex) | `~/.codex/skills/` |

### Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ async function createRestorationFootprint(

## Code walkthrough

As we're making use of [Stellar SDK for JavaScript](https://stellar.github.io/js-stellar-sdk/) `js-stellar-sdk`, first we import the module.
As we're making use of [Stellar SDK for JavaScript](https://stellar.github.io/js-stellar-sdk) `js-stellar-sdk`, first we import the module.

Our function will require the following parameters:

Expand Down
2 changes: 1 addition & 1 deletion docs/build/guides/contract-accounts/advanced-patterns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ See the [Complex Account example](../../smart-contracts/example-contracts/comple

- See these patterns applied in the [contract account examples](./examples.mdx).
- Explore reference implementations and libraries:
- [OpenZeppelin Stellar contracts](https://github.com/OpenZeppelin/stellar-contracts/)
- [OpenZeppelin Stellar contracts](https://github.com/OpenZeppelin/stellar-contracts)
- [Crossmint smart account](https://github.com/Crossmint/stellar-smart-account)
4 changes: 2 additions & 2 deletions docs/build/guides/contract-accounts/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A smart wallet that demonstrates the use of multi-sig and policy signers to, sur

An app that uses passkeys to sign Stellar smart contract transactions.

- View the [demo](https://passkey.sorobanbyexample.org/)
- View the [demo](https://passkey.sorobanbyexample.org)
- View the [code](https://github.com/kalepail/soroban-passkey)
- Watch the [demo video](https://www.youtube.com/watch?v=y38_O4oIvbY)
- Watch the [discussion](/meetings/2024/05/09)
Expand All @@ -34,7 +34,7 @@ An app that uses passkeys to sign Stellar smart contract transactions.

A passkey-powered multi-signer abstract account contract example.

- View the [demo](https://superpeach.xyz/)
- View the [demo](https://superpeach.xyz)
- View the [code](https://github.com/kalepail/superpeach)
- Watch the [demo video](https://youtu.be/0Agiwso2OMc?si=CHD9U8s-YLyqbXUJ)

Expand Down
Loading
Loading