This guide contains a set of criteria wallets on Flow must meet in order to be accepted and included in Flow's FCL Wallet Discovery.
Wallets on Flow must be compatible with the FCL wallet provider spec in order to be compatible with applications built on Flow.
At a minimum, wallets on Flow must provide support for FCL's:
-
Authentication service: https://github.com/onflow/fcl-js/blob/master/packages/fcl/src/wallet-provider-spec/draft-v4.md#authentication-service
-
Authorization service: https://github.com/onflow/fcl-js/blob/master/packages/fcl/src/wallet-provider-spec/draft-v4.md#authorization-service
-
User Signature service: https://github.com/onflow/fcl-js/blob/master/packages/fcl/src/wallet-provider-spec/draft-v4.md#user-signature-service
Wallets may additionally choose to support other FCL services (pre-authz, provable authentication etc), but these additional services are not required to be included in Flow's FCL Wallet Discovery.
These standards ensure a high quality user experience on Flow for applications that choose to use FCL Discovery for wallet discovery.
End users expect that wallets on FCL Discovery function as expected, and application developers that use FCL Discovery depend on it to ensure wallets meet the minimum required functionality. Other opt-in services are not expected to be provided by default to application developers by wallets, and thus are not required by this standard.
If a wallet does not meet the minimum required functionality outlined in this guide, or is otherwise limited in functionality, either in terms of transactions it accepts to sign or applications if will support, then that wallet may still be accepted as an opt-in wallet in FCL Discovery.
This acceptance criteria ensures FCL Discovery meets the needs and expectations of the users and developers that depend on it.
In order to be included in Flow's FCL Wallet Discovery, new wallets must prove their functionality, and continue to prove their functionality on a recurrent basis from time to time. Wallets that fail to prove their functionality may be subject to removal from FCL Discovery until their functionality is restored.
Wallets will be tested against the FCL Harness application. The FCL Harness will be configured to use each wallet, and will be used to carry out Authentication, Authorization of a transaction, and User Signature over some data.
To test your wallet against the FCL Harness application, clone the repo, start the harness, add your wallet to discovery.wallet using the input field provided, and ensure your wallet successfully authenticates and executes each mutate and user signing interaction.
Wallet developers are expected to ensure their wallet meets the required functionality by using the FCL Harness to test their wallet. Prior to inclusion in Flow's FCL Discovery, the Flow team will also carry out this testing to ensure functionality. From time to time, the Flow team will carry out testing to ensure continued functionality.