{"id":19610711,"url":"https://github.com/onflow/fcl-discovery","last_synced_at":"2025-04-27T22:33:01.371Z","repository":{"id":38051129,"uuid":"298122013","full_name":"onflow/fcl-discovery","owner":"onflow","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-18T14:53:19.000Z","size":2858,"stargazers_count":11,"open_issues_count":16,"forks_count":19,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-04-05T04:07:00.220Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://fcl-discovery.onflow.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onflow.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-23T23:52:23.000Z","updated_at":"2025-03-12T22:31:33.000Z","dependencies_parsed_at":"2024-02-13T01:42:01.389Z","dependency_job_id":"3c242832-3048-41fb-8c14-e03a9dc3ad38","html_url":"https://github.com/onflow/fcl-discovery","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onflow%2Ffcl-discovery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onflow%2Ffcl-discovery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onflow%2Ffcl-discovery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onflow%2Ffcl-discovery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onflow","download_url":"https://codeload.github.com/onflow/fcl-discovery/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251219600,"owners_count":21554444,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T10:32:08.067Z","updated_at":"2025-04-27T22:32:56.359Z","avatar_url":"https://github.com/onflow.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Discovery\n\nWhen building an dapp on Flow using [@onflow/fcl](https://github.com/onflow/fcl-js), Discovery eliminates the need for dapp developers to write code to integrate their user's preferred wallet into their application. Instead, @onflow/fcl and this repo uses a secure discovery protocol that wallets can implement to connect to @onflow/fcl. The end result is dapps using @onflow/fcl automatically integrate all compatible wallets without their developers needing to write any custom code!\n\nTo read more about consuming/using this repo via FCL, visit the [Discovery docs](https://developers.flow.com/tools/fcl-js/reference/discovery).\n\n## Getting Started\n\nFirst, run the development server:\n\n```bash\nnpm run dev\n# or\nyarn dev\n```\n\nThen add Discovery to your FCL app:\n\n```\nimport * as fcl from \"@onflow/fcl\"\n\nfcl.config({\n  \"discovery.wallet\": \"https://fcl-discovery.onflow.org/testnet/authn\",\n  \"discovery.authn.endpoint\": \"https://fcl-discovery.onflow.org/api/testnet/authn\"\n})\n```\n\n## Networks\n\n### Discovery UI URLs\n\n| Environment | Example                                                                |\n| ----------- | ---------------------------------------------------------------------- |\n| Mainnet     | `http://localhost:3002/authn` or `http://localhost:3002/mainnet/authn` |\n| Testnet     | `http://localhost:3002/testnet/authn`                                  |\n| Previewnet  | `http://localhost:3002/previewnet/authn`                               |\n| Local       | `http://localhost:3002/local/authn`                                    |\n| Emulator    | `http://localhost:3002/emulator/authn`                                 |\n\n### Discovery API Endpoints\n\n| Environment | Example                                                                        |\n| ----------- | ------------------------------------------------------------------------------ |\n| Mainnet     | `http://localhost:3002/api/authn` or `http://localhost:3002/api/mainnet/authn` |\n| Testnet     | `http://localhost:3002/api/testnet/authn`                                      |\n| Previewnet  | `http://localhost:3002/api/previewnet/authn`                                   |\n| Local       | `http://localhost:3002/api/local/authn`                                        |\n| Emulator    | `http://localhost:3002/api/emulator/authn`                                     |\n\n\u003e Note: Local and emulator will return Dev Wallet as a service for developing locally with the default port of 8701. If you'd like to override the default port add ?port=0000 with the port being whatever you'd like to override it to.\n\n## More Configuration\n\nFor more configuration options, please see the [**documentation**](https://developers.flow.com/tools/clients/fcl-js/discovery).\n\n## Adding a Wallet to Discovery\n\nFlow compatible wallets wanting to add their wallets to Discovery can do so by creating a PR with the following:\n\n- Add your wallet's service information to the [services data file](https://github.com/onflow/fcl-discovery/blob/master/data/services.json)\n- Please provide any metadata related to your service if required ([see metadata docs](https://github.com/onflow/fcl-discovery/blob/master/docs/service-fields.md))\n- Provide a demo of your wallet that can be tested and is connected to Testnet\n- Specify if your wallet is opt-in or not. Opt-in wallets are those that don't have support for authentication, authorization, and user signature services.\n\nBefore adding your wallet to Discovery, ensure your wallet meets the minimum [acceptance criteria](https://github.com/onflow/fcl-discovery/blob/master/docs/wallet-compliance-guide.md).\n\nFor more information/examples on how to build a Flow compatible wallet, check out the following links:\n\n- [Wallet Provider Spec](https://github.com/onflow/fcl-js/blob/9bce741d3b32fde18b07084b62ea15f9bbdb85bc/packages/fcl/src/wallet-provider-spec/draft-v3.md)\n- [FCL Dev Wallet](https://github.com/onflow/fcl-dev-wallet)\n- [Example Chrome Extension Wallet](https://github.com/onflow/wallet-extension-example)\n\n## Documentation\n\nTo learn more about the repo, take a look at the following resources:\n\n- [Discovery](https://developers.flow.com/tools/fcl-js/reference/api#discovery) - Documentation for using Discovery with FCL.\n- [FCL](https://developers.flow.com/tools/fcl-js) - Learn more about Flow's FCL\n- [Next.js Documentation](https://nextjs.org/docs) - This app is built with Next. Learn about Next.js features and API.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonflow%2Ffcl-discovery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonflow%2Ffcl-discovery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonflow%2Ffcl-discovery/lists"}