|
| 1 | +/** |
| 2 | + * @file stellar_api.c |
| 3 | + * @author Cypherock X1 Team |
| 4 | + * @brief Defines helpers apis for Stellar app. |
| 5 | + * @copyright Copyright (c) 2025 HODL TECH PTE LTD |
| 6 | + * <br/> You may obtain a copy of license at <a href="https://mitcc.org/" |
| 7 | + *target=_blank>https://mitcc.org/</a> |
| 8 | + * |
| 9 | + ****************************************************************************** |
| 10 | + * @attention |
| 11 | + * |
| 12 | + * (c) Copyright 2025 by HODL TECH PTE LTD |
| 13 | + * |
| 14 | + * Permission is hereby granted, free of charge, to any person obtaining |
| 15 | + * a copy of this software and associated documentation files (the |
| 16 | + * "Software"), to deal in the Software without restriction, including |
| 17 | + * without limitation the rights to use, copy, modify, merge, publish, |
| 18 | + * distribute, sublicense, and/or sell copies of the Software, and to |
| 19 | + * permit persons to whom the Software is furnished to do so, subject |
| 20 | + * to the following conditions: |
| 21 | + * |
| 22 | + * The above copyright notice and this permission notice shall be |
| 23 | + * included in all copies or substantial portions of the Software. |
| 24 | + * |
| 25 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
| 26 | + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 27 | + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 28 | + * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR |
| 29 | + * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF |
| 30 | + * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
| 31 | + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 32 | + * |
| 33 | + * |
| 34 | + * "Commons Clause" License Condition v1.0 |
| 35 | + * |
| 36 | + * The Software is provided to you by the Licensor under the License, |
| 37 | + * as defined below, subject to the following condition. |
| 38 | + * |
| 39 | + * Without limiting other conditions in the License, the grant of |
| 40 | + * rights under the License will not include, and the License does not |
| 41 | + * grant to you, the right to Sell the Software. |
| 42 | + * |
| 43 | + * For purposes of the foregoing, "Sell" means practicing any or all |
| 44 | + * of the rights granted to you under the License to provide to third |
| 45 | + * parties, for a fee or other consideration (including without |
| 46 | + * limitation fees for hosting or consulting/ support services related |
| 47 | + * to the Software), a product or service whose value derives, entirely |
| 48 | + * or substantially, from the functionality of the Software. Any license |
| 49 | + * notice or attribution required by the License must also include |
| 50 | + * this Commons Clause License Condition notice. |
| 51 | + * |
| 52 | + * Software: All X1Wallet associated files. |
| 53 | + * License: MIT |
| 54 | + * Licensor: HODL TECH PTE LTD |
| 55 | + * |
| 56 | + ****************************************************************************** |
| 57 | + */ |
| 58 | + |
| 59 | +/***************************************************************************** |
| 60 | + * INCLUDES |
| 61 | + *****************************************************************************/ |
| 62 | + |
| 63 | +#include "stellar_api.h" |
| 64 | + |
| 65 | +#include <pb_decode.h> |
| 66 | +#include <pb_encode.h> |
| 67 | + |
| 68 | +#include "common_error.h" |
| 69 | +#include "core_api.h" |
| 70 | +#include "events.h" |
| 71 | + |
| 72 | +/***************************************************************************** |
| 73 | + * EXTERN VARIABLES |
| 74 | + *****************************************************************************/ |
| 75 | + |
| 76 | +/***************************************************************************** |
| 77 | + * PRIVATE MACROS AND DEFINES |
| 78 | + *****************************************************************************/ |
| 79 | + |
| 80 | +/***************************************************************************** |
| 81 | + * PRIVATE TYPEDEFS |
| 82 | + *****************************************************************************/ |
| 83 | + |
| 84 | +/***************************************************************************** |
| 85 | + * STATIC VARIABLES |
| 86 | + *****************************************************************************/ |
| 87 | + |
| 88 | +/***************************************************************************** |
| 89 | + * GLOBAL VARIABLES |
| 90 | + *****************************************************************************/ |
| 91 | + |
| 92 | +/***************************************************************************** |
| 93 | + * STATIC FUNCTION PROTOTYPES |
| 94 | + *****************************************************************************/ |
| 95 | + |
| 96 | +/***************************************************************************** |
| 97 | + * STATIC FUNCTIONS |
| 98 | + *****************************************************************************/ |
| 99 | + |
| 100 | +/***************************************************************************** |
| 101 | + * GLOBAL FUNCTIONS |
| 102 | + *****************************************************************************/ |
| 103 | +bool decode_stellar_query(const uint8_t *data, |
| 104 | + uint16_t data_size, |
| 105 | + stellar_query_t *query_out) { |
| 106 | + if (NULL == data || NULL == query_out || 0 == data_size) { |
| 107 | + stellar_send_error(ERROR_COMMON_ERROR_CORRUPT_DATA_TAG, |
| 108 | + ERROR_DATA_FLOW_DECODING_FAILED); |
| 109 | + return false; |
| 110 | + } |
| 111 | + |
| 112 | + // zeroise for safety from garbage in the query reference |
| 113 | + memzero(query_out, sizeof(stellar_query_t)); |
| 114 | + |
| 115 | + /* Create a stream that reads from the buffer. */ |
| 116 | + pb_istream_t stream = pb_istream_from_buffer(data, data_size); |
| 117 | + |
| 118 | + /* Now we are ready to decode the message. */ |
| 119 | + bool status = pb_decode(&stream, STELLAR_QUERY_FIELDS, query_out); |
| 120 | + |
| 121 | + /* Send error to host if status is false*/ |
| 122 | + if (false == status) { |
| 123 | + stellar_send_error(ERROR_COMMON_ERROR_CORRUPT_DATA_TAG, |
| 124 | + ERROR_DATA_FLOW_DECODING_FAILED); |
| 125 | + } |
| 126 | + |
| 127 | + return status; |
| 128 | +} |
| 129 | + |
| 130 | +bool encode_stellar_result(const stellar_result_t *result, |
| 131 | + uint8_t *buffer, |
| 132 | + uint16_t max_buffer_len, |
| 133 | + size_t *bytes_written_out) { |
| 134 | + if (NULL == result || NULL == buffer || NULL == bytes_written_out) |
| 135 | + return false; |
| 136 | + |
| 137 | + /* Create a stream that will write to our buffer. */ |
| 138 | + pb_ostream_t stream = pb_ostream_from_buffer(buffer, max_buffer_len); |
| 139 | + |
| 140 | + /* Now we are ready to encode the message! */ |
| 141 | + bool status = pb_encode(&stream, STELLAR_RESULT_FIELDS, result); |
| 142 | + |
| 143 | + if (true == status) { |
| 144 | + *bytes_written_out = stream.bytes_written; |
| 145 | + } |
| 146 | + |
| 147 | + return status; |
| 148 | +} |
| 149 | + |
| 150 | +bool check_stellar_query(const stellar_query_t *query, |
| 151 | + pb_size_t exp_query_tag) { |
| 152 | + if ((NULL == query) || (exp_query_tag != query->which_request)) { |
| 153 | + stellar_send_error(ERROR_COMMON_ERROR_CORRUPT_DATA_TAG, |
| 154 | + ERROR_DATA_FLOW_INVALID_QUERY); |
| 155 | + return false; |
| 156 | + } |
| 157 | + return true; |
| 158 | +} |
| 159 | + |
| 160 | +stellar_result_t init_stellar_result(pb_size_t result_tag) { |
| 161 | + stellar_result_t result = STELLAR_RESULT_INIT_ZERO; |
| 162 | + result.which_response = result_tag; |
| 163 | + return result; |
| 164 | +} |
| 165 | + |
| 166 | +void stellar_send_error(pb_size_t which_error, uint32_t error_code) { |
| 167 | + stellar_result_t result = |
| 168 | + init_stellar_result(STELLAR_RESULT_COMMON_ERROR_TAG); |
| 169 | + result.common_error = init_common_error(which_error, error_code); |
| 170 | + stellar_send_result(&result); |
| 171 | +} |
| 172 | + |
| 173 | +void stellar_send_result(const stellar_result_t *result) { |
| 174 | + // TODO: Set all option files |
| 175 | + uint8_t buffer[1700] = {0}; |
| 176 | + size_t bytes_encoded = 0; |
| 177 | + ASSERT(encode_stellar_result(result, buffer, sizeof(buffer), &bytes_encoded)); |
| 178 | + send_response_to_host(&buffer[0], bytes_encoded); |
| 179 | +} |
| 180 | + |
| 181 | +bool stellar_get_query(stellar_query_t *query, pb_size_t exp_query_tag) { |
| 182 | + evt_status_t event = get_events(EVENT_CONFIG_USB, MAX_INACTIVITY_TIMEOUT); |
| 183 | + |
| 184 | + if (true == event.p0_event.flag) { |
| 185 | + return false; |
| 186 | + } |
| 187 | + |
| 188 | + if (!decode_stellar_query( |
| 189 | + event.usb_event.p_msg, event.usb_event.msg_size, query)) { |
| 190 | + return false; |
| 191 | + } |
| 192 | + |
| 193 | + if (!check_stellar_query(query, exp_query_tag)) { |
| 194 | + return false; |
| 195 | + } |
| 196 | + |
| 197 | + return true; |
| 198 | +} |
0 commit comments