Skip to content

Commit

Permalink
DOC -- [fcl] Discovery docs update and mark alpha (onflow#911)
Browse files Browse the repository at this point in the history
  • Loading branch information
chasefleming authored Dec 3, 2021
1 parent ce283fa commit dd6d757
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
20 changes: 10 additions & 10 deletions docs/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,15 +257,15 @@ addStuff().then((d) => console.log(d)); // 13 (5 + 7 + 1)

### Common Configuration Keys

| Name | Example | Description |
| Name | Example | Description |
| --------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accessNode.api` **(required)** | `https://access-testnet.onflow.org` | API URL for the Flow Blockchain Access Node you want to be communicating with. See all available access node endpoints [here](https://docs.onflow.org/access-api/#flow-access-node-endpoints). |
| `env` | `testnet` | Used in conjunction with stored interactions. Possible values: `local`, `canarynet`, `testnet`, `mainnet` |
| `discovery.wallet` **(required)** | `https://fcl-discovery.onflow.org/testnet/authn` | Points FCL at the Wallet or Wallet Discovery mechanism. |
| `discovery.authn.endpoint` | `https://fcl-discovery.onflow.org/api/testnet/authn` | Endpoint for alternative configurable Wallet Discovery mechanism. Read more on [discovery](#discovery) |
| `app.detail.title` | `Cryptokitties` | Your applications title, can be requested by wallets and other services. |
| `app.detail.icon` | `https://fcl-discovery.onflow.org/images/blocto.png` | Url for your applications icon, can be requested by wallets and other services. |
| `challenge.handshake` | **DEPRECATED** | Use `discovery.wallet` instead. |
| `accessNode.api` **(required)** | `https://access-testnet.onflow.org` | API URL for the Flow Blockchain Access Node you want to be communicating with. See all available access node endpoints [here](https://docs.onflow.org/access-api/#flow-access-node-endpoints). |
| `env` | `testnet` | Used in conjunction with stored interactions. Possible values: `local`, `canarynet`, `testnet`, `mainnet` |
| `discovery.wallet` **(required)** | `https://fcl-discovery.onflow.org/testnet/authn` | Points FCL at the Wallet or Wallet Discovery mechanism. |
| `discovery.authn.endpoint` **(alpha)** | `https://fcl-discovery.onflow.org/api/testnet/authn` | Endpoint for alternative configurable Wallet Discovery mechanism. Read more on [discovery](#discovery) |
| `app.detail.title` | `Cryptokitties` | Your applications title, can be requested by wallets and other services. |
| `app.detail.icon` | `https://fcl-discovery.onflow.org/images/blocto.png` | Url for your applications icon, can be requested by wallets and other services. |
| `challenge.handshake` | **DEPRECATED** | Use `discovery.wallet` instead. |

### Address replacement in scripts and transactions

Expand Down Expand Up @@ -588,7 +588,7 @@ export const signMessage = async () => {
---
### Discovery
### Discovery **(alpha)**
## `discovery`
Expand Down Expand Up @@ -622,7 +622,7 @@ function Component() {
return (
<div>
{services.map(service => <button key={service.id} onClick={() => fcl.authenticate({ service })}>Login with {service.provider.name}</button>)}
{services.map(service => <button key={service.provider.address} onClick={() => fcl.authenticate({ service })}>Login with {service.provider.name}</button>)}
</div>
)
}
Expand Down
2 changes: 1 addition & 1 deletion packages/fcl/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ function Component() {

return (
<div>
{services.map(service => <button key={service.id} onClick={() => fcl.authenticate({ service })}>Login with {service.provider.name}</button>)}
{services.map(service => <button key={service.provider.address} onClick={() => fcl.authenticate({ service })}>Login with {service.provider.name}</button>)}
</div>
)
}
Expand Down

0 comments on commit dd6d757

Please sign in to comment.