How to Configure FCL
Configuration
FCL has a mechanism that lets you configure various aspects of FCL. The main idea here (from an FCL perspective) should be that when you move from one instance of the Flow Blockchain to another (Local Emulator to Testnet to Mainnet) the only thing you should need to change (once again from an FCL perspective) is your configuration.
Setting Configuration Values
Values only need to be set once. We recomend doing this once and as early in the life cycle as possible.
To set a configuation value, the put
method on the config
instance needs to be called, the put
method returns the config
instance so they can be chained.
_10import * as fcl from '@onflow/fcl';_10_10fcl_10 .config() // returns the config instance_10 .put('foo', 'bar') // configures "foo" to be "bar"_10 .put('baz', 'buz'); // configures "baz" to be "buz"
Getting Configuration Values
The config
instance has an asynchronous get
method. You can also pass it a fallback value incase the configuration state does not include what you are wanting.
_15import * as fcl from '@onflow/fcl';_15_15fcl.config().put('foo', 'bar').put('woot', 5).put('rawr', 7);_15_15const FALLBACK = 1;_15_15async function addStuff() {_15 var woot = await fcl.config().get('woot', FALLBACK); // will be 5 -- set in the config before_15 var rawr = await fcl.config().get('rawr', FALLBACK); // will be 7 -- set in the config before_15 var hmmm = await fcl.config().get('hmmm', FALLBACK); // will be 1 -- uses fallback because this isnt in the config_15_15 return woot + rawr + hmmm;_15}_15_15addStuff().then((d) => console.log(d)); // 13 (5 + 7 + 1)
Common Configuration Keys
accessNode.api
-- Api URL for the Flow Blockchain Access Node you want to be communicating with.app.detail.title
- (INTRODUCED@onflow/fcl@0.0.68
) Your applications title, can be requested by wallets and other services. Used by WalletConnect plugin & Wallet Discovery service.app.detail.icon
- (INTRODUCED@onflow/fcl@0.0.68
) Url for your applications icon, can be requested by wallets and other services. Used by WalletConnect plugin & Wallet Discovery service.app.detail.description
- (INTRODUCED@onflow/fcl@1.11.0
) Your applications description, can be requested by wallets and other services. Used by WalletConnect plugin & Wallet Discovery service.app.detail.url
- (INTRODUCED@onflow/fcl@1.11.0
) Your applications url, can be requested by wallets and other services. Used by WalletConnect plugin & Wallet Discovery service.challenge.handshake
-- (DEPRECATED@onflow/fcl@0.0.68
) Points FCL at the Wallet or Wallet Discovery mechanism.discovery.wallet
-- (INTRODUCED@onflow/fcl@0.0.68
) Points FCL at the Wallet or Wallet Discovery mechanism.discovery.wallet.method
-- Describes which service strategy a wallet should use:IFRAME/RPC
,POP/RPC
,TAB/RPC
,HTTP/POST
,EXT/RPC
env
-- (DEPRECATED@onflow/fcl@1.0.0
) Used in conjunction with stored interactions. Possible values:local
,testnet
,mainnet
fcl.limit
-- Specifies fallback compute limit if not provided in transaction. Provided as integer.flow.network
(recommended) -- (INTRODUCED@onflow/fcl@1.0.0
) Used in conjunction with stored interactions and provides FCLCryptoContract address fortestnet
andmainnet
. Possible values:local
,testnet
,mainnet
.service.OpenID.scopes
- (INTRODUCED@onflow/fcl@0.0.68
) Open ID Connect claims for Wallets and OpenID services.walletconnect.projectId
-- (INTRODUCED@onflow/fcl@1.11.0
) Your app's WalletConnect project ID. See WalletConnect Cloud to obtain a project ID for your application.walletconnect.disableNotifications
-- (INTRODUCED@onflow/fcl@1.13.0
) Flag to disable pending WalletConnect request notifications within the application's UI. Default isfalse
.
Using Contracts in Scripts and Transactions
Address Replacement
Configuration keys that start with 0x
will be replaced in FCL scripts and transactions, this allows you to write your script or transaction Cadence code once and not have to change it when you point your application at a difference instance of the Flow Blockchain.
_27import * as fcl from '@onflow/fcl';_27_27fcl.config().put('0xFungibleToken', '0xf233dcee88fe0abe');_27_27async function myScript() {_27 return fcl_27 .send([_27 fcl.script`_27 import FungibleToken from 0xFungibleToken // will be replaced with 0xf233dcee88fe0abe because of the configuration_27_27 access(all) fun main() { /* Rest of the script goes here */ }_27 `,_27 ])_27 .then(fcl.decode);_27}_27_27async function myTransaction() {_27 return fcl_27 .send([_27 fcl.transaction`_27 import FungibleToken from 0xFungibleToken // will be replaced with 0xf233dcee88fe0abe because of the configuration_27_27 transaction { /* Rest of the transaction goes here */ }_27 `,_27 ])_27 .then(fcl.decode);_27}
Example
_13import * as fcl from '@onflow/fcl';_13_13fcl_13 .config()_13 .put('flow.network', 'testnet')_13 .put('accessNode.api', 'https://rest-testnet.onflow.org')_13 .put('discovery.wallet', 'https://fcl-discovery.onflow.org/testnet/authn')_13 .put('walletconnect.projectId', 'YOUR_PROJECT_ID')_13 .put('app.detail.title', 'Test Harness')_13 .put('app.detail.icon', 'https://i.imgur.com/r23Zhvu.png')_13 .put('app.detail.description', 'A test harness for FCL')_13 .put('app.detail.url', 'https://myapp.com')_13 .put('0xFlowToken', '0x7e60df042a9c0868');
Using Flow.json
A simpler way to import contracts in scripts and transactions is to use the config.load
method to ingest your contracts from your flow.json
file. This keeps the import syntax unified across tools and lets FCL figure out which address to use for what network based on the network provided in config. To use config.load
you must first import your flow.json
file and then pass it to config.load
as a parameter.
_10import { config } from '@onflow/fcl';_10import flowJSON from '../flow.json';_10_10config({_10 'flow.network': 'testnet',_10 'accessNode.api': 'https://rest-testnet.onflow.org',_10 'discovery.wallet': `https://fcl-discovery.onflow.org/testnet/authn`,_10}).load({ flowJSON });
Let's say your flow.json
file looks like this:
_10{_10 "contracts": {_10 "HelloWorld": "cadence/contracts/HelloWorld.cdc"_10 }_10}
Then in your scripts and transactions, all you have to do is:
_10import "HelloWorld"
FCL will automatically replace the contract name with the address for the network you are using.
Note: never put private keys in your
flow.json
. You should use the key/location syntax to separate your keys into a separate git ignored file.