Merge pull request #557 from qubic/develop (Release v1.261.0)

Release v1.261.0

Author: Franziska-Mueller

.github/workflows/contract-verify.yml

@@ -32,6 +32,6 @@ jobs:
           echo "contract-filepaths=$files" >> "$GITHUB_OUTPUT"
       - name: Contract verify action step
         id: verify
-        uses: Franziska-Mueller/qubic-contract-verify@v0.3.3-beta
+        uses: Franziska-Mueller/qubic-contract-verify@v1.0.0
         with:
           filepaths: '${{ steps.filepaths.outputs.contract-filepaths }}'

doc/contracts.md

@@ -107,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.
@@ -635,3 +635,4 @@ The function `castVote()` is a more complex example combining both, calling a co
 
 
 
+

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.
@@ -391,3 +402,4 @@ Even when bound by serializing instructions, the system environment at the time
 
 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/contracts/Nostromo.h

@@ -1147,7 +1147,6 @@ struct NOST : public ContractBase
 			{
 				// success
 				output.transferredNumberOfShares = input.numberOfShares;
-				qpi.transfer(id(QX_CONTRACT_INDEX, 0, 0, 0), state.transferRightsFee);
 				if (qpi.invocationReward() > state.transferRightsFee)
 				{
 					qpi.transfer(qpi.invocator(), qpi.invocationReward() -  state.transferRightsFee);

src/contracts/Qbay.h

@@ -2171,7 +2171,6 @@ struct QBAY : public ContractBase
 			{
 				// success
 				output.transferredNumberOfShares = input.numberOfShares;
-				qpi.transfer(id(QX_CONTRACT_INDEX, 0, 0, 0), state.transferRightsFee);
 				if (qpi.invocationReward() > state.transferRightsFee)
 				{
 					qpi.transfer(qpi.invocator(), qpi.invocationReward() -  state.transferRightsFee);
@@ -2502,6 +2501,11 @@ struct QBAY : public ContractBase
 
 	}
 
+	BEGIN_EPOCH()
+	{
+		state.transferRightsFee = 100;
+	}
+
 	struct END_EPOCH_locals
 	{
 		QX::TransferShareManagementRights_input transferShareManagementRights_input;

src/contracts/Qswap.h

@@ -1,5 +1,15 @@
 using namespace QPI;
 
+// Log types enum for QSWAP contract
+enum QSWAPLogInfo {
+    QSWAPAddLiquidity = 4,
+    QSWAPRemoveLiquidity = 5,
+    QSWAPSwapExactQuForAsset = 6,
+    QSWAPSwapQuForExactAsset = 7,
+    QSWAPSwapExactAssetForQu = 8,
+    QSWAPSwapAssetForExactQu = 9
+};
+
 // FIXED CONSTANTS
 constexpr uint64 QSWAP_INITIAL_MAX_POOL = 16384;
 constexpr uint64 QSWAP_MAX_POOL = QSWAP_INITIAL_MAX_POOL * X_MULTIPLIER;
@@ -12,6 +22,39 @@ struct QSWAP2
 {
 };
 
+// Logging message structures for QSWAP procedures
+struct QSWAPAddLiquidityMessage
+{
+    uint32 _contractIndex;
+    uint32 _type;
+    id assetIssuer;
+    uint64 assetName;
+    sint64 userIncreaseLiquidity;
+    sint64 quAmount;
+    sint64 assetAmount;
+    sint8 _terminator;
+};
+
+struct QSWAPRemoveLiquidityMessage
+{
+    uint32 _contractIndex;
+    uint32 _type;
+    sint64 quAmount;
+    sint64 assetAmount;
+    sint8 _terminator;
+};
+
+struct QSWAPSwapMessage
+{
+    uint32 _contractIndex;
+    uint32 _type;
+    id assetIssuer;
+    uint64 assetName;
+    sint64 assetAmountIn;
+    sint64 assetAmountOut;
+    sint8 _terminator;
+};
+
 struct QSWAP : public ContractBase
 {
 public:
@@ -230,6 +273,17 @@ struct QSWAP : public ContractBase
 		sint64 assetAmountIn;
 	};
 
+	struct TransferShareManagementRights_input
+	{
+		Asset asset;
+		sint64 numberOfShares;
+		uint32 newManagingContractIndex;
+	};
+	struct TransferShareManagementRights_output
+	{
+		sint64 transferredNumberOfShares;
+	};
+
 protected:
 	uint32 swapFeeRate; 		// e.g. 30: 0.3% (base: 10_000)
 	uint32 teamFeeRate;			// e.g. 20: 20% (base: 100)
@@ -895,6 +949,7 @@ struct QSWAP : public ContractBase
 
 	struct AddLiquidity_locals
 	{
+		QSWAPAddLiquidityMessage addLiquidityMessage;
 		id poolID;
 		sint64 poolSlot;
 		PoolBasicState poolBasicState;
@@ -1210,6 +1265,16 @@ struct QSWAP : public ContractBase
 
 		state.mPoolBasicStates.set(locals.poolSlot, locals.poolBasicState);
 
+		// Log AddLiquidity procedure
+		locals.addLiquidityMessage._contractIndex = SELF_INDEX;
+		locals.addLiquidityMessage._type = QSWAPAddLiquidity;
+		locals.addLiquidityMessage.assetIssuer = input.assetIssuer;
+		locals.addLiquidityMessage.assetName = input.assetName;
+		locals.addLiquidityMessage.userIncreaseLiquidity = output.userIncreaseLiquidity;
+		locals.addLiquidityMessage.quAmount = output.quAmount;
+		locals.addLiquidityMessage.assetAmount = output.assetAmount;
+		LOG_INFO(locals.addLiquidityMessage);
+
 		if (qpi.invocationReward() > locals.quTransferAmount)
 		{
 			qpi.transfer(qpi.invocator(), qpi.invocationReward() - locals.quTransferAmount);
@@ -1218,6 +1283,7 @@ struct QSWAP : public ContractBase
 
 	struct RemoveLiquidity_locals
 	{
+		QSWAPRemoveLiquidityMessage removeLiquidityMessage;
 		id poolID;
 		PoolBasicState poolBasicState;
 		sint64 userLiquidityElementIndex;
@@ -1346,10 +1412,18 @@ struct QSWAP : public ContractBase
 		locals.poolBasicState.reservedAssetAmount -= locals.burnAssetAmount;
 
 		state.mPoolBasicStates.set(locals.poolSlot, locals.poolBasicState);
+
+		// Log RemoveLiquidity procedure
+		locals.removeLiquidityMessage._contractIndex = SELF_INDEX;
+		locals.removeLiquidityMessage._type = QSWAPRemoveLiquidity;
+		locals.removeLiquidityMessage.quAmount = output.quAmount;
+		locals.removeLiquidityMessage.assetAmount = output.assetAmount;
+		LOG_INFO(locals.removeLiquidityMessage);
 	}
 
 	struct SwapExactQuForAsset_locals
 	{
+		QSWAPSwapMessage swapMessage;
 		id poolID;
 		sint64 poolSlot;
 		sint64 quAmountIn;
@@ -1466,10 +1540,20 @@ struct QSWAP : public ContractBase
 		locals.poolBasicState.reservedQuAmount += locals.quAmountIn - sint64(locals.feeToTeam.low) - sint64(locals.feeToProtocol.low);
 		locals.poolBasicState.reservedAssetAmount -= locals.assetAmountOut;
 		state.mPoolBasicStates.set(locals.poolSlot, locals.poolBasicState);
+
+		// Log SwapExactQuForAsset procedure
+		locals.swapMessage._contractIndex = SELF_INDEX;
+		locals.swapMessage._type = QSWAPSwapExactQuForAsset;
+		locals.swapMessage.assetIssuer = input.assetIssuer;
+		locals.swapMessage.assetName = input.assetName;
+		locals.swapMessage.assetAmountIn = locals.quAmountIn;
+		locals.swapMessage.assetAmountOut = output.assetAmountOut;
+		LOG_INFO(locals.swapMessage);
 	}
 
 	struct SwapQuForExactAsset_locals
 	{
+		QSWAPSwapMessage swapMessage;
 		id poolID;
 		sint64 poolSlot;
 		PoolBasicState poolBasicState;
@@ -1601,10 +1685,20 @@ struct QSWAP : public ContractBase
 		locals.poolBasicState.reservedQuAmount += locals.quAmountIn - sint64(locals.feeToTeam.low) - sint64(locals.feeToProtocol.low);
 		locals.poolBasicState.reservedAssetAmount -= input.assetAmountOut;
 		state.mPoolBasicStates.set(locals.poolSlot, locals.poolBasicState);
+
+		// Log SwapQuForExactAsset procedure
+		locals.swapMessage._contractIndex = SELF_INDEX;
+		locals.swapMessage._type = QSWAPSwapQuForExactAsset;
+		locals.swapMessage.assetIssuer = input.assetIssuer;
+		locals.swapMessage.assetName = input.assetName;
+		locals.swapMessage.assetAmountIn = output.quAmountIn;
+		locals.swapMessage.assetAmountOut = input.assetAmountOut;
+		LOG_INFO(locals.swapMessage);
 	}
 
 	struct SwapExactAssetForQu_locals
 	{
+		QSWAPSwapMessage swapMessage;
 		id poolID;
 		sint64 poolSlot;
 		PoolBasicState poolBasicState;
@@ -1755,10 +1849,20 @@ struct QSWAP : public ContractBase
 		state.protocolEarnedFee += locals.feeToProtocol.low;
 
 		state.mPoolBasicStates.set(locals.poolSlot, locals.poolBasicState);
+
+		// Log SwapExactAssetForQu procedure
+		locals.swapMessage._contractIndex = SELF_INDEX;
+		locals.swapMessage._type = QSWAPSwapExactAssetForQu;
+		locals.swapMessage.assetIssuer = input.assetIssuer;
+		locals.swapMessage.assetName = input.assetName;
+		locals.swapMessage.assetAmountIn = input.assetAmountIn;
+		locals.swapMessage.assetAmountOut = output.quAmountOut;
+		LOG_INFO(locals.swapMessage);
 	}
 
 	struct SwapAssetForExactQu_locals
 	{
+		QSWAPSwapMessage swapMessage;
 		id poolID;
 		sint64 poolSlot;
 		PoolBasicState poolBasicState;
@@ -1903,6 +2007,15 @@ struct QSWAP : public ContractBase
 		locals.poolBasicState.reservedQuAmount -= sint64(locals.feeToTeam.low);
 		locals.poolBasicState.reservedQuAmount -= sint64(locals.feeToProtocol.low);
 		state.mPoolBasicStates.set(locals.poolSlot, locals.poolBasicState);
+
+		// Log SwapAssetForExactQu procedure
+		locals.swapMessage._contractIndex = SELF_INDEX;
+		locals.swapMessage._type = QSWAPSwapAssetForExactQu;
+		locals.swapMessage.assetIssuer = input.assetIssuer;
+		locals.swapMessage.assetName = input.assetName;
+		locals.swapMessage.assetAmountIn = output.assetAmountIn;
+		locals.swapMessage.assetAmountOut = input.quAmountOut;
+		LOG_INFO(locals.swapMessage);
 	}
 
 	struct TransferShareOwnershipAndPossession_locals
@@ -1982,6 +2095,46 @@ struct QSWAP : public ContractBase
 		output.success = true;
 	}
 
+	PUBLIC_PROCEDURE(TransferShareManagementRights)
+	{
+		if (qpi.invocationReward() < QSWAP_FEE_BASE_100)
+		{
+			return ;
+		}
+
+		if (qpi.numberOfPossessedShares(input.asset.assetName, input.asset.issuer,qpi.invocator(), qpi.invocator(), SELF_INDEX, SELF_INDEX) < input.numberOfShares)
+		{
+			// not enough shares available
+			output.transferredNumberOfShares = 0;
+			if (qpi.invocationReward() > 0)
+			{
+				qpi.transfer(qpi.invocator(), qpi.invocationReward());
+			}
+		}
+		else
+		{
+			if (qpi.releaseShares(input.asset, qpi.invocator(), qpi.invocator(), input.numberOfShares,
+				input.newManagingContractIndex, input.newManagingContractIndex, QSWAP_FEE_BASE_100) < 0)
+			{
+				// error
+				output.transferredNumberOfShares = 0;
+				if (qpi.invocationReward() > 0)
+				{
+					qpi.transfer(qpi.invocator(), qpi.invocationReward());
+				}
+			}
+			else
+			{
+				// success
+				output.transferredNumberOfShares = input.numberOfShares;
+				if (qpi.invocationReward() > QSWAP_FEE_BASE_100)
+				{
+					qpi.transfer(qpi.invocator(), qpi.invocationReward() -  QSWAP_FEE_BASE_100);
+				}
+			}
+		}
+	}
+
 	REGISTER_USER_FUNCTIONS_AND_PROCEDURES()
 	{
 		// functions
@@ -2005,6 +2158,7 @@ struct QSWAP : public ContractBase
 		REGISTER_USER_PROCEDURE(SwapExactAssetForQu, 8);
 		REGISTER_USER_PROCEDURE(SwapAssetForExactQu, 9);
 		REGISTER_USER_PROCEDURE(SetTeamInfo, 10);
+		REGISTER_USER_PROCEDURE(TransferShareManagementRights, 11);
 	}
 
 	INITIALIZE()
@@ -2036,4 +2190,8 @@ struct QSWAP : public ContractBase
 			}
 		}
 	}
+	PRE_ACQUIRE_SHARES()
+    {
+		output.allowTransfer = true;
+    }
 };

src/logging/logging.h

@@ -576,12 +576,14 @@ class qLogger
 #endif
     }
 
+    // updateTick is called right after _tick is processed
     static void updateTick(unsigned int _tick)
     {
 #if ENABLED_LOGGING
         ASSERT((_tick == lastUpdatedTick + 1) || (_tick == tickBegin));
+        ASSERT(_tick >= tickBegin);
 #if LOG_STATE_DIGEST
-        unsigned long long index = lastUpdatedTick - tickBegin;
+        unsigned long long index = _tick - tickBegin;
         XKCP::KangarooTwelve_Final(&k12, digests[index].m256i_u8, (const unsigned char*)"", 0);
         XKCP::KangarooTwelve_Initialize(&k12, 128, 32); // init new k12
         XKCP::KangarooTwelve_Update(&k12, digests[index].m256i_u8, 32); // feed the prev hash back to this

src/public_settings.h

@@ -28,7 +28,7 @@
 
 // The tick duration used to calculate the size of memory buffers.
 // This determines the memory footprint of the application.
-#define TICK_DURATION_FOR_ALLOCATION_MS 500
+#define TICK_DURATION_FOR_ALLOCATION_MS 750
 #define TRANSACTION_SPARSENESS 1
 
 // Below are 2 variables that are used for auto-F5 feature:
@@ -61,12 +61,12 @@ static_assert(AUTO_FORCE_NEXT_TICK_THRESHOLD* TARGET_TICK_DURATION >= PEER_REFRE
 // Config options that should NOT be changed by operators
 
 #define VERSION_A 1
-#define VERSION_B 260
+#define VERSION_B 261
 #define VERSION_C 0
 
 // Epoch and initial tick for node startup
-#define EPOCH 179
-#define TICK 32742000
+#define EPOCH 180
+#define TICK 33232000
 #define TICK_IS_FIRST_TICK_OF_EPOCH 1 // Set to 0 if the network is restarted during the EPOCH with a new initial TICK
 
 #define ARBITRATOR "AFZPUAIYVPNUYGJRQVLUKOPPVLHAZQTGLYAAUUNBXFTVTAMSBKQBLEIEPCVJ"
@@ -84,7 +84,7 @@ static unsigned short CUSTOM_MINING_V2_CACHE_FILE_NAME[] = L"custom_mining_v2_ca
 
 static constexpr unsigned long long NUMBER_OF_INPUT_NEURONS = 512;     // K
 static constexpr unsigned long long NUMBER_OF_OUTPUT_NEURONS = 512;    // L
-static constexpr unsigned long long NUMBER_OF_TICKS = 600;               // N
+static constexpr unsigned long long NUMBER_OF_TICKS = 1000;               // N
 static constexpr unsigned long long NUMBER_OF_NEIGHBORS = 728;    // 2M. Must be divided by 2
 static constexpr unsigned long long NUMBER_OF_MUTATIONS = 150;
 static constexpr unsigned long long POPULATION_THRESHOLD = NUMBER_OF_INPUT_NEURONS + NUMBER_OF_OUTPUT_NEURONS + NUMBER_OF_MUTATIONS; // P