@riseandshaheen/libcma 0.1.0-alpha.0

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

@@ -0,0 +1,305 @@
+#ifndef CMA_PARSER_H
+#define CMA_PARSER_H
+#include <stddef.h>
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Compiler visibility definition
+#ifndef CMA_PARSER_API
+#define CMA_PARSER_API __attribute__((visibility("default")))
+#endif
+
+#include <libcmt/abi.h>
+#include <libcmt/rollup.h>
+
+#include "types.h"
+
+enum {
+    // 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,
+};
+
+typedef enum {
+    CMA_PARSER_INPUT_TYPE_NONE,
+    CMA_PARSER_INPUT_TYPE_AUTO,
+    CMA_PARSER_INPUT_TYPE_ETHER_DEPOSIT,
+    CMA_PARSER_INPUT_TYPE_ERC20_DEPOSIT,
+    CMA_PARSER_INPUT_TYPE_ERC721_DEPOSIT,
+    CMA_PARSER_INPUT_TYPE_ERC1155_SINGLE_DEPOSIT,
+    CMA_PARSER_INPUT_TYPE_ERC1155_BATCH_DEPOSIT,
+    CMA_PARSER_INPUT_TYPE_ETHER_WITHDRAWAL,
+    CMA_PARSER_INPUT_TYPE_ERC20_WITHDRAWAL,
+    CMA_PARSER_INPUT_TYPE_ERC721_WITHDRAWAL,
+    CMA_PARSER_INPUT_TYPE_ERC1155_SINGLE_WITHDRAWAL,
+    CMA_PARSER_INPUT_TYPE_ERC1155_BATCH_WITHDRAWAL,
+    CMA_PARSER_INPUT_TYPE_ETHER_TRANSFER,
+    CMA_PARSER_INPUT_TYPE_ERC20_TRANSFER,
+    CMA_PARSER_INPUT_TYPE_ERC721_TRANSFER,
+    CMA_PARSER_INPUT_TYPE_ERC1155_SINGLE_TRANSFER,
+    CMA_PARSER_INPUT_TYPE_ERC1155_BATCH_TRANSFER,
+    CMA_PARSER_INPUT_TYPE_BALANCE,
+    CMA_PARSER_INPUT_TYPE_BALANCE_ACCOUNT,
+    CMA_PARSER_INPUT_TYPE_BALANCE_ACCOUNT_TOKEN_ADDRESS,
+    CMA_PARSER_INPUT_TYPE_BALANCE_ACCOUNT_TOKEN_ADDRESS_ID,
+    CMA_PARSER_INPUT_TYPE_SUPPLY,
+    CMA_PARSER_INPUT_TYPE_SUPPLY_TOKEN_ADDRESS,
+    CMA_PARSER_INPUT_TYPE_SUPPLY_TOKEN_ADDRESS_ID,
+} cma_parser_input_type_t;
+
+typedef uint8_t cma_abi_u256_data[CMT_ABI_U256_LENGTH];
+
+typedef struct cma_abi_u256_list {
+    size_t length;
+    cma_abi_u256_data *data;
+} cma_abi_u256_list_t;
+typedef cma_abi_u256_list_t cma_amounts_t;
+typedef cma_abi_u256_list_t cma_token_ids_t;
+
+typedef struct cma_parser_ether_deposit {
+    cma_abi_address_t sender;
+    cma_amount_t amount;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_ether_deposit_t;
+typedef struct cma_parser_erc20_deposit {
+    cma_abi_address_t sender;
+    cma_token_address_t token;
+    cma_amount_t amount;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc20_deposit_t;
+typedef struct cma_parser_erc721_deposit {
+    cma_abi_address_t sender;
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+    cma_abi_bytes_t base_layer_data;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc721_deposit_t;
+typedef struct cma_parser_erc1155_single_deposit {
+    cma_abi_address_t sender;
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+    cma_amount_t amount;
+    cma_abi_bytes_t base_layer_data;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc1155_single_deposit_t;
+typedef struct cma_parser_erc1155_batch_deposit {
+    cma_abi_address_t sender;
+    cma_token_address_t token;
+    cma_token_ids_t token_ids;
+    cma_amounts_t amounts;
+    cma_abi_bytes_t base_layer_data;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc1155_batch_deposit_t;
+
+typedef struct cma_parser_ether_withdrawal {
+    cma_amount_t amount;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_ether_withdrawal_t;
+typedef struct cma_parser_erc20_withdrawal {
+    cma_token_address_t token;
+    cma_amount_t amount;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc20_withdrawal_t;
+typedef struct cma_parser_erc721_withdrawal {
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc721_withdrawal_t;
+typedef struct cma_parser_erc1155_single_withdrawal {
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+    cma_amount_t amount;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc1155_single_withdrawal_t;
+typedef struct cma_parser_erc1155_batch_withdrawal {
+    cma_token_address_t token;
+    cma_token_ids_t token_ids;
+    cma_amounts_t amounts;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc1155_batch_withdrawal_t;
+
+typedef struct cma_parser_ether_transfer {
+    cma_account_id_t receiver;
+    cma_amount_t amount;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_ether_transfer_t;
+typedef struct cma_parser_erc20_transfer {
+    cma_account_id_t receiver;
+    cma_token_address_t token;
+    cma_amount_t amount;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc20_transfer_t;
+typedef struct cma_parser_erc721_transfer {
+    cma_account_id_t receiver;
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc721_transfer_t;
+typedef struct cma_parser_erc1155_single_transfer {
+    cma_account_id_t receiver;
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+    cma_amount_t amount;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc1155_single_transfer_t;
+typedef struct cma_parser_erc1155_batch_transfer {
+    cma_account_id_t receiver;
+    cma_token_address_t token;
+    cma_token_ids_t token_ids;
+    cma_amounts_t amounts;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc1155_batch_transfer_t;
+
+typedef struct cma_parser_balance {
+    cma_account_id_t account;
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_balance_t;
+typedef struct cma_parser_supply {
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_supply_t;
+
+typedef struct cma_parser_input {
+    cma_parser_input_type_t type;
+    union {
+        cma_parser_ether_deposit_t ether_deposit;
+        cma_parser_erc20_deposit_t erc20_deposit;
+        cma_parser_erc721_deposit_t erc721_deposit;
+        cma_parser_erc1155_single_deposit_t erc1155_single_deposit;
+        cma_parser_erc1155_batch_deposit_t erc1155_batch_deposit;
+        cma_parser_ether_withdrawal_t ether_withdrawal;
+        cma_parser_erc20_withdrawal_t erc20_withdrawal;
+        cma_parser_erc721_withdrawal_t erc721_withdrawal;
+        cma_parser_erc1155_single_withdrawal_t erc1155_single_withdrawal;
+        cma_parser_erc1155_batch_withdrawal_t erc1155_batch_withdrawal;
+        cma_parser_ether_transfer_t ether_transfer;
+        cma_parser_erc20_transfer_t erc20_transfer;
+        cma_parser_erc721_transfer_t erc721_transfer;
+        cma_parser_erc1155_single_transfer_t erc1155_single_transfer;
+        cma_parser_erc1155_batch_transfer_t erc1155_batch_transfer;
+        cma_parser_balance_t balance;
+        cma_parser_supply_t supply;
+    };
+} cma_parser_input_t;
+
+typedef enum {
+    CMA_PARSER_VOUCHER_TYPE_NONE,
+    CMA_PARSER_VOUCHER_TYPE_ETHER,
+    CMA_PARSER_VOUCHER_TYPE_ERC20,
+    CMA_PARSER_VOUCHER_TYPE_ERC721,
+    CMA_PARSER_VOUCHER_TYPE_ERC1155_SINGLE,
+    CMA_PARSER_VOUCHER_TYPE_ERC1155_BATCH,
+} cma_parser_voucher_type_t;
+
+enum {
+    CMA_PARSER_SELECTOR_SIZE = 4,
+    CMA_PARSER_ETHER_VOUCHER_PAYLOAD_SIZE = 0,
+    CMA_PARSER_ERC20_VOUCHER_PAYLOAD_SIZE = CMA_PARSER_SELECTOR_SIZE + 2 * CMA_ABI_U256_LENGTH,
+    CMA_PARSER_ERC721_VOUCHER_PAYLOAD_SIZE = CMA_PARSER_SELECTOR_SIZE + 3 * CMA_ABI_U256_LENGTH,
+    CMA_PARSER_ERC1155_SINGLE_VOUCHER_PAYLOAD_MIN_SIZE = CMA_PARSER_SELECTOR_SIZE + 6 * CMA_ABI_U256_LENGTH,
+    CMA_PARSER_ERC1155_BATCH_VOUCHER_PAYLOAD_MIN_SIZE = CMA_PARSER_SELECTOR_SIZE + 8 * CMA_ABI_U256_LENGTH,
+};
+
+typedef struct cma_parser_ether_voucher_fields {
+    cma_amount_t amount;
+} cma_parser_ether_voucher_fields_t;
+typedef struct cma_parser_erc20_voucher_fields {
+    cma_token_address_t token;
+    cma_amount_t amount;
+} cma_parser_erc20_voucher_fields_t;
+typedef struct cma_parser_erc721_voucher_fields {
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+} cma_parser_erc721_voucher_fields_t;
+typedef struct cma_parser_erc1155_single_voucher_fields {
+    cma_token_address_t token;
+    cma_token_id_t token_id;
+    cma_amount_t amount;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc1155_single_voucher_fields_t;
+typedef struct cma_parser_erc1155_batch_voucher_fields {
+    cma_token_address_t token;
+    cma_token_ids_t token_ids;
+    cma_amounts_t amounts;
+    cma_abi_bytes_t exec_layer_data;
+} cma_parser_erc1155_batch_voucher_fields_t;
+
+typedef struct cma_parser_voucher_data {
+    cma_abi_address_t receiver;
+    union {
+        cma_parser_ether_voucher_fields_t ether;
+        cma_parser_erc20_voucher_fields_t erc20;
+        cma_parser_erc721_voucher_fields_t erc721;
+        cma_parser_erc1155_single_voucher_fields_t erc1155_single;
+        cma_parser_erc1155_batch_voucher_fields_t erc1155_batch;
+    };
+} cma_parser_voucher_data_t;
+
+typedef struct cma_voucher {
+    cmt_abi_address_t address;
+    cmt_abi_u256_t value;
+    cmt_abi_bytes_t payload;
+} cma_voucher_t;
+
+enum {
+    CMA_PARSER_SUCCESS = 0,
+    CMA_PARSER_ERROR_UNKNOWN = -2001,
+    CMA_PARSER_ERROR_EXCEPTION = -2002,
+    CMA_PARSER_ERROR_INCOMPATIBLE_INPUT = -2003,
+    CMA_PARSER_ERROR_MALFORMED_INPUT = -2004,
+    CMA_PARSER_ERROR_INVALID_AMOUNT = -2005,
+};
+
+// decode advance
+CMA_PARSER_API 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
+CMA_PARSER_API 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
+CMA_PARSER_API 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
+CMA_PARSER_API const char *cma_parser_get_last_error_message();
+
+#ifdef __cplusplus
+} // extern "C"
+#endif
+
+#endif // CMA_PARSER_H

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

@@ -0,0 +1,22 @@
+#ifndef CMA_ABI_H
+#define CMA_ABI_H
+
+#include <stdint.h>
+
+#include <libcmt/abi.h>
+
+enum {
+    CMA_ABI_ADDRESS_LENGTH = CMT_ABI_ADDRESS_LENGTH,
+    CMA_ABI_U256_LENGTH = CMT_ABI_U256_LENGTH,
+    CMA_ABI_ID_LENGTH = CMT_ABI_U256_LENGTH,
+};
+
+typedef cmt_abi_address_t cma_abi_address_t;
+typedef cmt_abi_bytes_t cma_abi_bytes_t;
+typedef cmt_abi_u256_t cma_amount_t;
+typedef cmt_abi_u256_t cma_token_id_t;
+typedef cmt_abi_u256_t cma_bytes32_t;
+typedef cmt_abi_address_t cma_token_address_t;
+typedef cma_bytes32_t cma_account_id_t;
+
+#endif // CMA_ABI_H

package/deps/machine-guest-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-guest-tools/README.md

@@ -0,0 +1,57 @@
+# Cartesi Machine Guest Tools
+
+The Cartesi Machine Guest Tools is a repository that contains a set of tools developed for the RISC-V Linux OS. It provides a RISC-V Debian package and a root filesystem for Ubuntu 24.04.
+
+## Getting Started
+
+Users looking to create cartesi-machine applications can use the provided Debian package and root filesystem directly from one of the prepackaged releases, without needing to build this repository themselves.
+
+### Requirements
+
+- Docker >= 18.x
+- GNU Make >= 3.81
+- xgenext2fs >= 1.5.6
+
+### Docker buildx setup
+
+To set up riscv64 buildx, use the following command:
+
+```bash
+$ make setup
+```
+
+### Building (from riscv64 environment)
+
+Assuming you are inside a riscv64 environment, you can build tools and install in the system with:
+
+```sh
+make
+make install PREFIX=/usr
+```
+
+### Building (cross compiling)
+
+In case you need to patch and develop tools, you can cross compile using Docker with:
+
+```sh
+make build
+```
+
+This creates the `machine-guest-tools_riscv64.tar.gz` archive and the `rootfs-tools.ext2` root filesystem artifacts.
+Both should only be use for testing and development purposes, not directly in dapps.
+
+#### Makefile targets
+
+Check all targets available with `make help`.
+
+## Contributing
+
+Thank you for your interest in Cartesi! Head over to our [Contributing Guidelines](CONTRIBUTING.md) for instructions on how to sign our Contributors Agreement and get started with
+Cartesi!
+
+Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+## License
+
+The machine-guest-tools repository and all contributions are licensed under
+[APACHE 2.0](https://www.apache.org/licenses/LICENSE-2.0). Please review our [LICENSE](LICENSE) file.