Add Qassandra v0 smart contract foundation #913
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Collaborator
There was a problem hiding this comment. please follow the docs and add all required changes for your new contract in contract_def.h (see https://github.com/qubic/core/blob/main/doc/contracts.md#development) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,256 @@ | ||
| using namespace QPI; | ||
|
|
||
| // QASSAND is the Qubic contract implementation name for the Qassandra protocol v0. | ||
| constexpr uint16 QASSAND_VERSION = 0; | ||
| constexpr uint16 QASSAND_CONSTRUCTION_EPOCH_PLACEHOLDER = 10000; | ||
| constexpr uint64 QASSAND_PROTOCOL_FEE = 75000; | ||
| constexpr uint64 QASSAND_BURN_FEE = 25000; | ||
| constexpr uint64 QASSAND_PING_FEE = QASSAND_PROTOCOL_FEE + QASSAND_BURN_FEE; | ||
| constexpr uint8 QASSAND_SUCCESS = 0; | ||
| constexpr uint8 QASSAND_UNDERPAID = 1; | ||
| constexpr uint8 QASSAND_UNKNOWN_LANE = 2; | ||
| constexpr uint16 QASSAND_LANE_UNKNOWN = 0; | ||
| constexpr uint16 QASSAND_LANE_FORECASTING = 1; | ||
| constexpr uint16 QASSAND_LANE_STABLE_OPERATIONS = 2; | ||
| constexpr uint16 QASSAND_LANE_DATA_ATTESTATION = 3; | ||
|
|
||
| struct QASSAND2 | ||
| { | ||
| }; | ||
|
|
||
| struct QASSAND : public ContractBase | ||
| { | ||
| struct StateData | ||
|
Collaborator
There was a problem hiding this comment. for some of these variables, it does not really make sense that they are signed integers because naturally they will always ne non-negative (e.g. fees, amounts). please double-check which variables need to be signed/unsigned. |
||
| { | ||
| uint16 version; | ||
| uint16 constructionEpoch; | ||
| uint64 protocolFee; | ||
| uint64 burnFee; | ||
| uint64 totalPingCount; | ||
| uint64 protocolEarnedFee; | ||
| uint64 burnEarnedFee; | ||
| uint64 pendingBurnAmount; | ||
| uint64 totalBurnedAmount; | ||
| }; | ||
|
|
||
| struct Ping_input | ||
| { | ||
| }; | ||
|
|
||
| struct Ping_output | ||
| { | ||
| uint8 returnCode; | ||
| uint64 acceptedFee; | ||
| uint64 refundedAmount; | ||
| uint64 protocolEarnedFee; | ||
| uint64 burnEarnedFee; | ||
| uint64 totalPingCount; | ||
| }; | ||
|
|
||
| struct Ping_locals | ||
| { | ||
| uint64 paidAmount; | ||
| uint64 refundAmount; | ||
| }; | ||
|
|
||
| struct GetInfo_input | ||
| { | ||
| }; | ||
|
|
||
| struct GetInfo_output | ||
| { | ||
| Array<uint8, 16> protocolName; | ||
| uint16 version; | ||
| uint16 constructionEpoch; | ||
| uint64 totalPingCount; | ||
| }; | ||
|
|
||
| struct GetFeeInfo_input | ||
| { | ||
| }; | ||
|
|
||
| struct GetFeeInfo_output | ||
| { | ||
| uint64 pingFee; | ||
| uint64 protocolFee; | ||
| uint64 burnFee; | ||
| uint64 protocolEarnedFee; | ||
| uint64 burnEarnedFee; | ||
| }; | ||
|
|
||
| struct GetBurnInfo_input | ||
| { | ||
| }; | ||
|
|
||
| struct GetBurnInfo_output | ||
| { | ||
| uint64 pendingBurnAmount; | ||
| uint64 totalBurnedAmount; | ||
| }; | ||
|
|
||
| struct GetLaneInfo_input | ||
| { | ||
| uint16 laneId; | ||
| }; | ||
|
|
||
| struct GetLaneInfo_output | ||
| { | ||
| uint8 returnCode; | ||
| uint16 laneId; | ||
| Array<uint8, 16> laneName; | ||
| uint64 requiredFee; | ||
| }; | ||
|
|
||
| struct END_TICK_locals | ||
| { | ||
| uint64 burnAmount; | ||
| }; | ||
|
|
||
| INITIALIZE() | ||
| { | ||
| state.mut().version = QASSAND_VERSION; | ||
| state.mut().constructionEpoch = QASSAND_CONSTRUCTION_EPOCH_PLACEHOLDER; | ||
| state.mut().protocolFee = QASSAND_PROTOCOL_FEE; | ||
| state.mut().burnFee = QASSAND_BURN_FEE; | ||
| } | ||
|
|
||
| REGISTER_USER_FUNCTIONS_AND_PROCEDURES() | ||
| { | ||
| REGISTER_USER_PROCEDURE(Ping, 1); | ||
| REGISTER_USER_FUNCTION(GetInfo, 1); | ||
| REGISTER_USER_FUNCTION(GetFeeInfo, 2); | ||
| REGISTER_USER_FUNCTION(GetBurnInfo, 3); | ||
| REGISTER_USER_FUNCTION(GetLaneInfo, 4); | ||
| } | ||
|
|
||
| END_TICK_WITH_LOCALS() | ||
| { | ||
| locals.burnAmount = state.get().pendingBurnAmount; | ||
| if (locals.burnAmount == 0) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| qpi.burn(locals.burnAmount); | ||
| state.mut().pendingBurnAmount = 0; | ||
| state.mut().totalBurnedAmount += locals.burnAmount; | ||
| } | ||
|
|
||
| PUBLIC_PROCEDURE_WITH_LOCALS(Ping) | ||
| { | ||
| locals.paidAmount = qpi.invocationReward(); | ||
|
|
||
| if (locals.paidAmount < (state.get().protocolFee + state.get().burnFee)) | ||
| { | ||
| if (locals.paidAmount != 0) | ||
| { | ||
| qpi.transfer(qpi.invocator(), locals.paidAmount); | ||
| } | ||
| output.returnCode = QASSAND_UNDERPAID; | ||
| output.refundedAmount = locals.paidAmount; | ||
| return; | ||
| } | ||
|
|
||
| locals.refundAmount = locals.paidAmount - (state.get().protocolFee + state.get().burnFee); | ||
| if (locals.refundAmount != 0) | ||
| { | ||
| qpi.transfer(qpi.invocator(), locals.refundAmount); | ||
| } | ||
|
|
||
| state.mut().totalPingCount += 1; | ||
| state.mut().protocolEarnedFee += state.get().protocolFee; | ||
|
Collaborator
There was a problem hiding this comment. I see in your definitions at the beginning of the file that the amounts for |
||
| state.mut().burnEarnedFee += state.get().burnFee; | ||
| state.mut().pendingBurnAmount += state.get().burnFee; | ||
|
|
||
| output.returnCode = QASSAND_SUCCESS; | ||
| output.acceptedFee = (state.get().protocolFee + state.get().burnFee); | ||
| output.refundedAmount = locals.refundAmount; | ||
| output.protocolEarnedFee = state.get().protocolFee; | ||
| output.burnEarnedFee = state.get().burnFee; | ||
| output.totalPingCount = state.get().totalPingCount; | ||
| } | ||
|
|
||
| PUBLIC_FUNCTION(GetInfo) | ||
| { | ||
| output.protocolName.set(0, 81); | ||
| output.protocolName.set(1, 97); | ||
| output.protocolName.set(2, 115); | ||
| output.protocolName.set(3, 115); | ||
| output.protocolName.set(4, 97); | ||
| output.protocolName.set(5, 110); | ||
| output.protocolName.set(6, 100); | ||
| output.protocolName.set(7, 114); | ||
| output.protocolName.set(8, 97); | ||
| output.version = state.get().version; | ||
| output.constructionEpoch = state.get().constructionEpoch; | ||
| output.totalPingCount = state.get().totalPingCount; | ||
| } | ||
|
|
||
| PUBLIC_FUNCTION(GetFeeInfo) | ||
| { | ||
| output.pingFee = (state.get().protocolFee + state.get().burnFee); | ||
| output.protocolFee = state.get().protocolFee; | ||
| output.burnFee = state.get().burnFee; | ||
| output.protocolEarnedFee = state.get().protocolEarnedFee; | ||
| output.burnEarnedFee = state.get().burnEarnedFee; | ||
| } | ||
|
|
||
| PUBLIC_FUNCTION(GetBurnInfo) | ||
| { | ||
| output.pendingBurnAmount = state.get().pendingBurnAmount; | ||
| output.totalBurnedAmount = state.get().totalBurnedAmount; | ||
| } | ||
|
|
||
| PUBLIC_FUNCTION(GetLaneInfo) | ||
| { | ||
| if (input.laneId == QASSAND_LANE_FORECASTING) | ||
| { | ||
| output.returnCode = QASSAND_SUCCESS; | ||
| output.laneId = QASSAND_LANE_FORECASTING; | ||
| output.laneName.set(0, 70); | ||
| output.laneName.set(1, 111); | ||
| output.laneName.set(2, 114); | ||
| output.laneName.set(3, 101); | ||
| output.laneName.set(4, 99); | ||
| output.laneName.set(5, 97); | ||
| output.laneName.set(6, 115); | ||
| output.laneName.set(7, 116); | ||
| output.laneName.set(8, 105); | ||
| output.laneName.set(9, 110); | ||
| output.laneName.set(10, 103); | ||
| output.requiredFee = 0; | ||
| return; | ||
| } | ||
|
|
||
| if (input.laneId == QASSAND_LANE_STABLE_OPERATIONS) | ||
| { | ||
| output.returnCode = QASSAND_SUCCESS; | ||
| output.laneId = QASSAND_LANE_STABLE_OPERATIONS; | ||
| output.laneName.set(0, 83); | ||
| output.laneName.set(1, 116); | ||
| output.laneName.set(2, 97); | ||
| output.laneName.set(3, 98); | ||
| output.laneName.set(4, 108); | ||
| output.laneName.set(5, 101); | ||
| output.laneName.set(6, 79); | ||
| output.laneName.set(7, 112); | ||
| output.laneName.set(8, 115); | ||
| output.requiredFee = 0; | ||
| return; | ||
| } | ||
|
|
||
| if (input.laneId == QASSAND_LANE_DATA_ATTESTATION) | ||
| { | ||
| output.returnCode = QASSAND_SUCCESS; | ||
| output.laneId = QASSAND_LANE_DATA_ATTESTATION; | ||
| output.laneName.set(0, 68); | ||
| output.laneName.set(1, 97); | ||
| output.laneName.set(2, 116); | ||
| output.laneName.set(3, 97); | ||
| output.requiredFee = 0; | ||
| return; | ||
| } | ||
|
|
||
| output.returnCode = QASSAND_UNKNOWN_LANE; | ||
| } | ||
| }; | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what you did to this file but the diff shows changes in all lines (line ending change?). please restore the original version and make sure that the commit only affects the lines where you actually added code for your contract.