Feature/2025 08 01 vottun bridge

.github/workflows/contract-verify.yml

@@ -0,0 +1,44 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: ContractVerify
+
+on:
+  push:
+    branches: [ "main", "develop" ]
+    paths:
+      - 'src/contracts/*.h'
+      - '!src/contracts/math_lib.h'
+      - '!src/contracts/qpi.h'
+      - '!src/contracts/TestExample*.h'
+      - '.github/workflows/contract-verify.yml'
+  pull_request:
+    branches: [ "main", "develop" ]
+    paths:
+      - 'src/contracts/*.h'
+      - '!src/contracts/math_lib.h'
+      - '!src/contracts/qpi.h'
+      - '!src/contracts/TestExample*.h'
+      - '.github/workflows/contract-verify.yml'
+
+jobs:
+  contract_verify_job:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15 # Sometimes the parser can get stuck
+    name: Verify smart contract files
+    steps:
+      # Checkout repo to use files of the repo as input for container action
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Find all contract files to verify
+        id: filepaths
+        run: |
+          files=$(find src/contracts/ -maxdepth 1 -type f -name "*.h" ! -name "*TestExample*" ! -name "*math_lib*" ! -name "*qpi*" -printf "%p\n" | paste -sd, -)
+          echo "contract-filepaths=$files" >> "$GITHUB_OUTPUT"
+      - name: Contract verify action step
+        id: verify
+        uses: Franziska-Mueller/qubic-contract-verify@v1.0.0
+        with:
+          filepaths: '${{ steps.filepaths.outputs.contract-filepaths }}'

.gitignore

@@ -13,3 +13,22 @@ x64/
 .DS_Store
 .clang-format
 tmp
+
+# Build directories and temporary files
+out/build/
+**/Testing/Temporary/
+**/_deps/googletest-src
+test/CMakeLists.txt
+test/CMakeLists.txt
+comp.md
+proposal.md
+src/Qubic.vcxproj
+.claude/settings.local.json
+src/Qubic.vcxproj
+test/CMakeLists.txt
+ANALISIS_STATUS_3.md
+.gitignore
+node.md
+report.md
+claude.md
+RESUMEN_REVISION.md

doc/contracts.md

@@ -68,7 +68,8 @@ In order to develop a contract, follow these steps:
     - Design and implement the interfaces of your contract (the user procedures and user functions along with its inputs and outputs).
       The QPI available for implementing the contract is defined in `src/contracts/qpi.h`.
     - Implement the system procedures needed and remove all the system procedures that are not needed by your contract.
-    - Add the short form contract name as a prefix to all global constants (if any).
+    - Follow the general [qubic style guidelines](https://github.com/qubic/core/blob/main/doc/contributing.md#style-guidelines) when writing your code.
+    - Add the short form contract name as a prefix to all global constants, structs and classes (if any).
     - Make sure your code is efficient. Execution time will cost fees in the future.
       Think about the data structures you use, for example if you can use a hash map instead of an array with linear search.
       Check if you can optimize code in loops and especially in nested loops.
@@ -92,8 +93,9 @@ In order to develop a contract, follow these steps:
 ## Review and tests
 
 Each contract must be validated with the following steps:
-1. The contract is verified with a special software tool, ensuring that it complies with the formal requirements mentioned above, such as no use of forbidden C++ features.
-   (Currently, this tool has not been implemented yet. Thus, this check needs to be done during the review in point 3.)
+1. The contract is verified with the [Qubic Contract Verification Tool](https://github.com/Franziska-Mueller/qubic-contract-verify), ensuring that it complies with the formal requirements mentioned above, such as no use of [forbidden C++ features](#restrictions-of-c-language-features).
+   In the `qubic/core` repository, the tool is run automatically as GitHub workflow for PRs to the `develop` and `main` branches (as well as for commits in these branches).
+   However, since workflow runs on PRs require maintainer approval, we highly recommend to either build the tool from source or use the GitHub action provided in the tool's repository to analyze your contract header file before opening your PR.   
 2. The features of the contract have to be extensively tested with automated tests implemented within the Qubic Core's GoogleTest framework.
 3. The contract and testing code must be reviewed by at least one of the Qubic Core devs, ensuring it meets high quality standards.
 4. Before integrating the contract in the official Qubic Core release, the features of the contract must be tested in a test network with multiple nodes, showing that the contract works well in practice and that the nodes run stable with the contract.
@@ -105,7 +107,7 @@ After going through this validation process, a contract can be integrated in off
 
 Steps for deploying a contract:
 
-1. Finish development, review, and tests as written above.
+1. Finish development, review, and tests as written above. This includes waiting for approval of your PR by the core dev team. If you need to make any significant changes to the code after the computors accepted your proposal, you will need to make a second proposal. 
 2. A proposal for including your contract into the Qubic Core needs to be prepared.
    We recommend to add your proposal description to https://github.com/qubic/proposal/tree/main/SmartContracts via a pull request (this directory also contains files from other contracts added before, which can be used as a template).
    The proposal description should include a detailed description of your contract (see point 1 of the [Development section](#development)) and the final source code of the contract.
@@ -547,8 +549,8 @@ In consequence, the procedure is executed but with `qpi.invocationReward() == 0`
 
 ## Restrictions of C++ Language Features
 
-It is prohibited to locally instantiating objects or variables on the function call stack.
-Instead, use the function and procedure definition macros with the postfix `_WITH_LOCALS` (see above).
+It is prohibited to locally instantiate objects or variables on the function call stack. This includes loop index variables `for (int i = 0; ...)`.
+Instead, use the function and procedure definition macros with the postfix `_WITH_LOCALS` (see above).  
 In procedures you alternatively may store temporary variables permanently as members of the state.
 
 Defining, casting, and dereferencing pointers is forbidden.
@@ -566,22 +568,25 @@ The division operator `/` and the modulo operator `%` are prohibited to prevent
 Use `div()` and `mod()` instead, which return zero in case of division by zero.
 
 Strings `"` and chars `'` are forbidden, because they can be used to jump to random memory fragments.
+If you want to use `static_assert` you can do so via the `STATIC_ASSERT` macro defined in `qpi.h` which does not require a string literal.
 
-Variadic arguments are prohibited (character combination `...`).
+Variadic arguments, template parameter packs, and function parameter packs are prohibited (character combination `...`).
 
 Double underscores `__` must not be used in a contract, because these are reserved for internal functions and compiler macros that are prohibited to be used directly.
 For similar reasons, `QpiContext` and `const_cast` are prohibited too.
 
 The scope resolution operator `::` is also prohibited, except for structs, enums, and namespaces defined in contracts and `qpi.h`.
 
-The keywords `typedef` and `union` are prohibited to make the code easier to read and prevent tricking code audits.
+The keyword `union` is prohibited to make the code easier to read and prevent tricking code audits.
+Similarly, the keywords `typedef` and `using` are only allowed in local scope, e.g. inside structs or functions.
+The only exception is `using namespace QPI` which can be used at global scope.
 
 Global variables are not permitted.
-Global constants must begin with the name of the contract state struct.
+Global constants, structs and classes must begin with the name of the contract state struct.
 
 There is a limit for recursion and depth of nested contract function / procedure calls (the limit is 10 at the moment).
 
-The input and output structs of contract user procedures and functions may only use integer and boolean types (such as `uint64`, `sint8`, `bit`) as well as `id`, `Array`, and `BitArray`.
+The input and output structs of contract user procedures and functions may only use integer and boolean types (such as `uint64`, `sint8`, `bit`) as well as `id`, `Array`, and `BitArray`, and struct types containing only allowed types.
 Complex types that may have an inconsistent internal state, such as `Collection`, are forbidden in the public interface of a contract.
 
 
@@ -627,3 +632,7 @@ The file `proposal.cpp` has a lot of examples showing how to use both functions.
 For example, `getProposalIndices()` shows how to call a contract function requiring input and providing output with `runContractFunction()`.
 An example use case of `makeContractTransaction()` can be found in `gqmpropSetProposal()`.
 The function `castVote()` is a more complex example combining both, calling a contract function and invoking a contract procedure.
+
+
+
+

doc/contributing.md

@@ -1,5 +1,16 @@
 # How to Contribute
 
+## Table of contents
+
+1. [Contributing as an external developer](#contributing-as-an-external-developer)
+2. [Development workflow / branches](#development-workflow--branches)
+3. [Coding guidelines](#coding-guidelines)
+    1. [Most important principles](#most-important-principles)
+    2. [General guidelines](#general-guidelines)
+    3. [Style guidelines](#style-guidelines)
+4. [Version naming scheme](#version-naming-scheme)
+5. [Profiling](#profiling)
+
 ## Contributing as an external developer
 
 If you find bugs, typos, or other problems that can be fixed with a few changes, you are more than welcome to contribute these fixes with a pull request as follows.
@@ -191,6 +202,8 @@ The code formatting rules are enforced using `clang-format`, ideally setup as a
 They are based on the "Microsoft" style with some custom modifications.
 Currently, the style guidelines are designed to improve consistency while minimizing the number of changes needed in the existing codebase.
 
+#### Naming
+
 The following naming rules are not strictly enforced, but should be followed at least in new code:
 
 - **Preprocessor symbols** must be defined `ALL_CAPS`.
@@ -221,6 +234,21 @@ The following naming rules are not strictly enforced, but should be followed at
 
 - **Functions** are named following the same pattern as variables. They usually start with a verb. Examples: `getComputerDigest()`, `processExchangePublicPeers()`, `initContractExec()`.
 
+#### Curly Braces Style
+
+Every opening curly brace should be on a new line. This applies to conditional blocks, loops, functions, classes, structs, etc. For example:
+
+```
+if (cond)
+{
+   // do something
+}
+else
+{
+   // do something else
+}
+```
+
 
 
 ## Version naming scheme
@@ -373,3 +401,5 @@ Even when bound by serializing instructions, the system environment at the time
 [AMD64 Architecture Programmer's Manual, Volumes 1-5, 13.2.4 Time-Stamp Counter](https://www.amd.com/content/dam/amd/en/documents/processor-tech-docs/programmer-references/40332.pdf)
 
 Another rich source: [Intel® 64 and IA-32 Architectures Software Developer's Manual Combined Volumes: 1, 2A, 2B, 2C, 2D, 3A, 3B, 3C, 3D, and 4](https://cdrdv2.intel.com/v1/dl/getContent/671200)
+
+

src/Qubic.vcxproj

@@ -23,7 +23,9 @@
     <ClInclude Include="assets\net_msg_impl.h" />
     <ClInclude Include="common_buffers.h" />
     <ClInclude Include="contracts\ComputorControlledFund.h" />
+    <ClInclude Include="contracts\Qdraw.h" />
     <ClInclude Include="contracts\Qswap.h" />
+    <ClInclude Include="contracts\RandomLottery.h" />
     <ClInclude Include="contracts\SupplyWatcher.h" />
     <ClInclude Include="contracts\EmptyTemplate.h" />
     <ClInclude Include="contracts\GeneralQuorumProposal.h" />
@@ -39,6 +41,8 @@
     <ClInclude Include="contracts\QVAULT.h" />
     <ClInclude Include="contracts\QBAY.h" />
     <ClInclude Include="contracts\Nostromo.h" />
+    <ClInclude Include="contracts\QBond.h" />
+    <ClInclude Include="contracts\VottunBridge.h" />
     <ClInclude Include="contracts\TestExampleA.h" />
     <ClInclude Include="contracts\TestExampleB.h" />
     <ClInclude Include="contracts\TestExampleC.h" />
@@ -50,6 +54,7 @@
     <ClInclude Include="contract_core\qpi_asset_impl.h" />
     <ClInclude Include="contract_core\qpi_collection_impl.h" />
     <ClInclude Include="contract_core\qpi_ipo_impl.h" />
+    <ClInclude Include="contract_core\qpi_mining_impl.h" />
     <ClInclude Include="contract_core\qpi_spectrum_impl.h" />
     <ClInclude Include="contract_core\qpi_system_impl.h" />
     <ClInclude Include="contract_core\qpi_hash_map_impl.h" />
@@ -115,6 +120,7 @@
     <ClInclude Include="platform\time.h" />
     <ClInclude Include="ticking\ticking.h" />
     <ClInclude Include="ticking\tick_storage.h" />
+    <ClInclude Include="ticking\pending_txs_pool.h" />
     <ClInclude Include="vote_counter.h" />
   </ItemGroup>
   <ItemGroup>

src/Qubic.vcxproj.filters

@@ -123,6 +123,12 @@
     <ClInclude Include="contracts\Nostromo.h">
       <Filter>contracts</Filter>
     </ClInclude>
+    <ClInclude Include="contracts\QBond.h">
+      <Filter>contracts</Filter>
+    </ClInclude>
+    <ClInclude Include="contracts\VottunBridge.h">
+      <Filter>contracts</Filter>
+    </ClInclude>
     <ClInclude Include="contract_core\contract_def.h">
       <Filter>contract_core</Filter>
     </ClInclude>
@@ -270,6 +276,18 @@
       <Filter>platform</Filter>
     </ClInclude>
     <ClInclude Include="revenue.h" />
+    <ClInclude Include="contract_core\qpi_mining_impl.h">
+      <Filter>contract_core</Filter>
+    </ClInclude>
+    <ClInclude Include="ticking\pending_txs_pool.h">
+      <Filter>ticking</Filter>
+    </ClInclude>
+    <ClInclude Include="contracts\Qdraw.h">
+      <Filter>contracts</Filter>
+    </ClInclude>
+    <ClInclude Include="contracts\RandomLottery.h">
+      <Filter>contracts</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <Filter Include="platform">
@@ -317,4 +335,4 @@
       <Filter>platform</Filter>
     </MASM>
   </ItemGroup>
-</Project>
+</Project>

src/assets/assets.h

@@ -245,6 +245,7 @@ static long long issueAsset(const m256i& issuerPublicKey, const char name[7], ch
                 AssetIssuance assetIssuance;
                 assetIssuance.issuerPublicKey = issuerPublicKey;
                 assetIssuance.numberOfShares = numberOfShares;
+                assetIssuance.managingContractIndex = managingContractIndex; // any SC can call issueAsset now (eg: QBOND) not just QX
                 *((unsigned long long*) assetIssuance.name) = *((unsigned long long*) name); // Order must be preserved!
                 assetIssuance.numberOfDecimalPlaces = numberOfDecimalPlaces; // Order must be preserved!
                 *((unsigned long long*) assetIssuance.unitOfMeasurement) = *((unsigned long long*) unitOfMeasurement); // Order must be preserved!
@@ -417,8 +418,8 @@ static bool transferShareManagementRights(int sourceOwnershipIndex, int sourcePo
             logPM.possessionPublicKey = possessionPublicKey;
             logPM.ownershipPublicKey = ownershipPublicKey;
             logPM.issuerPublicKey = assets[issuanceIndex].varStruct.issuance.publicKey;
-            logOM.sourceContractIndex = assets[sourcePossessionIndex].varStruct.ownership.managingContractIndex;
-            logOM.destinationContractIndex = destinationPossessionManagingContractIndex;
+            logPM.sourceContractIndex = assets[sourcePossessionIndex].varStruct.ownership.managingContractIndex;
+            logPM.destinationContractIndex = destinationPossessionManagingContractIndex;
             logPM.numberOfShares = numberOfShares;
             *((unsigned long long*) & logPM.assetName) = *((unsigned long long*) & assets[assets[sourceOwnershipIndex].varStruct.ownership.issuanceIndex].varStruct.issuance.name);  // possible with 7 byte array, because it is followed by memory reserved for terminator byte
             logger.logAssetPossessionManagingContractChange(logPM);

src/contract_core/contract_def.h

@@ -1,5 +1,5 @@
 #pragma once
-
+#include "network_messages/common_def.h"
 #include "platform/m256.h"
 
 ////////// Smart contracts \\\\\\\\\\
@@ -194,8 +194,6 @@ struct __FunctionOrProcedureBeginEndGuard
 #define CONTRACT_STATE2_TYPE QSWAP2
 #include "contracts/Qswap.h"
 
-#ifndef NO_NOST
-
 #undef CONTRACT_INDEX
 #undef CONTRACT_STATE_TYPE
 #undef CONTRACT_STATE2_TYPE
@@ -206,7 +204,45 @@ struct __FunctionOrProcedureBeginEndGuard
 #define CONTRACT_STATE2_TYPE NOST2
 #include "contracts/Nostromo.h"
 
-#endif
+#undef CONTRACT_INDEX
+#undef CONTRACT_STATE_TYPE
+#undef CONTRACT_STATE2_TYPE
+
+#define QDRAW_CONTRACT_INDEX 15
+#define CONTRACT_INDEX QDRAW_CONTRACT_INDEX
+#define CONTRACT_STATE_TYPE QDRAW
+#define CONTRACT_STATE2_TYPE QDRAW2
+#include "contracts/Qdraw.h"
+
+#undef CONTRACT_INDEX
+#undef CONTRACT_STATE_TYPE
+#undef CONTRACT_STATE2_TYPE
+
+#define RL_CONTRACT_INDEX 16
+#define CONTRACT_INDEX RL_CONTRACT_INDEX
+#define CONTRACT_STATE_TYPE RL
+#define CONTRACT_STATE2_TYPE RL2
+#include "contracts/RandomLottery.h"
+
+#undef CONTRACT_INDEX
+#undef CONTRACT_STATE_TYPE
+#undef CONTRACT_STATE2_TYPE
+
+#define QBOND_CONTRACT_INDEX 17
+#define CONTRACT_INDEX QBOND_CONTRACT_INDEX
+#define CONTRACT_STATE_TYPE QBOND
+#define CONTRACT_STATE2_TYPE QBOND2
+#include "contracts/QBond.h"
+
+#undef CONTRACT_INDEX
+#undef CONTRACT_STATE_TYPE
+#undef CONTRACT_STATE2_TYPE
+
+#define VOTTUNBRIDGE_CONTRACT_INDEX 18
+#define CONTRACT_INDEX VOTTUNBRIDGE_CONTRACT_INDEX
+#define CONTRACT_STATE_TYPE VOTTUNBRIDGE
+#define CONTRACT_STATE2_TYPE VOTTUNBRIDGE2
+#include "contracts/VottunBridge.h"
 
 // new contracts should be added above this line
 
@@ -304,9 +340,11 @@ constexpr struct ContractDescription
     {"MSVAULT", 149, 10000, sizeof(MSVAULT)}, // proposal in epoch 147, IPO in 148, construction and first use in 149
     {"QBAY", 154, 10000, sizeof(QBAY)}, // proposal in epoch 152, IPO in 153, construction and first use in 154
     {"QSWAP", 171, 10000, sizeof(QSWAP)}, // proposal in epoch 169, IPO in 170, construction and first use in 171
-#ifndef NO_NOST
     {"NOST", 172, 10000, sizeof(NOST)}, // proposal in epoch 170, IPO in 171, construction and first use in 172
-#endif
+    {"QDRAW", 179, 10000, sizeof(QDRAW)}, // proposal in epoch 177, IPO in 178, construction and first use in 179
+    {"RL", 182, 10000, sizeof(RL)}, // proposal in epoch 180, IPO in 181, construction and first use in 182
+    {"QBOND", 182, 10000, sizeof(QBOND)}, // proposal in epoch 180, IPO in 181, construction and first use in 182
+    {"VBRIDGE", 184, 10000, sizeof(VOTTUNBRIDGE)}, // Vottun Bridge - Qubic <-> EVM bridge with multisig admin
     // new contracts should be added above this line
 #ifdef INCLUDE_CONTRACT_TEST_EXAMPLES
     {"TESTEXA", 138, 10000, sizeof(IPO)},
@@ -409,9 +447,11 @@ static void initializeContracts()
     REGISTER_CONTRACT_FUNCTIONS_AND_PROCEDURES(MSVAULT);
     REGISTER_CONTRACT_FUNCTIONS_AND_PROCEDURES(QBAY);
     REGISTER_CONTRACT_FUNCTIONS_AND_PROCEDURES(QSWAP);
-#ifndef NO_NOST
     REGISTER_CONTRACT_FUNCTIONS_AND_PROCEDURES(NOST);
-#endif
+    REGISTER_CONTRACT_FUNCTIONS_AND_PROCEDURES(QDRAW);
+    REGISTER_CONTRACT_FUNCTIONS_AND_PROCEDURES(RL);
+    REGISTER_CONTRACT_FUNCTIONS_AND_PROCEDURES(QBOND);
+    REGISTER_CONTRACT_FUNCTIONS_AND_PROCEDURES(VOTTUNBRIDGE);
     // new contracts should be added above this line
 #ifdef INCLUDE_CONTRACT_TEST_EXAMPLES
     REGISTER_CONTRACT_FUNCTIONS_AND_PROCEDURES(TESTEXA);