Skip to content

Commit

Permalink
Update flix advanced concept documentation (#483)
Browse files Browse the repository at this point in the history
Update flix advanced concept documentation
  • Loading branch information
JeffreyDoyle authored Dec 15, 2023
1 parent f387f80 commit 124e1b7
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions docs/build/advanced-concepts/flix.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,32 @@
sidebar_position: 3
---

# FLIX (FLIP 934)
# FLIX (Flow Interaction Templates)

This FLIP (Flow Improvement Proposal) proposes a new 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 authorizing transactions and promote patterns for change resilient composability of applications on Flow.
Flow Interaction Templates 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 authorizing transactions and promote patterns for change resilient composability of applications on Flow.

FLIX provides a way to reuse scripts and transactions as well as to provide more metadata about the scripts themselves, such as a human-readable description of what the transaction or script will do, which can be used by the developer as well as the user of the dApp.
Interaction Templates provide a way to use and reuse existing 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 can be used by the developer as well as the user of the application.

By using FLIX transactions and scripts we don’t have to write our own for common operations. Many interactions aim to achieve the same class of action according to how that action must be performed with a certain project. Classes of interactions may be things like: "Transfer", "Mint", "Bid", "List", "Destroy" etc.
By using FLIX transactions and scripts, develoeprs don’t have to write their own for common operations!

[**FLIX was defined as part of the FLIP 934**](https://github.com/onflow/flips/blob/main/application/20220503-interaction-templates.md)
Read more about the design and purpose of FLIX in the [FLIP](https://github.com/onflow/flips/blob/main/application/20220503-interaction-templates.md)

## Running FLIX
## Using FLIX

Flow provides an implementation of the Flow interaction template service as an open-source project. This gives developers a way to obtain current transactions and scripts as well as extend on the collection. You can find the repository here: https://github.com/onflow/flow-interaction-template-service
Flow makes FLIX available through an API available at flix.flow.com. Other community run APIs are available, such as flix.ecdao.org.

You can query a FLIX API to get an Interaction Template. An example query looks like: https://flix.flow.com/v1/templates?name=transfer-flow

You can read more about how to query a FLIX API in the documentation available here: [https://github.com/onflow/flow-interaction-template-service](https://github.com/onflow/flow-interaction-template-service)

### Clients

There are currently two clients integrating FLIX APIs you can use in your code.
There are currently two clients that have integrated with FLIX that you can use:

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

**FCL client you** read how to get started [tools/clients/fcl-js/interaction-templates](../../tools/clients/fcl-js/interaction-templates.mdx)

## (Advanced) Running 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 like flix.flow.com , you can find the repository here: [https://github.com/onflow/flow-interaction-template-service](https://github.com/onflow/flow-interaction-template-service)

1 comment on commit 124e1b7

@vercel
Copy link

@vercel vercel bot commented on 124e1b7 Dec 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.