Cadence Library Ideas

[joshuahannan]

Issue To Be Solved

There are many different programming libraries that could be useful in Cadence and this issue will be a place to discuss and catalog them.

Suggest A Solution

Please leave comments in this issue if you think of a library that would be useful add. This issue will also be updated with ideas as they are added. If you want to build one, you can choose one from the list and build it yourself! 😃

When adding a new template:

0. Create an issue for the library you are adding and assign it to yourself. Leave a comment on this post that you are working on it. Include any relevant questions or discussion about your template in the issue that you create.
1. Write the library as a .cdc file and save it in the contracts directory.
2. Write example transactions for using your library and save them in the transactions/ directory.
3. Use transaction parameters instead of hard-coded values.
4. Write a go template getter in lib/go/templates/ and run make generate in that directory.
5. Write tests for your library functions and transactions in lib/go/test/ and make sure the test passes.
6. Ensure that your libraries, templates, and tests are well commented.

Template Suggestions

Feel free to choose a library idea from this list to work on, or make a comment to add your own idea.

• String utility functions (slice, substring, etc): Example for solidity: https://github.com/Arachnid/solidity-stringutils
• Array utility functions (sorting, sum, getMax, etc): Example for Solidity: https://github.com/Modular-Network/ethereum-libraries-array-utils
• Linked list library: Example for solidity: https://github.com/modular-network/ethereum-libraries/tree/master/LinkedListLib
• Math utilities: (square root, cube root, etc)
• Anything else you can think of that might be useful!

[joshuahannan]

Anybody else have any ideas for libraries that would be useful for Cadence? Feel free to add a comment here if you have a new idea. Also, any of the ideas that are in this post are up for grabs if you'd like to take a stab at writing one yourself! I'll be able to give you all the assistance you need. 😃

[franklywatson]

Some possible candidates for this in Austin's repo: https://github.com/green-goo-dao/flow-utils/tree/main/cadence/contracts