Generate fcl-js binding files

[bthaile]

Given a interactive template (flix) need to create binding files. Task should address local development.

In current Cadence vs code project structure, bindings files can be generated to "bindings" folder by default. For CLI configuration user passes in "Cadence" folder and all transactions and scripts will be discovered and templates generated to "templates" directory and binding generated to "bindings" folder.

Tasks:

• [x] Generate plain vanilla Javascript
  • [x] handle both local & remote
• [x] Generate js docs (typescript)
  • [x] handle both local & remote
• [ ] Generate Golang (tracked in https://github.com/onflow/flixkit-go/issues/17)

Sub Tasks:

• [ ] verify parameters have not changed at run time
  • FLIX template file is pulled in at runtime.
  • Bindings only need to change if arguments changed or contract addresses.
• [ ] Handle structs as arguments
• [ ] Handle complex built-in Cadence types

Note:

Reference: Cadut uses handlebar templates to generate javascript files.

Binding should have a hash template interface (arguments) and verify the hash has not changed at runtime.

Example javascript binding that uses a URL to flix

import * as fcl from @onflow/fcl

const params =  { "amount": "UFix64", "to": "Address"}
const templateURL = "https://flix.flow.com/v1/templates?name=transfer-flow"

export async function TemplateName({to, amount }) {
  // check argument hash
  let hashMatches = false;
  let hasError = false;
  try {
        const response = await fetch(templateURL);
        // Check if the request was successful
        if (response.ok) {
          const templateData = await response.json();  // Convert response to JSON
          doesMatches = matchParams(templateData.parameters, params)
        } else {
          throw new Error(`Failed to fetch: ${response.status} ${response.statusText}`);
        }
   } catch (error) {
      console.error(error)  // need better way to convey errors than console log and eat
      hasError = true
  } 
  if (!doesMatches) return 
   return request({to, amount});
}

async function request({ to, amount }) {
  const transactionId = await fcl.mutate({
    template: templateURL,
    args: (arg, t) => ([ arg(to, t.Address), arg(amount, t.UFix64)])
  })

  return transactionId
}

[chasefleming]

I'm not sure TS or JS bindings should be generated in this library. I'm wondering if this should be a separate lib (maybe even a TS lib).

[bjartek]

Go has the ability to parse the program and get out information from it so i think go is the right choixe here. The code should also support generating go bindings.

[bthaile]

@chasefleming I was thinking this flixkit-go would be all things flix.

• running flix
• generating flix
• migrating versions

• generating binding files

  • js
  • ts
  • go

  Also, my thinking was that flow-cli is already bringing in this lib to do flix stuff.