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

exp/services/webauth: remove the stellar.toml domain checks #3113

Merged
merged 3 commits into from
Oct 8, 2020
Merged

exp/services/webauth: remove the stellar.toml domain checks #3113

merged 3 commits into from
Oct 8, 2020

Conversation

leighmcculloch
Copy link
Member

@leighmcculloch leighmcculloch commented Oct 8, 2020

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

Remove the stellar.toml domain checks that occur on application start. Essentially revert the changes relating to this specific feature that were introduced in 5e82f16.

Why

SEP-10 v2.0.0 highlighted an existing feature that the SIGNING_KEY field in the stellar.toml be the key that the SEP-10 server use for signing. In 5e82f16 we added the feature that the server would verify that the stellar.toml that references the SEP-10 server contains the correct key. This feature is inconvenient because not all SEP-10 services have a stellar.toml. It's also inconvenient when developing. It's also scope creep on what this SEP-10 server implementation is concerned with. It also delays service boot up time which ideally should not block on external services. If we need tools for validating or verifying stellar.toml's we should probably pursue that as a separate tool.

Known limitations

This is a breaking change because it removes a config parameter, but the services is experimental and we can make breaking changes. For any service using environment variables to provide the config this will not be a breaking change and the additional config will be ignored.

### What
Remove the stellar.toml domain checks that occur on application start. Essentially revert the changes relating to this specific feature that were introduced in 5e82f16.

### Why
SEP-10 v2.0.0 highlighted an existing feature that the SIGNING_KEY field in the stellar.toml be the key that the SEP-10 server uses for signing. In 5e82f16 we added the feature that the server would verify that the stellar.toml that references the SEP-10 server. This feature is inconvenient because not all SEP-10 services have a stellar.toml. It's also scope creep on what this SEP-10 server implementation is concerned with.
@leighmcculloch leighmcculloch self-assigned this Oct 8, 2020
@cla-bot cla-bot bot added the cla: yes label Oct 8, 2020
@JakeUrban
Copy link
Contributor

JakeUrban commented Oct 8, 2020

How different is this change from a simple revert of the original commit that introduced this change?

UPDATE: Oh I see, the original commit included the SEP-20 change in the txbuild package too.

@leighmcculloch
Copy link
Member Author

It should be identical unless I made a mistake. The original change being reverted was bundled with other changes and so I didn't want to revert all of them.

@leighmcculloch leighmcculloch merged commit 8f0d77c into stellar:master Oct 8, 2020
@leighmcculloch leighmcculloch deleted the webauth-no-more-stellar-toml-checks branch October 8, 2020 18:00
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.

2 participants