FLIP - Interaction Templates v1.1.0

[JeffreyDoyle]

FLIP - Interaction Templates v1.1.0

Overview

This update to the InteractionTemplate and InteractionTemplateInterface data structures is the result of the need to better define the order of various properties of the InteractionTemplate and InteractionTemplateInterface, for use during the serialization process required for ID generation.

This change uses JSON Arrays to express the order of certain elements of the InteractionTemplate and InteractionTemplateInterface, instead of Objects as we're previously used which do not have a notion of order.

Required updates

• FCL Interaction Template utils updated to support v1.1.0 of InteractionTemplate and InteractionTemplateInterface (Support v1.1.0 of InteractionTemplate and InteractionTemplateInterface fcl-js#1614)
• FCL Query/Mutate updated to support v1.1.0 of InteractionTemplate
• FLIX Interaction Templates migrated to version v1.1.0
• Interaction Template Tools (CLI, WebApp and JS Utils) updated to support version v1.1.0

[bjartek]

Should we consider changing the way pins are generated as well here to be debth first since we are creating a new version?

I think the pin should be sha3(your_code, sha3(dep1), sha3(dep2)) or something like that so if you have done sha3(dep1) you can memoize that for all FLIX. Or even cache it.

[m-Peter]

After finding out about this from @bjartek, I am posting here the original message from a relevant message on Flow's discord:

I have a question about the "identity" of scripts & transactions, and would like the team's input on a possible solution. As @Destructor has initially pointed out here (onflow/Offers#1 (comment)), it is difficult to correlate script/transaction hash IDs, with their respective source files. This affects only scripts/transactions that are used during local development (excluding ones that might be generated dynamically, by string templates or something similar). After a call with @sideninja.find , we realized that this would be needed for other tools as well, besides code coverage/testing framework, e.g profilers. I understand that scripts&transactions do not reside on-chain, like contracts do, hence they do not need some human-friendly identifier. But it would enhance DevEx, if we could correlated them somehow, with the names of their respective source files. Where would be the ideal codebase to add such a functionality? (e.g Cadence/Emulator/CLI etc).

We would like, if it's somehow possible, to have https://github.com/onflow/flow-interaction-template-tools/tree/master/cli integrated in flow-cli, in order to have a more human-friendly identifier for scripts&transactions.

[sideninja]

@m-Peter I think this could be an improvement to an existing solution that is currently lacking. The way I see is we have to solve this problem for any transaction or script, then after we solve the mapping we can improve the mapping for flix templates by integrating into flix. I don't see the other way around to be better.

[bthaile]

Support new import syntax: In order to be consistent across all flow tools, it would be beneficial for flix to support new import syntax. This syntax does not have a contract address placeholder in the cadence code. It uses import "ContractName" which is interpreted by flow tools. The change needed is in the "dependencies" section, the contract address placeholder isn't needed. See below:

Pervious version:

dependencies: {
      "0xFUNGIBLETOKENADDRESS": { // Network (mainnet || testnet) dependent locations for 0xFUNGIBLETOKENADDRESS contract.
          "FungibleToken" : {
              mainnet: {
                  address: "0xf233dcee88fe0abe", // Address of the account the contract is located.
                  fq_address: "A.0xf233dcee88fe0abe.FungibleToken", // Fully qualified contract identifier.
                  pin: "asdfasdfasdfasdfasdfasdfsadf123123123123", // Unique identifier of the interactions dependency tree.
                  pin_block_height: 10123123123 // Block height the pin was generated against.
              },
              testnet: {
                  address: "0x9a0766d93b6608b7",
                  fq_address: "A.0x9a0766d93b6608b7.FungibleToken",
                  pin: "asdfasdfasdfasdfasdfasdfsadf123123123123",
                  pin_block_height: 10123123123
              }
          }
      }
  },

New version:

dependencies: {
    "FungibleToken" : {
        mainnet: {
            address: "0xf233dcee88fe0abe", // Address of the account the contract is located.
            fq_address: "A.0xf233dcee88fe0abe.FungibleToken", // Fully qualified contract identifier.
            pin: "asdfasdfasdfasdfasdfasdfsadf123123123123", // Unique identifier of the interactions dependency tree.
            pin_block_height: 10123123123 // Block height the pin was generated against.
        },
        testnet: {
            address: "0x9a0766d93b6608b7",
            fq_address: "A.0x9a0766d93b6608b7.FungibleToken",
            pin: "asdfasdfasdfasdfasdfasdfsadf123123123123",
            pin_block_height: 10123123123
        }
    }
},

[JeffreyDoyle]

Updates according to feedback from the Interaction Template working group on August 14 2023

[JeffreyDoyle]

Adding comments from working group Nov 9

[JeffreyDoyle]

Hello all!

As per the FLIX Working Group's previous meeting on November 9th 2023, the group has aligned on the following updates to the FLIX specification to be included in version 1.1:

• Add support for the "new import syntax" in the cadence included in the Interaction Template
• Add the full dependency tree inside the Interaction Template's dependency section.
• Use the depth first search algorithm proposed by @bjartek for computing dependency pins (see: FLIP - Interaction Templates v1.1.0 #77 (comment))
• Include hashes of the cadence included in the Interaction Template resolved per each supported network.

The following updates are reflected in the FLIP as of the date of this comment (Nov 14 2023). Please let us know if you have any thoughts or feedback!

--

If you're not in the FLIX working group and would like to be, please feel free to send an email to wallet-wg@flow.com and we will include you in the following meeting invites! 😄

[bthaile]

congrates, looks good

[gregsantos]

lg2G

[JeffreyDoyle]

Merging as accepted as per the decision in the FLIX working group on Nov 21 🎉