LLM Notice: This documentation site supports content negotiation for AI agents. Request any page with Accept: text/markdown or Accept: text/plain header to receive Markdown instead of HTML. Alternatively, append ?format=md to any URL. All markdown files are available at /md/ prefix paths. For all content in one file, visit /llms-full.txt
Skip to main content

Flow Interaction Templates

Flow Interaction Templates (FLIX) is a standard for how contract developers, wallets, users, auditors, and applications can create, audit, and verify the intent, security, and metadata of Flow scripts and transactions, with the goal to improve the understandability and security of transaction authorizations and promote patterns for change resilient composability of applications on Flow.

Interaction Templates provide a way to use and reuse current scripts and transactions, as well as to provide more metadata such as a human-readable title and description of what the transaction or script will do, which the developer can use, as well as the application user.

With FLIX transactions and scripts, developers don't have to write their own for common operations!

Read more about the design and purpose of FLIX in the FLIP.

Use FLIX​

Flow makes FLIX available through an API available at flix.flow.com.

You can query a FLIX API to get an Interaction Template. An example query looks like this.

You can read more about how to query a FLIX API in the documentation available here.

info

The FLIX working group is currently working on a protocol to publish FLIX templates onchain.

Example​

How to integrate FLIX across different developer teams? For this example there are two GitHub repositories.

The Smart contract developer creates FLIX templates and makes them available in GitHub, these can be versioned. Example is v0.1.0 release, the templates are available for a specific version. In this example the templates are located at:

Developers can use FLIX templates from the smart contract github to interact with their smart contracts. They simply need the FLIX template URLs to create binding files (TypeScript or JavaScript). One major benefit is the web developers don't need to learn Cadence or copy Cadence to their repository in order to integrate with current smart contracts.

TypeScript code generated from templates:

warning

manually added "@ts-ignore" in generated file because of linting error. 'template' property is typed as "object" when it should also allow strings (url to flix template file). There is current a dev effort that will fix this linting issue.

See the hello-world-web [README]for more information on how to generate and execute FLIX templates here.

[flow-cli flix]

Clients​

There are currently two clients that have integrated with FLIX that you can use:

Go client [https://github.com/onflow/flixkit-go]

FCL client you read how to get started [tools/clients/fcl-js/interaction-templates]

(Advanced) Run a FLIX API​

Flow provides an implementation of the Flow interaction template service as an open-source project. If you wish to run your own API, you can find the repository at [https://github.com/onflow/flow-interaction-template-service].

[https://github.com/onflow/hello-world-flix]: https://github.com/onflow/hello-world-flix) [https://github.com/onflow/hello-world-web]: https://github.com/onflow/hello-world-web) [README]: https://github.com/onflow/hello-world-web/tree/main [flow-cli flix]: ../../../build/tools/flow-cli/flix.md [https://github.com/onflow/flixkit-go]: https://github.com/onflow/flixkit-go [tools/clients/fcl-js/interaction-templates]: ../../../build/tools/clients/fcl-js/interaction-templates.mdx [https://github.com/onflow/flow-interaction-template-service]: https://github.com/onflow/flow-interaction-template-service

Rate this page