Skip to content

Commit

Permalink
Improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
CryptoPascal31 committed Oct 17, 2022
1 parent 9958c6f commit 1552b9a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
17 changes: 17 additions & 0 deletions docs/source/deployed.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Deployed contracts
==================

Version 0.1
~~~~~~~~~~~

Initial version

Deployed on:
* Testnet Chains 0-19
* Mainnet Chains 0-19

Modules hashs:
* **free.util-lists:** 5TByiF6OZmPLlDpiF_6h6qPf5Nr9p4dI15mKdWbpAEA
* **free.util-strings:** aOi0JgN3s59XJHYF3uofVF269nbVxVtesYZIJT-TJa4
* **free.util-math:** 8lc-vIcIuEaquiirHGc8gqg8q_u3OhhJ0HyhW_3QYTE
* **free.util-random:** RBfxKPExaz5q6i64FLA_k7UVM9MaOO0UDJulfPFZBRA
18 changes: 16 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
Pact Utilities library documentation
======================================

This library aims to provide some "high level" functions for writing Pact smart contracts.

The library contains currently more than 70 convenience functions split into 4 modules.

After using and experimenting Pact since several months, I found out that:
* Some functions were missing: (eg ``(str-to-decimal)``, ...)
* Some high level functions where needed to makes devellopment easier (eg ``(insert-at)``, instead of using ``(take)``, ``(drop)`` )
* Some processing often used in smart-contracts were a little though to do in Pact, and some new users were disappointed. (eg ``(amin)``)
* There was no simple way to generate Pseudo-Random strings and numbers in Pact.

That's why I started to write this library. Feel free to use it, fork, submits bug reports and PR.

https://github.com/CryptoPascal31/pact-util-lib/

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Contents:


util-lists.rst
util-strings.rst
util-math.rst
util-random.rst
deployed.rst

0 comments on commit 1552b9a

Please sign in to comment.