[fiojs-examples] Initial framework and example

Description

Tracks the initial setup of a fiojs-examples repo with an initial example.

The fioprotocol/fiojs-examples repository has been created and admin permissions granted.

High level requirements:

  • It would be best if the fiojs is the only dependency in package.json

  • It should be easy to refer integrators to the different examples in the library. So, the design should be that each “example” is somewhat standalone. It may make sense to centralize some functions, but we should try to be as explicit as possible for each example so integrators do not have to dig into a bunch of included functions.

  • Here is the fiosdk example repo that integrators use. We want something similar for fiojs: https://github.com/fioprotocol/fiosdk_typescript-examples (this was built by Eric and so is probably not a great JS architecture…)

  • We should probably publish a release of fiojs 😆

  • For the first example let’s do trnsfiopubky. Here is the current fiojs example for transfer: https://github.com/fioprotocol/fiosdk_typescript-examples/blob/main/fiojs.token-trnsfiopubky.js

    • This was created by one of our block producers. It would be great to improve on it / clean it up.

  • For naming the examples I like:

fiojs-trnsfiopubky.js

fiojs.trnsfiopubky.js

Assuming each example is in its own file. If there is a better structure, I am good with that as well. This will mainly be used by FE developers for wallets and exchanges so should be easy for them to understand and copy code from.

Activity

Show:

Eric Butz April 8, 2022 at 4:48 PM

If it makes more sense, we can work on the examples under fiojs/src/tests

Unresolved

Details

Assignee

Reporter

Priority

Checklist

Created April 7, 2022 at 8:38 PM
Updated March 16, 2023 at 9:42 PM

Flag notifications