Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blocto/fcl-android
🌊 Flow Client Library for Android
https://github.com/blocto/fcl-android
blockchain fcl flow flow-blockchain flow-sdk
Last synced: 2 months ago
JSON representation
🌊 Flow Client Library for Android
- Host: GitHub
- URL: https://github.com/blocto/fcl-android
- Owner: blocto
- License: mit
- Created: 2022-06-21T02:10:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T03:15:07.000Z (11 months ago)
- Last Synced: 2024-11-01T21:13:12.610Z (2 months ago)
- Topics: blockchain, fcl, flow, flow-blockchain, flow-sdk
- Language: Kotlin
- Homepage:
- Size: 559 KB
- Stars: 21
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FCL
The Flow Client Library (FCL) is a package used to interact with user wallets and the Flow
blockchain. When using FCL for authentication, DApps are able to support all FCL-compatible wallets
on Flow and their users without any custom integrations or changes needed to the DApp code.
Requirements
-------
- Min SDK 21+
Download
-------
In `build.gradle` of app module, include this dependency
```kotlin
implementation("com.portto.fcl:fcl:x.y.z")
```
> Add `maven("https://jitpack.io")` or `maven { url 'https://jitpack.io' }` to your
> project's `build.gradle` if you haven't. This is required by [flow-jvm-sdk][10].
Initialization
-------
Add FCL content provider to `AndroidManifest.xml`.
```xml
```
To initialize FCL, use the following function:
```kotlin
Fcl.init(
env = Network.TESTNET,
supportedWallets = getWalletList(isMainnet),
appDetail = AppDetail(),
)
```
- env: The network on which the app was built. i.e. `Network.TESTNET` or `Network.MAINNET`
- supportedWallets: A list of **wallet providers** supported by the app. See **Wallet Discovery**
for more info.
- appDetail(Optional): The information of the app.
Wallet Discovery
-------
Knowing all the wallets available to users on a blockchain can be challenging. FCL's Discovery
mechanism relieves much of the burden of integrating with Flow compatible wallets and lets
developers focus on building their DApp and providing as many options as possible to their users.
When you initialize FCL, it's required to provide a list of wallet providers. The following is an
example of adding `Blocto` and `Dapper` as wallet providers.
```kotlin
listOf(Blocto.getInstance(BLOCTO_TESTNET_APP_ID), Dapper)
```
### Current Wallet Providers
- [Blocto][1] (Fully supported) [Doc][7]
- [Dapper Wallet][2] (Support only authn for now)
Once you've initialized FCL, you may use Discovery directly from `Discovery UI` or `Config`.
### Discovery UI
The simplest way to integrate Wallet Discovery is to utilize Discovery UI.
```kotlin
// MainActivity.kt
showConnectWalletDialog(this) {
// authentication
}
```
### Config
If you want to create your own authentication UI, the wallet providers are exposed as a list which
can be retrieved from
`Fcl.config`.
```kotlin
// Create a custom UI by supplying wallet provider list as data
val providerList = Fcl.config.supportedWallets
// Once you get the user's selected provider, you need to add it to config
Fcl.config.put(Config.Option.SelectedWalletProvider(provider))
```
Authentication
-------
In order to interact with Flow blockchain, the current user's information is required. The user's
account address can be easily retrieved by calling `Fcl.authenticate()`.
```kotlin
when (val result = Fcl.authenticate()) {
is Result.Success -> {
val address = result.value
}
is Result.Failure -> {
// Handle error
}
}
```
Proof of Authentication
-------
A common desire that application developers have is to be able to prove that a user controls an
on-chain account. Proving ownership of an on-chain account is a way to authenticate a user with an
application backend. Fortunately, FCL provides a way to achieve this.
### Authenticating a user using `AccountProof`
By supplying `AccountProofData` to authenticate, the signatures will be acquired and set to the
current user in `config`
.
```kotlin
when (val result = Fcl.authenticate(accountProofData)) {
is Result.Success -> {
val address = result.value
}
is Result.Failure -> {
// Handle error
}
}
```
Verify `AccountProof`
-------
If you've acquired account proof signed data from `authenticate`, you may retrieve the signatures
from `config`.
```kotlin
val accountProofData = Fcl.currentUser?.accountProofData
```
Then you can verify the signatures by calling `Fcl.verifyAccountProof()`.
```kotlin
when (val result = Fcl.verifyAccountProof(FLOW_APP_IDENTIFIER, accountProofData)) {
is Result.Success -> {
val isValid = reuslt.value
}
is Result.Failure -> {
// Handle error
}
}
```
[Learn more about account proof][3]
Sign a message
-------
Cryptographic signatures are a key part of the blockchain. They are used to prove ownership of an
address without exposing its private key. While primarily used for signing transactions,
cryptographic signatures can also be used to sign arbitrary messages.
To sign a message, simply call `Fcl.signUserMessage`.
```kotlin
when (val result = Fcl.signUserMessage(message)) {
is Result.Success -> {
val userSignatures = result.value
}
is Result.Failure -> {
// Handle error
}
}
```
Verify user signatures
-------
```kotlin
when (val result = Fcl.verifyUserSignatures(userMessage, userSignatures)) {
is Result.Success -> {
val isValid = reuslt.value
}
is Result.Failure -> {
// Handle error
}
}
```
Blockchain Interactions
-------
- `Fcl.query()`: Send arbitrary Cadence scripts to the chain and receive back decoded values
- `Fcl.mutate()`: Send arbitrary transactions with your own signatures or via a user's wallet to
perform state changes on chain
[Learn more about on-chain interactions][4]
### Utilities
- Get account details from any Flow address
```kotlin
// suspending function
val account: FlowAccount = AppUtils.getAccount(address)
```
- Get the latest block
```kotlin
// suspending function
val latestBlock: FlowBlock = AppUtils.getLatestBlock()
```
- Get transaction status
```kotlin
// suspending function
val result = Fcl.getTransactionStatus(transactionId)
```
Support
-------
To report a specific problem or feature request, [open a new issue on Github][8]. For questions,
suggestions, or anything else, feel free to join FCL-Android's [Discussion][9].
License
-------
See the [LICENSE][6] file for details.
[1]: https://blocto.io/
[2]: https://www.meetdapper.com
[3]: https://developers.flow.com/tools/fcl-js/reference/proving-authentication#authenticating-a-user-using-account-proof
[4]: https://docs.onflow.org/fcl/reference/api/#on-chain-interactions
[5]: https://forum.onflow.org/c/developer-tools/flow-fcl/22
[6]: https://github.com/portto/fcl-android/blob/main/LICENSE
[7]: https://docs.blocto.app/blocto-sdk/android-sdk/flow
[8]: https://github.com/portto/fcl-android/issues/new/choose
[9]: https://github.com/portto/fcl-android/discussions
[10]: https://github.com/onflow/flow-jvm-sdk#gradle