Skip to content
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

SEP-1: Add SEP-45 fields #1579

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
38 changes: 20 additions & 18 deletions ecosystem/sep-0001.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Title: Stellar Info File
Author: stellar.org
Status: Active
Created: 2017-10-30
Updated: 2024-02-01
Version: 2.6.0
Updated: 2025-01-16
Version: 2.7.0
```

## Simple Summary
Expand Down Expand Up @@ -58,22 +58,24 @@ Documentation sections.

These are global fields in the `stellar.toml` file.

| Field | Requirements | Description |
| ----------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| VERSION | string | The version of SEP-1 your `stellar.toml` adheres to. This helps parsers know which fields to expect. |
| NETWORK_PASSPHRASE | string | The passphrase for the specific [Stellar network](https://www.stellar.org/developers/guides/concepts/networks.html) this infrastructure operates on |
| FEDERATION_SERVER | uses `https://` | The endpoint for clients to resolve stellar addresses for users on your domain via [SEP-2](sep-0002.md) Federation Protocol |
| AUTH_SERVER | uses `https://` | (deprecated) The endpoint used for [SEP-3](sep-0003.md) Compliance Protocol |
| TRANSFER_SERVER | uses `https://` | The server used for [SEP-6](sep-0006.md) Anchor/Client interoperability |
| TRANSFER_SERVER_SEP0024 | uses `https://` | The server used for [SEP-24](sep-0024.md) Anchor/Client interoperability |
| KYC_SERVER | uses `https://` | The server used for [SEP-12](sep-0012.md) Anchor/Client customer info transfer |
| WEB_AUTH_ENDPOINT | uses `https://` | The endpoint used for [SEP-10 Web Authentication](sep-0010.md) |
| SIGNING_KEY | Stellar public key | The signing key is used for [SEP-3](sep-0003.md) Compliance Protocol (deprecated) and [SEP-10](sep-0010.md) Authentication Protocol |
| HORIZON_URL | url | Location of public-facing Horizon instance (if you offer one) |
| ACCOUNTS | list of `G...` strings | A list of Stellar accounts that are controlled by this domain |
| URI_REQUEST_SIGNING_KEY | Stellar public key | The signing key is used for [SEP-7](sep-0007.md) delegated signing |
| DIRECT_PAYMENT_SERVER | uses `https://` | The server used for receiving [SEP-31](sep-0031.md) direct fiat-to-fiat payments. Requires [SEP-12](sep-0012.md) and hence a `KYC_SERVER` TOML attribute. |
| ANCHOR_QUOTE_SERVER | uses `https://` | The server used for receiving [SEP-38](sep-0038.md) requests. |
| Field | Requirements | Description |
| ------------------------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| VERSION | string | The version of SEP-1 your `stellar.toml` adheres to. This helps parsers know which fields to expect. |
| NETWORK_PASSPHRASE | string | The passphrase for the specific [Stellar network](https://www.stellar.org/developers/guides/concepts/networks.html) this infrastructure operates on |
| FEDERATION_SERVER | uses `https://` | The endpoint for clients to resolve stellar addresses for users on your domain via [SEP-2](sep-0002.md) Federation Protocol |
| AUTH_SERVER | uses `https://` | (deprecated) The endpoint used for [SEP-3](sep-0003.md) Compliance Protocol |
| TRANSFER_SERVER | uses `https://` | The server used for [SEP-6](sep-0006.md) Anchor/Client interoperability |
| TRANSFER_SERVER_SEP0024 | uses `https://` | The server used for [SEP-24](sep-0024.md) Anchor/Client interoperability |
| KYC_SERVER | uses `https://` | The server used for [SEP-12](sep-0012.md) Anchor/Client customer info transfer |
| WEB_AUTH_ENDPOINT | uses `https://` | The endpoint used for [SEP-10 Web Authentication](sep-0010.md) |
| WEB_AUTH_FOR_CONTRACTS_ENDPOINT | uses `https://` | The endpoint used for [SEP-45 Web Authentication](sep-0045.md) |
Copy link
Contributor

@lijamie98 lijamie98 Jan 21, 2025

Choose a reason for hiding this comment

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

We use SOROBAN in most of the CAPs. For example,

| [CAP-0046](cap-0046.md) | 20 |Soroban smart contract system overview | Graydon Hoare | Final |

Do we consider rename this to

Suggested change
| WEB_AUTH_FOR_CONTRACTS_ENDPOINT | uses `https://` | The endpoint used for [SEP-45 Web Authentication](sep-0045.md) |
| WEB_AUTH_FOR_SOROBAN_ENDPOINT | uses `https://` | The endpoint used for [SEP-45 Web Authentication](sep-0045.md) |

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We typically avoid using Soroban unless specifically referring to the smart contract environment on Stellar.

Copy link
Contributor

@lijamie98 lijamie98 Jan 22, 2025

Choose a reason for hiding this comment

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

Isn't this for the smart contract? Can you give examples where Soroban is avoided?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For example, we call them "Stellar smart contracts" in the docs https://developers.stellar.org/docs/build/smart-contracts/getting-started/setup. Also, WEB_AUTH_FOR_CONTRACTS_ENDPOINT is already used by the SEP-45 draft.

| WEB_AUTH_CONTRACT_ID | Stellar contract ID | The web authentication contract ID for [SEP-45 Web Authentication](sep-0045.md) |
| SIGNING_KEY | Stellar public key | The signing key is used for [SEP-3](sep-0003.md) Compliance Protocol (deprecated) and [SEP-10](sep-0010.md)/[SEP-45](sep-0045.md) Authentication Protocols |
| HORIZON_URL | url | Location of public-facing Horizon instance (if you offer one) |
| ACCOUNTS | list of `G...` strings | A list of Stellar accounts that are controlled by this domain |
| URI_REQUEST_SIGNING_KEY | Stellar public key | The signing key is used for [SEP-7](sep-0007.md) delegated signing |
| DIRECT_PAYMENT_SERVER | uses `https://` | The server used for receiving [SEP-31](sep-0031.md) direct fiat-to-fiat payments. Requires [SEP-12](sep-0012.md) and hence a `KYC_SERVER` TOML attribute. |
| ANCHOR_QUOTE_SERVER | uses `https://` | The server used for receiving [SEP-38](sep-0038.md) requests. |

### Organization Documentation

Expand Down
Loading