koilib 5.4.0 → 5.5.0

package/lib/browser/Transaction.js

@@ -119,7 +119,7 @@ class Transaction {
             };
             this.transaction.header = {
                 ...this.transaction.header,
-                header,
+                ...header,
             };
         }
         if (this.signer) {

package/lib/browser/Transaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../src/Transaction.ts"],"names":[],"mappings":";;;AAEA,qCAAkC;AAWlC,MAAa,WAAW;IA0BtB,YAAY,CAIX;;QACC,IAAI,CAAC,MAAM,GAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,MAAM,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG;YACb,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,GAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO;SACd,CAAC;QACF,IAAI,CAAC,WAAW,GAAG;YACjB,MAAM,EAAE;gBACN,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,OAAO,KAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBAC3D,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,OAAO,KAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBAC3D,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACpD,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACpD,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;aACrD;YACD,UAAU,EAAE,EAAE;SACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,KAAK,CAAC,aAAa,CACjB,KAI8B,EAC9B,IAAc;QAEd,IAAI,SAAwB,CAAC;QAC7B,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;YAC/B,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YAC1D,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;SAC9B;aAAM;YACL,IAAI,GAAiD,CAAC;YACtD,IAAI,KAAK,YAAY,OAAO,EAAE;gBAC5B,GAAG,GAAG,MAAM,KAAK,CAAC;aACnB;iBAAM;gBACL,GAAG,GAAG,KAAK,CAAC;aACb;YACD,IAAK,GAAoC,CAAC,SAAS,EAAE;gBACnD,SAAS,GAAI,GAAoC,CAAC,SAAS,CAAC;aAC7D;iBAAM;gBACL,SAAS,GAAG,KAAsB,CAAC;aACpC;SACF;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU;YAAE,IAAI,CAAC,WAAW,CAAC,UAAU,GAAG,EAAE,CAAC;QACnE,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,OAA4B;QACxC,IAAI,OAAO,EAAE;YACX,MAAM,MAAM,GAAG;gBACb,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;gBACtD,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;gBACtD,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;gBAC/C,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;gBAC/C,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;aAChD,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG;gBACxB,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM;gBAC1B,MAAM;aACP,CAAC;SACH;QAED,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC3E;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE;gBAC9D,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;aACrC;YACD,MAAM,MAAM,GAAG,eAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YAChC,IAAI,CAAC,WAAW,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACtE;QACD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,IAA0B;QACnC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAAE,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAChC,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CACzC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,OAAgC;QACzC,MAAM,IAAI,GAAG;YACX,GAAG,IAAI,CAAC,OAAO;YACf,OAAO;SACR,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAAE,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACvC,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CACpE,IAAI,CAAC,WAAW,EAChB,IAAI,CACL,CAAC;YACF,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC;YAC5B,OAAO,OAAO,CAAC;SAChB;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE;YACvE,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;SACzE;QAED,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,CACtE,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,SAAS,CACf,CAAC;QACF,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC;QAC5B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI,CACR,IAAoC,EACpC,OAAgB;QAKhB,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF;AAnOD,kCAmOC"}
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../src/Transaction.ts"],"names":[],"mappings":";;;AAEA,qCAAkC;AAWlC,MAAa,WAAW;IA0BtB,YAAY,CAIX;;QACC,IAAI,CAAC,MAAM,GAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,MAAM,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,QAAQ,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG;YACb,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,GAAG,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO;SACd,CAAC;QACF,IAAI,CAAC,WAAW,GAAG;YACjB,MAAM,EAAE;gBACN,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,OAAO,KAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBAC3D,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,OAAO,KAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBAC3D,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACpD,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACpD,GAAG,CAAC,CAAA,MAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,0CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;aACrD;YACD,UAAU,EAAE,EAAE;SACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,KAAK,CAAC,aAAa,CACjB,KAI8B,EAC9B,IAAc;QAEd,IAAI,SAAwB,CAAC;QAC7B,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;YAC/B,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YAC1D,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;SAC9B;aAAM;YACL,IAAI,GAAiD,CAAC;YACtD,IAAI,KAAK,YAAY,OAAO,EAAE;gBAC5B,GAAG,GAAG,MAAM,KAAK,CAAC;aACnB;iBAAM;gBACL,GAAG,GAAG,KAAK,CAAC;aACb;YACD,IAAK,GAAoC,CAAC,SAAS,EAAE;gBACnD,SAAS,GAAI,GAAoC,CAAC,SAAS,CAAC;aAC7D;iBAAM;gBACL,SAAS,GAAG,KAAsB,CAAC;aACpC;SACF;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU;YAAE,IAAI,CAAC,WAAW,CAAC,UAAU,GAAG,EAAE,CAAC;QACnE,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,OAA4B;QACxC,IAAI,OAAO,EAAE;YACX,MAAM,MAAM,GAAG;gBACb,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;gBACtD,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;gBACtD,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;gBAC/C,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;gBAC/C,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,KAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;aAChD,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG;gBACxB,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM;gBAC1B,GAAG,MAAM;aACV,CAAC;SACH;QAED,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC3E;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE;gBAC9D,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;aACrC;YACD,MAAM,MAAM,GAAG,eAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACpC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YAChC,IAAI,CAAC,WAAW,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACtE;QACD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,IAA0B;QACnC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAAE,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAChC,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CACzC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,OAAgC;QACzC,MAAM,IAAI,GAAG;YACX,GAAG,IAAI,CAAC,OAAO;YACf,OAAO;SACR,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAAE,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACvC,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CACpE,IAAI,CAAC,WAAW,EAChB,IAAI,CACL,CAAC;YACF,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC;YAC5B,OAAO,OAAO,CAAC;SAChB;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE;YACvE,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;SACzE;QAED,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,CACtE,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,SAAS,CACf,CAAC;QACF,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC;QAC5B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI,CACR,IAAoC,EACpC,OAAgB;QAKhB,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF;AAnOD,kCAmOC"}

package/lib/browser/interface.d.ts

@@ -3,11 +3,15 @@ import { Serializer } from "./Serializer";
 /**
  * Application Binary Interface (ABI)
  *
- * ABIs are composed of 2 elements: methods and types.
+ * ABIs are composed of 3 elements: methods, events, and types.
  * - The methods define the names of the entries of the smart contract,
  * the corresponding endpoints and the name of the types used.
- * - The types all the description to serialize and deserialize
- * using proto buffers.
+ * - The events define possible events triggered by the smart contract
+ * and the name of the types used.
+ * - The types contain the description to serialize and deserialize
+ * data using proto buffers. It is used to encode/decode the methods
+ * and events. These types can be provided in binary format or json
+ * format (koilib_types)
  *
  * To generate the types is necessary to use the dependency
  * protobufjs. The following example shows how to generate the
@@ -49,7 +53,12 @@ import { Serializer } from "./Serializer";
  *       return: "mint_result",
  *     },
  *   },
- *   types: tokenJson,
+ *   events: {
+ *     'koinos.contracts.token.mint_event': {
+ *       argument: "mint"
+ *     },
+ *   },
+ *   koilib_types: tokenJson,
  * };
  * ```
  *
@@ -58,6 +67,95 @@ import { Serializer } from "./Serializer";
  * empty response (for instance when there are no balance records
  * for a specific address) and you require a default output in
  * such cases.
+ *
+ * **Definition of events**
+ *
+ * There are 2 ways to define events in koinos:
+ * - Event names as protobuffer names
+ * - Custom event names
+ *
+ * 1. Event names as protobuffer names: The name of the event links
+ * with the protobuffer definition. In this case there is no need
+ * to define the event in the ABI.
+ *
+ * Example:
+ *
+ * Proto definition
+ * ```
+ * package koinos.contracts.token;
+ *
+ * message transfer_arguments {
+ *    bytes from = 1 [(btype) = ADDRESS];
+ *    bytes to = 2 [(btype) = ADDRESS];
+ *    uint64 value = 3 [jstype = JS_STRING];
+ * }
+ *
+ * message transfer_event {
+ *    bytes from = 1 [(btype) = ADDRESS];
+ *    bytes to = 2 [(btype) = ADDRESS];
+ *    uint64 value = 3 [jstype = JS_STRING];
+ * }
+ * ```
+ *
+ * Contract
+ * ```ts
+ * // token-contract.ts
+ * transfer(args: token.transfer_arguments): token.transfer_result {
+ *   ...
+ *   System.event("koinos.contracts.token.transfer_event", Protobuf.encode(event, token.transfer_event.encode), impacted);
+ * }
+ * ```
+ *
+ * 2. Custom event names: The previous definition has a limitation. It's
+ * necessary to define a proto message for each event and argument, and they can
+ * not be reused. In this second solution, the event names are defined
+ * in the ABI and they are linked with the corresponding protobuffer definitions.
+ * In this sense, they can be reused.
+ *
+ * Example
+ *
+ * Proto definition
+ * ```
+ * package koinos.contracts.token;
+ *
+ * // only 1 message
+ * message transfer {
+ *    bytes from = 1 [(btype) = ADDRESS];
+ *    bytes to = 2 [(btype) = ADDRESS];
+ *    uint64 value = 3 [jstype = JS_STRING];
+ * }
+ * ```
+ *
+ * Contract
+ * ```ts
+ * // token-contract.ts
+ *
+ * // Transfer of tokens
+ * // @event transfer_event token.transfer
+ * transfer(args: token.transfer): void {
+ *   ...
+ *   System.event("transfer_event", Protobuf.encode(event, token.transfer.encode), impacted);
+ * }
+ * ```
+ *
+ * ABI
+ * ```ts
+ * const abiToken = {
+ *   methods: {
+ *     transfer: {
+ *       entry_point: 0x62efa292,
+ *       argument: "transfer",
+ *       return: "",
+ *     },
+ *   },
+ *   events: {
+ *     'transfer_event': {
+ *       argument: "transfer"
+ *     },
+ *   },
+ *   koilib_types: tokenJson,
+ * };
+ * ```
  */
 export interface Abi {
     methods: {
@@ -84,11 +182,26 @@ export interface Abi {
             description?: string;
         };
     };
+    /**
+     * Protobuffers descriptor in binary format encoded in base64url.
+     */
+    types?: string;
     /**
      * Protobuffers descriptor in JSON format.
      * See https://www.npmjs.com/package/protobufjs#using-json-descriptors
      */
-    koilib_types: INamespace;
+    koilib_types?: INamespace;
+    /**
+     * Definition of events
+     */
+    events?: {
+        [x: string]: {
+            /** Protobuffer type for argument */
+            argument?: string;
+            /** Description of the event */
+            description?: string;
+        };
+    };
 }
 /**
  * Human readable format operation
@@ -252,8 +365,7 @@ export interface ContractTransactionOptions extends TransactionOptions {
      */
     sendTransaction?: boolean;
 }
-export interface CallContractOptions extends ContractTransactionOptions {
-}
+export declare type CallContractOptions = ContractTransactionOptions;
 export interface DeployOptions extends ContractTransactionOptions {
     /**
      * ABI
@@ -525,6 +637,16 @@ export interface ValueType {
     uint64_value?: string;
     [x: string]: unknown;
 }
+export interface EventData {
+    sequence: number;
+    source: string;
+    name: string;
+    data: string;
+    impacted: string[];
+}
+export interface DecodedEventData extends EventData {
+    args: Record<string, unknown>;
+}
 export interface TransactionReceipt {
     id: string;
     payer: string;
@@ -535,12 +657,6 @@ export interface TransactionReceipt {
     network_bandwidth_used: string;
     compute_bandwidth_used: string;
     reverted: boolean;
-    events: {
-        sequence: number;
-        source: string;
-        name: string;
-        data: string;
-        impacted: string[];
-    }[];
+    events: EventData[];
     logs: string[];
 }

package/lib/interface.d.ts

@@ -3,11 +3,15 @@ import { Serializer } from "./Serializer";
 /**
  * Application Binary Interface (ABI)
  *
- * ABIs are composed of 2 elements: methods and types.
+ * ABIs are composed of 3 elements: methods, events, and types.
  * - The methods define the names of the entries of the smart contract,
  * the corresponding endpoints and the name of the types used.
- * - The types all the description to serialize and deserialize
- * using proto buffers.
+ * - The events define possible events triggered by the smart contract
+ * and the name of the types used.
+ * - The types contain the description to serialize and deserialize
+ * data using proto buffers. It is used to encode/decode the methods
+ * and events. These types can be provided in binary format or json
+ * format (koilib_types)
  *
  * To generate the types is necessary to use the dependency
  * protobufjs. The following example shows how to generate the
@@ -49,7 +53,12 @@ import { Serializer } from "./Serializer";
  *       return: "mint_result",
  *     },
  *   },
- *   types: tokenJson,
+ *   events: {
+ *     'koinos.contracts.token.mint_event': {
+ *       argument: "mint"
+ *     },
+ *   },
+ *   koilib_types: tokenJson,
  * };
  * ```
  *
@@ -58,6 +67,95 @@ import { Serializer } from "./Serializer";
  * empty response (for instance when there are no balance records
  * for a specific address) and you require a default output in
  * such cases.
+ *
+ * **Definition of events**
+ *
+ * There are 2 ways to define events in koinos:
+ * - Event names as protobuffer names
+ * - Custom event names
+ *
+ * 1. Event names as protobuffer names: The name of the event links
+ * with the protobuffer definition. In this case there is no need
+ * to define the event in the ABI.
+ *
+ * Example:
+ *
+ * Proto definition
+ * ```
+ * package koinos.contracts.token;
+ *
+ * message transfer_arguments {
+ *    bytes from = 1 [(btype) = ADDRESS];
+ *    bytes to = 2 [(btype) = ADDRESS];
+ *    uint64 value = 3 [jstype = JS_STRING];
+ * }
+ *
+ * message transfer_event {
+ *    bytes from = 1 [(btype) = ADDRESS];
+ *    bytes to = 2 [(btype) = ADDRESS];
+ *    uint64 value = 3 [jstype = JS_STRING];
+ * }
+ * ```
+ *
+ * Contract
+ * ```ts
+ * // token-contract.ts
+ * transfer(args: token.transfer_arguments): token.transfer_result {
+ *   ...
+ *   System.event("koinos.contracts.token.transfer_event", Protobuf.encode(event, token.transfer_event.encode), impacted);
+ * }
+ * ```
+ *
+ * 2. Custom event names: The previous definition has a limitation. It's
+ * necessary to define a proto message for each event and argument, and they can
+ * not be reused. In this second solution, the event names are defined
+ * in the ABI and they are linked with the corresponding protobuffer definitions.
+ * In this sense, they can be reused.
+ *
+ * Example
+ *
+ * Proto definition
+ * ```
+ * package koinos.contracts.token;
+ *
+ * // only 1 message
+ * message transfer {
+ *    bytes from = 1 [(btype) = ADDRESS];
+ *    bytes to = 2 [(btype) = ADDRESS];
+ *    uint64 value = 3 [jstype = JS_STRING];
+ * }
+ * ```
+ *
+ * Contract
+ * ```ts
+ * // token-contract.ts
+ *
+ * // Transfer of tokens
+ * // @event transfer_event token.transfer
+ * transfer(args: token.transfer): void {
+ *   ...
+ *   System.event("transfer_event", Protobuf.encode(event, token.transfer.encode), impacted);
+ * }
+ * ```
+ *
+ * ABI
+ * ```ts
+ * const abiToken = {
+ *   methods: {
+ *     transfer: {
+ *       entry_point: 0x62efa292,
+ *       argument: "transfer",
+ *       return: "",
+ *     },
+ *   },
+ *   events: {
+ *     'transfer_event': {
+ *       argument: "transfer"
+ *     },
+ *   },
+ *   koilib_types: tokenJson,
+ * };
+ * ```
  */
 export interface Abi {
     methods: {
@@ -84,11 +182,26 @@ export interface Abi {
             description?: string;
         };
     };
+    /**
+     * Protobuffers descriptor in binary format encoded in base64url.
+     */
+    types?: string;
     /**
      * Protobuffers descriptor in JSON format.
      * See https://www.npmjs.com/package/protobufjs#using-json-descriptors
      */
-    koilib_types: INamespace;
+    koilib_types?: INamespace;
+    /**
+     * Definition of events
+     */
+    events?: {
+        [x: string]: {
+            /** Protobuffer type for argument */
+            argument?: string;
+            /** Description of the event */
+            description?: string;
+        };
+    };
 }
 /**
  * Human readable format operation
@@ -252,8 +365,7 @@ export interface ContractTransactionOptions extends TransactionOptions {
      */
     sendTransaction?: boolean;
 }
-export interface CallContractOptions extends ContractTransactionOptions {
-}
+export declare type CallContractOptions = ContractTransactionOptions;
 export interface DeployOptions extends ContractTransactionOptions {
     /**
      * ABI
@@ -525,6 +637,16 @@ export interface ValueType {
     uint64_value?: string;
     [x: string]: unknown;
 }
+export interface EventData {
+    sequence: number;
+    source: string;
+    name: string;
+    data: string;
+    impacted: string[];
+}
+export interface DecodedEventData extends EventData {
+    args: Record<string, unknown>;
+}
 export interface TransactionReceipt {
     id: string;
     payer: string;
@@ -535,12 +657,6 @@ export interface TransactionReceipt {
     network_bandwidth_used: string;
     compute_bandwidth_used: string;
     reverted: boolean;
-    events: {
-        sequence: number;
-        source: string;
-        name: string;
-        data: string;
-        impacted: string[];
-    }[];
+    events: EventData[];
     logs: string[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koilib",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "JS Koinos Library",
   "author": "Julian Gonzalez",
   "repository": {
@@ -46,6 +46,7 @@
   "dependencies": {
     "@noble/hashes": "^1.1.2",
     "@noble/secp256k1": "^1.6.3",
+    "@roamin/koinos-pb-to-proto": "^0.0.2",
     "cross-fetch": "^3.1.5",
     "multibase": "^4.0.6",
     "protobufjs": "^7.0.0"
@@ -76,6 +77,7 @@
     "rimraf": "^3.0.2",
     "ts-jest": "^28.0.8",
     "ts-loader": "^9.3.1",
+    "ts-node": "^10.9.1",
     "typedoc": "^0.23.10",
     "typescript": "^4.7.4",
     "webpack": "^5.74.0",