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.

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

Jump to bottom

[ANCHOR-591] Add clients config to sep10 auth configuration #347

Merged
merged 5 commits into from
Mar 5, 2024
Merged

[ANCHOR-591] Add clients config to sep10 auth configuration #347

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3538e88
add clients config to sep10 auth
JiahuiWho Mar 1, 2024
a406412
prettier
JiahuiWho Mar 1, 2024
c646f72
address comments
JiahuiWho Mar 4, 2024
8cec8d4
format and lint
JiahuiWho Mar 4, 2024
9a7484b
address comments
JiahuiWho Mar 4, 2024
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
36 changes: 31 additions & 5 deletions docs/anchoring-assets/anchor-platform/sep10/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,43 @@ By default, the Anchor Platform allows anyone with a Stellar account to authenti
```bash
# dev.env
SEP10_CLIENT_ATTRIBUTION_REQUIRED=true
SEP10_CLIENT_ATTRIBUTION_ALLOWLIST=lobstr.co,api.vibrantapp.com,decaf.so,api.beansapp.com
```

</CodeExample>

<CodeExample>

SEP10_REQUIRE_KNOWN_OMNIBUS_ACCOUNT=true
SEP10_OMNIBUS_ACCOUNT_LIST=GBIBMZNXMD3P7HXVQCYIWWT5NG43NEIIY7VYBQ5SADV6UULUKCAJTGPG
```yaml
clients:
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you have 2 examples of custodial and non custodial separated a bit and add more comments to it (e.g. list fields that are required and optional for custodial/noncustodial)

# Required. The name of the client
- name: client0
# Required. custodial or noncustodial
type: custodial
# Required for custodial clients
signing_key: "the custodial SEP-10 signing key of the client"
# Optional The URL of the client's callback API endpoint
callback_url: https://callback.client0.com/api/v1/anchor/callback
# Optional. Default to false. If set to true, allows any destination for deposits.
allow_any_destination: false
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you note that this 2 fields are ONLY for custodial

# Optional. List of accounts allowed to be used for the deposit.
destination_accounts:
- name: client1
type: noncustodial
# Required for noncustodial clients. The domain of the client
domain: client1.co
callback_url: https://callback.client1.co/api/v2/anchor/callback
- name: client2
type: noncustodial
domain: client2.com
callback_url: https://callback.client2.com/api/v2/anchor/callback
signing_key: "the signing key of the client2"
```

</CodeExample>

`SEP10_CLIENT_ATTRIBUTION_REQUIRED` informs the Anchor Platform whether or not it should allow users of non-custodial wallets to authenticate without the wallet also identifying itself, and `SEP10_CLIENT_ATTTRIBUTION_ALLOWLIST` is the list of non-custodial wallets that can create authenticated sessions with your services.
`SEP10_CLIENT_ATTRIBUTION_REQUIRED` informs the Anchor Platform whether it should allow users of noncustodial wallets to authenticate without the wallet also identifying itself.

`SEP10_REQUIRE_KNOWN_OMNIBUS_ACCOUNT` informs the Anchor Platform whether or not it should allow users of custodial wallets to authenticate without the custodial wallet's public key being included in the `SEP10_OMNIBUS_ACCOUNT_LIST`.
`CLIENTS` is the list of outside wallet servers or clients for the Anchor server to safely communicate with.

## Modify a Stellar Info File

Expand Down
Loading