@riseandshaheen/libcma 0.1.0-alpha.0

package/deps/machine-asset-tools/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/deps/machine-asset-tools/README.md

@@ -0,0 +1,237 @@
+# Cartesi Machine Assets
+
+The Cartesi Machine Assets is a C++ library to facilitate the creation and management of assets for the Cartesi Machine Rollups applications.
+
+The API is divided into two main components
+
+- parser: provides functions for common asset operations such as decoding operations and encoding deposits, withdrawals, and transfers.
+- ledger: provides functions for managing asset ledgers and performing operations such as deposits, withdrawals, and transfers.
+
+## Installation
+
+To install, download the latest release from the [GitHub releases page](https://github.com/Mugen-Builders/machine-asset-tools/releases). It contains libraries and headers files (runtime and development environments) for musl and glibc systems.
+
+If you are creating a Cartesi Rollups Application using Docker, you can add following command to your Dockerfile:
+
+```dockerfile
+ARG MACHINE_ASSET_TOOLS_VERSION
+ADD https://github.com/Mugen-Builders/machine-asset-tools/releases/download/v${MACHINE_ASSET_TOOLS_VERSION}/machine-asset-tools_glibc_riscv64_v${MACHINE_ASSET_TOOLS_VERSION}.tar.gz /tmp/
+RUN tar -xzf /tmp/machine-asset-tools_glibc_riscv64_v${MACHINE_ASSET_TOOLS_VERSION}.tar.gz -C / \
+    && rm /tmp/machine-asset-tools_glibc_riscv64_v${MACHINE_ASSET_TOOLS_VERSION}.tar.gz
+```
+
+This will add the shared library to your Docker image. You can use the `_dev` artifact to add the headers and the static library.
+
+## Usage
+
+the library is divided into two parts: parser and ledger. The former helps to parse the input data, while the latter helps to manage the ledger state.
+
+### Parser
+
+The parser helps to parse the input data, which is in the form of an abi encoded byte string for advances a JSON-rpc-like string for inspects. The parser contains functions to decode the input and store the parsed data in a struct, and encode a voucher based pn a voucher request struct.
+
+Ex. decode a Erc20 deposit:
+
+```c
+// input is a cmt_rollup_advance_t struct decoded from cmt_rollup_read_advance_state(rollup, &input)
+cma_parser_input_t parser_input;
+
+const int err = cma_parser_decode_advance(CMA_PARSER_INPUT_TYPE_ERC20_DEPOSIT, &input, &parser_input);
+if (err < 0) {
+  printf("unable to decode erc20 deposit: %d - %s\n", -err, cma_parser_get_last_error_message());
+}
+
+parser_input.erc20_deposit.sender; // sender of the deposit
+parser_input.erc20_deposit.token; // token address of the deposit
+parser_input.erc20_deposit.amount; // amount of the deposit
+parser_input.erc20_deposit.exec_layer_data; // exec layer data included on the deposit
+```
+
+Note: if the input is not a deposit, the parser can decode the input automatically by the functions selector of the payload. Use the the `CMA_PARSER_INPUT_TYPE_AUTO` type.
+
+Explore the [parser's](/include/libcma/parser.h) to learn the function definitions and structs, the [sample applications](/sample_apps), and the [tests](/tests/parser.c) to see it in use.
+
+### Ledger
+
+The ledger manages the assets of accounts. It provides functions to deposit, transfer, and withdraw assets.
+
+Ex. add a deposit to a new account:
+
+```c
+cma_ledger_t ledger;
+if (!cma_ledger_init(&ledger)) {
+  printf(cma_ledger_get_last_error_message());
+}
+
+// find/create account with ether address
+cma_ledger_account_t account = {.address = {.data = {
+  0xf3, 0x9f, 0xd6, 0xe5, 0x1a, 0xad, 0x88, 0xf6, 0xf4, 0xce, 0x6a, 0xb8, 0x82, 0x72, 0x79, 0xcf, 0xff, 0xb9, 0x22, 0x66,
+}}};
+cma_ledger_account_id_t account_id;
+if (!cma_ledger_retrieve_account(&ledger, &account_id, &account, NULL, CMA_LEDGER_ACCOUNT_TYPE_ETHER_ADDRESS, CMA_LEDGER_OP_FIND_OR_CREATE)) {
+  printf(cma_ledger_get_last_error_message());
+}
+
+// find/create asset with token address
+cma_token_address_t token_address = {.address = {.data = {
+  0x49, 0x16, 0x04, 0xc0, 0xfd, 0xf0, 0x83, 0x47, 0xdd, 0x1f, 0xa4, 0xee, 0x06, 0x2a, 0x82, 0x2a, 0x5d, 0xd0, 0x6b, 0x5d,
+}}};
+cma_ledger_asset_id_t asset_id;
+if (!cma_ledger_retrieve_asset(&ledger, &asset_id, &token_address, NULL, CMA_LEDGER_ASSET_TYPE_TOKEN_ADDRESS, CMA_LEDGER_OP_FIND_OR_CREATE)) {
+  printf(cma_ledger_get_last_error_message());
+}
+
+// amount
+cma_amount_t amount = {.data = {
+  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0d, 0xe0, 0xb6, 0xb3, 0xa7, 0x64, 0x00, 0x00,
+}};
+
+// deposit
+if (!cma_ledger_deposit(&ledger, asset_id, account_id, &amount)) {
+  printf(cma_ledger_get_last_error_message());
+}
+
+if (!cma_ledger_fini(&ledger)) {
+  printf(cma_ledger_get_last_error_message());
+}
+```
+
+The ledger uses an internal uint32 for the identification of the account and the assets. If enabled, every time you try to retrieve an asset or account that is not on the storage it creates a new one.
+
+You can create an account without any account id, so it will never be mapped to any external identifier. You can also create an account with a an ether address, so it will be mapped to an external identifier, or a 32-byte string. Note that only accounts defined by ether addresses should be able to withdraw assets from the application.
+
+The asset model defines a single model for all kinds of assets: it either has token address, token address and token id, or no token address and token id. Furthermore, the asset always may have any amount. In that sense, the differences between Ether, Erc20, Erc721, and Erc1155 are implemented on how you define the asset.
+
+Explore the [ledger's](/include/libcma/ledger.h) to learn the function definitions and structs, the [sample application](/sample_apps/wallet_app/app.cpp), and the [tests](/tests/ledger.c) to see it in use.
+
+## Reference
+
+### Parser Function selectors
+
+Advance:
+
+```c
+// Bytecode for solidity WithdrawEther(uint256,bytes) = 8cf70f0b
+WITHDRAW_ETHER = 0x8cf70f0b,
+// Bytecode for solidity WithdrawErc20(address,uint256,bytes) = 4f94d342
+WITHDRAW_ERC20 = 0x4f94d342,
+// Bytecode for solidity WithdrawErc721(address,uint256,bytes) = 33acf293
+WITHDRAW_ERC721 = 0x33acf293,
+// Bytecode for solidity WithdrawErc1155Single(address,uint256,uint256,bytes) = 8bb0a811
+WITHDRAW_ERC1155_SINGLE = 0x8bb0a811,
+// Bytecode for solidity WithdrawErc1155Batch(address,uint256[],uint256[],bytes) = 50c80019
+WITHDRAW_ERC1155_BATCH = 0x50c80019,
+
+// Bytecode for solidity TransferEther(bytes32,uint256,bytes) = ff67c903
+TRANSFER_ETHER = 0xff67c903,
+// Bytecode for solidity TransferErc20(address,bytes32,uint256,bytes) = 03d61dcd
+TRANSFER_ERC20 = 0x03d61dcd,
+// Bytecode for solidity TransferErc721(address,bytes32,uint256,bytes) = af615a5a
+TRANSFER_ERC721 = 0xaf615a5a,
+// Bytecode for solidity TransferErc1155Single(address,bytes32,uint256,uint256,bytes) = e1c913ed
+TRANSFER_ERC1155_SINGLE = 0xe1c913ed,
+// Bytecode for solidity TransferErc1155Batch(address,bytes32,uint256[],uint256[],bytes) = 638ac6f9
+TRANSFER_ERC1155_BATCH = 0x638ac6f9,
+
+// Bytecode for solidity transfer(address,uint256) = a9059cbb
+ERC20_TRANSFER_FUNCTION_SELECTOR_FUNSEL = 0xa9059cbb,
+// Bytecode for solidity safeTransferFrom(address,address,uint256) = 42842e0e
+ERC721_TRANSFER_FUNCTION_SELECTOR_FUNSEL = 0x42842e0e,
+// Bytecode for solidity safeTransferFrom(address,address,uint256,uint256,bytes) = f242432a
+ERC1155_SINGLE_TRANSFER_FUNCTION_SELECTOR_FUNSEL = 0xf242432a,
+// Bytecode for solidity safeBatchTransferFrom(address,address,uint256[],uint256[],bytes) = 2eb2c2d6
+ERC1155_BATCH_TRANSFER_FUNCTION_SELECTOR_FUNSEL = 0x2eb2c2d6,
+```
+
+Note on transfer function: the receiver parameter from the transfer functions is a 32 bytes account id. This allows transfers for the "internal" accounts. Ether addresses should be converted to 32-byte strings when used in transfers.
+
+Inspect methods:
+
+```c
+GET_BALANCE = "ledger_getBalance"
+GET_TOTAL_SUPPLY = "ledger_getTotalSupply"
+```
+
+Full inspect example:
+
+```javascript
+{
+  "method":"ledger_getBalance",
+  "params":[
+    "0xcb76129e0ed325e1e5c17f3f363bc2e93a227ecf", // required: 20-byte wallet address or 32-byte account id
+    "0xc700000000000000000000000000000000000051", // optional: 20-byte token address
+    "0x0711", // optional: 32-byte or relevant bytes token id
+    "abc" // optional: exec layer data
+  ]
+}
+
+{
+  "method":"ledger_getTotalSupply",
+  "params":[
+    "0xc700000000000000000000000000000000000051", // optional: 20-byte token address
+    "0x0711", // optional: 32-byte or relevant bytes token id
+    "abc" // optional: exec layer data
+  ]
+}
+```
+
+### Parser Functions
+
+```c
+// decode advance
+int cma_parser_decode_advance(cma_parser_input_type_t type, const cmt_rollup_advance_t *input,
+    cma_parser_input_t *parser_input);
+
+// decode inspect
+int cma_parser_decode_inspect(cma_parser_input_type_t type, const cmt_rollup_inspect_t *input,
+    cma_parser_input_t *parser_input);
+
+// encode voucher
+int cma_parser_encode_voucher(cma_parser_voucher_type_t type, const cma_abi_address_t *app_address,
+    const cma_parser_voucher_data_t *voucher_request, cma_voucher_t *voucher);
+
+// get error message
+const char *cma_parser_get_last_error_message();
+```
+
+### Ledger Functions
+
+```c
+// manage ledger class
+int cma_ledger_init(cma_ledger_t *ledger);
+int cma_ledger_fini(cma_ledger_t *ledger);
+int cma_ledger_reset(cma_ledger_t *ledger);
+
+// Retrieve/create an asset
+int cma_ledger_retrieve_asset(cma_ledger_t *ledger, cma_ledger_asset_id_t *asset_id,
+    cma_token_address_t *token_address, cma_token_id_t *token_id, cma_ledger_asset_type_t asset_type,
+    cma_ledger_retrieve_operation_t operation);
+
+// Retrieve/create an account
+int cma_ledger_retrieve_account(cma_ledger_t *ledger, cma_ledger_account_id_t *account_id,
+    cma_ledger_account_t *account, const void *addr_accid, cma_ledger_account_type_t account_type,
+    cma_ledger_retrieve_operation_t operation);
+
+// Deposit
+int cma_ledger_deposit(cma_ledger_t *ledger, cma_ledger_asset_id_t asset_id,
+    cma_ledger_account_id_t to_account_id, const cma_amount_t *deposit);
+
+// Withdrawal
+int cma_ledger_withdraw(cma_ledger_t *ledger, cma_ledger_asset_id_t asset_id,
+    cma_ledger_account_id_t from_account_id, const cma_amount_t *withdrawal);
+
+// Transfer
+int cma_ledger_transfer(cma_ledger_t *ledger, cma_ledger_asset_id_t asset_id,
+    cma_ledger_account_id_t from_account_id, cma_ledger_account_id_t to_account_id, const cma_amount_t *amount);
+
+// Get balance
+int cma_ledger_get_balance(cma_ledger_t *ledger, cma_ledger_asset_id_t asset_id,
+    cma_ledger_account_id_t account_id, cma_amount_t *out_balance);
+
+// Get total supply
+int cma_ledger_get_total_supply(cma_ledger_t *ledger, cma_ledger_asset_id_t asset_id,
+    cma_amount_t *out_total_supply);
+
+// get error message
+const char *cma_ledger_get_last_error_message();
+```

package/deps/machine-asset-tools/include/libcma/ledger.h

@@ -0,0 +1,161 @@
+#ifndef CMA_LEDGER_H
+#define CMA_LEDGER_H
+#include <stddef.h>
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Compiler visibility definition
+#ifndef CMA_LEDGER_API
+#define CMA_LEDGER_API __attribute__((visibility("default")))
+#endif
+
+#include "types.h"
+
+enum {
+    CMA_LEDGER_T_SIZE = 512, // / 8,
+    CMA_LEDGER_MIN_MEM_LENGTH = 262144,
+};
+
+typedef struct cma_ledger_struct {
+    uint64_t __opaque[CMA_LEDGER_T_SIZE];
+} cma_ledger_t;
+
+typedef uint64_t cma_ledger_account_id_t;
+typedef uint64_t cma_ledger_asset_id_t;
+
+enum {
+    CMA_LEDGER_SUCCESS = 0,
+    CMA_LEDGER_ERROR_UNKNOWN = -1001,
+    CMA_LEDGER_ERROR_EXCEPTION = -1002,
+    CMA_LEDGER_ERROR_INSUFFICIENT_FUNDS = -1003,
+    CMA_LEDGER_ERROR_ACCOUNT_NOT_FOUND = -1004,
+    CMA_LEDGER_ERROR_ASSET_NOT_FOUND = -1005,
+    CMA_LEDGER_ERROR_BALANCE_NOT_FOUND = -1006,
+    CMA_LEDGER_ERROR_SUPPLY_OVERFLOW = -1007,
+    CMA_LEDGER_ERROR_BALANCE_OVERFLOW = -1008,
+    CMA_LEDGER_ERROR_INVALID_ACCOUNT = -1009,
+    CMA_LEDGER_ERROR_INSERTION_ERROR = -1010,
+    CMA_LEDGER_ERROR_MAX_ASSETS_REACHED = -1011,
+    CMA_LEDGER_ERROR_MAX_ACCOUNTS_REACHED = -1012,
+    CMA_LEDGER_ERROR_MAX_BALANCES_REACHED = -1013,
+    CMA_LEDGER_ERROR_ASSET_SUPPLY = -1014,
+    CMA_LEDGER_ERROR_ACCOUNT_BALANCE = -1015,
+    CMA_LEDGER_ERROR_REMOVE = -1016,
+};
+
+typedef enum {
+    CMA_LEDGER_OP_FIND,
+    CMA_LEDGER_OP_CREATE,
+    CMA_LEDGER_OP_FIND_OR_CREATE,
+    CMA_LEDGER_OP_FIND_AND_REMOVE,
+} cma_ledger_retrieve_operation_t;
+
+typedef enum {
+    CMA_LEDGER_ASSET_TYPE_ID,
+    CMA_LEDGER_ASSET_TYPE_BASE,
+    CMA_LEDGER_ASSET_TYPE_TOKEN_ADDRESS,
+    CMA_LEDGER_ASSET_TYPE_TOKEN_ADDRESS_ID,
+    CMA_LEDGER_ASSET_TYPE_TOKEN_ADDRESS_ID_AMOUNT,
+} cma_ledger_asset_type_t;
+
+typedef enum {
+    CMA_LEDGER_ACCOUNT_TYPE_ID,
+    CMA_LEDGER_ACCOUNT_TYPE_WALLET_ADDRESS,
+    CMA_LEDGER_ACCOUNT_TYPE_ACCOUNT_ID,
+} cma_ledger_account_type_t;
+
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wpedantic"
+typedef struct cma_ledger_account {
+    cma_ledger_account_type_t type;
+    union {
+        cma_account_id_t account_id;
+        struct {
+            uint8_t fix[CMA_ABI_ID_LENGTH - CMA_ABI_ADDRESS_LENGTH];
+            cma_abi_address_t address;
+        } __attribute__((__packed__));
+    };
+} cma_ledger_account_t;
+#pragma GCC diagnostic pop
+
+typedef struct cma_ledger_account_balance {
+    uint32_t type;
+    cma_abi_address_t owner;
+    cma_token_address_t token_address;
+    cma_token_id_t token_id;
+    cma_amount_t amount;
+    uint8_t padding[20]; // Align to 4*32 bytes
+} cma_ledger_account_balance_t;
+
+typedef struct cma_ledger_account_balance_info {
+    ptrdiff_t offset;
+    size_t index;
+    cma_ledger_account_balance_t *balance;
+} cma_ledger_account_balance_info_t;
+
+CMA_LEDGER_API int cma_ledger_init(cma_ledger_t *ledger);
+CMA_LEDGER_API int cma_ledger_fini(cma_ledger_t *ledger);
+CMA_LEDGER_API int cma_ledger_reset(cma_ledger_t *ledger);
+
+CMA_LEDGER_API int cma_ledger_init_file(cma_ledger_t *ledger, const char *memory_file_name, size_t offset,
+    size_t mem_length, size_t n_accounts, size_t n_assets, size_t n_balances);
+
+CMA_LEDGER_API int cma_ledger_init_buffer(cma_ledger_t *ledger, void *buffer, size_t mem_length, size_t n_accounts,
+    size_t n_assets, size_t n_balances);
+
+// Initialize a single-asset ledger over a memory-mapped file (create-or-open).
+// Balances are 64-bit; the asset is fixed at init and immutable. asset_type must be
+// CMA_LEDGER_ASSET_TYPE_BASE (ether, token_address NULL) or CMA_LEDGER_ASSET_TYPE_TOKEN_ADDRESS
+// (ERC20, token_address required). n_accounts is the capacity of the withdrawable balance drive.
+CMA_LEDGER_API int cma_ledger_init_single_file(cma_ledger_t *ledger, const char *memory_file_name, size_t offset,
+    size_t mem_length, size_t n_accounts, cma_ledger_asset_type_t asset_type,
+    const cma_token_address_t *token_address);
+
+// Initialize a single-asset ledger over a caller-provided buffer (non-persistent).
+CMA_LEDGER_API int cma_ledger_init_single_buffer(cma_ledger_t *ledger, void *buffer, size_t mem_length,
+    size_t n_accounts, cma_ledger_asset_type_t asset_type, const cma_token_address_t *token_address);
+
+// Retrieve/create an asset
+// try to retrieve: If id is defined, fill with the asset details, otherwise fill with id
+// If it didn't find  the asset and creation type is set with one of the options, create it
+// update the token asset_id <-> (address, token id) mapping
+CMA_LEDGER_API int cma_ledger_retrieve_asset(cma_ledger_t *ledger, cma_ledger_asset_id_t *asset_id,
+    cma_token_address_t *token_address, cma_token_id_t *token_id, cma_amount_t *out_total_supply,
+    cma_ledger_asset_type_t *asset_type, cma_ledger_retrieve_operation_t operation);
+
+// Retrieve/create an account
+// try to retrieve: If id is defined, fill with the account details, otherwise fill with id
+// If it didn't find  the account and creation type is set with one of the options, create it
+// update the token id <-> account_id mapping
+CMA_LEDGER_API int cma_ledger_retrieve_account(cma_ledger_t *ledger, cma_ledger_account_id_t *account_id,
+    cma_ledger_account_t *account, const void *addr_accid, size_t *n_balances, cma_ledger_account_type_t *account_type,
+    cma_ledger_retrieve_operation_t operation);
+
+// Deposit
+CMA_LEDGER_API int cma_ledger_deposit(cma_ledger_t *ledger, cma_ledger_asset_id_t asset_id,
+    cma_ledger_account_id_t to_accountcma_ledger_account_balance_t_id, const cma_amount_t *deposit);
+
+// Withdrawal
+CMA_LEDGER_API int cma_ledger_withdraw(cma_ledger_t *ledger, cma_ledger_asset_id_t asset_id,
+    cma_ledger_account_id_t from_account_id, const cma_amount_t *withdrawal);
+
+// Transfer
+CMA_LEDGER_API int cma_ledger_transfer(cma_ledger_t *ledger, cma_ledger_asset_id_t asset_id,
+    cma_ledger_account_id_t from_account_id, cma_ledger_account_id_t to_account_id, const cma_amount_t *amount);
+
+// Get balance
+CMA_LEDGER_API int cma_ledger_get_balance(cma_ledger_t *ledger, cma_ledger_asset_id_t asset_id,
+    cma_ledger_account_id_t account_id, cma_amount_t *out_balance,
+    cma_ledger_account_balance_info_t *account_balance_info);
+
+// get error message
+CMA_LEDGER_API const char *cma_ledger_get_last_error_message();
+
+#ifdef __cplusplus
+} // extern "C"
+#endif
+
+#endif // CMA_LEDGER_H