Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring inputs to be named types #364

Merged
merged 13 commits into from
Mar 17, 2023
Merged

Conversation

xgreenx
Copy link
Collaborator

@xgreenx xgreenx commented Feb 23, 2023

It is preparation for the FuelLabs/fuel-core#946.

The upcoming DepositCoin is a message under the hood but with an empty data field.
I did this refactoring to remove the duplication of the code and keep tracking all "magic" rules for the Input and its variants.

Based on this PR, I will create a CoinSigned and CoinPredicate sub-messages with empty data field.

@xgreenx xgreenx self-assigned this Feb 23, 2023
field, Cacheable, Chargeable, CheckError, ConsensusParameters, Create, Executable, FormatValidityChecks, Input,
InputRepr, Mint, Output, OutputRepr, Script, StorageSlot, Transaction, TransactionFee, TransactionRepr, TxId,
UtxoId, Witness,
field, input, input::Input, input::InputRepr, Cacheable, Chargeable, CheckError, ConsensusParameters, Create,
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm exporting input::Input, input::InputRepr separately not to make the breaking change.

@@ -84,26 +86,31 @@ impl Input {
witnesses: &[Witness],
parameters: &ConsensusParameters,
) -> Result<(), CheckError> {
// TODO: Add verification of the `message_id` with hash from `Message`'s fields.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will be done in the upcoming PR. It awaits an answer to the question.

@xgreenx xgreenx added breaking A breaking api change fuel-tx Related to the `fuel-tx` crate. labels Feb 23, 2023
@xgreenx xgreenx requested a review from a team February 23, 2023 18:20
@xgreenx xgreenx marked this pull request as ready for review February 23, 2023 18:59
@Voxelot Voxelot mentioned this pull request Feb 27, 2023
@xgreenx xgreenx force-pushed the feature/inputs-refactoring branch from 5a0b583 to c9b5425 Compare March 13, 2023 14:01
@xgreenx xgreenx changed the base branch from master to freesig/remove-all-unsafe March 13, 2023 14:01
Base automatically changed from freesig/remove-all-unsafe to master March 14, 2023 01:28
freesig and others added 9 commits March 14, 2023 16:52
all types updated

all unsafe removed

add comments

fix tests

fix tests

fix tests

pr changes
Added more tests for `memcopy` and fixed a bug.
Added missed tests for message serialization.
Removed unused unsafe code.
Removed `RESERVED**` variants from the `PanicReason` enum.
@xgreenx xgreenx force-pushed the feature/inputs-refactoring branch from c9b5425 to f598eb5 Compare March 14, 2023 16:53
assert_eq!(l.sender.addr(), super::consts::INPUT_MESSAGE_SENDER_OFFSET);
assert_eq!(l.recipient.addr(), super::consts::INPUT_MESSAGE_RECIPIENT_OFFSET);
assert_eq!(MessageSizesLayout::LEN, super::consts::INPUT_MESSAGE_FIXED_SIZE);
assert_eq!(l.message_id.addr(), super::consts::INPUT_MESSAGE_ID_OFFSET - WORD_SIZE);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a comment here to explain why we need to subtract WORD_SIZE here?

@xgreenx xgreenx added this pull request to the merge queue Mar 17, 2023
Merged via the queue into master with commit 293aa35 Mar 17, 2023
@xgreenx xgreenx deleted the feature/inputs-refactoring branch March 17, 2023 00:52
xgreenx added a commit to FuelLabs/fuel-core that referenced this pull request Apr 27, 2023
The change bumps the version to `0.18.0` and exposes
`sync_max_get_header` and `sync_max_get_txns` in the helm chart.

# Release 0.18.0

## Overview

A new release brings:
- Optimization for the execution based on the performance from beta 3
and on internal benchmarks. Improved metrics gathering.
- Stabilization and better test coverage of the `fuel-vm`. We removed
almost all unsafe code and added test cases for each opcode. Fixed some
edge cases with memory in the `fuel-vm`.
- Fully integrated Merkle trees and filled all malleable fields in the
transactions.
- Added retryable messages, removed redundant fields from it, and
updated the API to support a new commitment schema.

## What's Changed

### Breaking

- All unsafe functions were replaced with safe analog in the
`fuel-crypto` - FuelLabs/fuel-vm#346
- `$hp` holds the address of the last available byte in a heap, while
previously it was `$hp - 1` -
FuelLabs/fuel-vm#377
- Each variant in the `fuel_tx::Input` enum now has its own type -
FuelLabs/fuel-vm#364
- Message nonce is unified and now `Bytes32` everywhere -
FuelLabs/fuel-vm#394
- Removed the `message_id` field from all places -
FuelLabs/fuel-vm#397,
FuelLabs/fuel-vm#373,
- Unified the block height in all places with the introduction of a new
`BlockHeigh` - FuelLabs/fuel-vm#410
- Make SMO instruction take data ptr as an argument -
FuelLabs/fuel-vm#404
- Now the chain id affects the signature and predicate's owner and
should be passed into the `sign` function -
FuelLabs/fuel-vm#406
- Updated the `produce_blocks` endpoint to accept the start time and the
number of blocks. All new blocks will use the previous timestamp as a
base - #1059
- The `fuel-core` stores only unspent coins and messages, so all API
that previously returned spent coins is affected - Prune owned coin idx
when inputs are spent by @Voxelot in
#1055
- The message proof API has been changed to be compatible with a new
version - #1071
- The `fuel-core` now has retryable messages and coin messages.
Retryable messages can only be consumed during successful transaction
execution. The coin message acts as common coins. `resouces_to_spend`
API was replaced with `coins_to_spend` that returns a new `CoinType`
type. - #1067

## All changes
* adding fuel-core service monitor to helm chart by @rfuelsh in
#1037
* Adding specific app selector by @rfuelsh in
#1039
* use sticky sessions for GQL requests to sentries by @Voxelot in
#1042
* Add ingress service name to helm chart by @rfuelsh in
#1043
* Added test to verify the iteration over owned transactions by @xgreenx
in #1041
* Change sentry lb to use clusterIP by @Voxelot in
#1045
* Fixed Tempfile dependency by @ControlCplusControlV in
#1048
* Write contract code in raw by @freesig in
#994
* attempt to use buildjet runners by @Voxelot in
#1017
* Set tx pointer during block production by @Voxelot in
#1054
* Used `BASE_AMOUNT` for test with bob to pay for fee by @xgreenx in
#1057
* Prepare GraphQL Crate for extraction by @ControlCplusControlV in
#1012
* Support large contract deployments over p2p by @Voxelot in
#1062
* fix yaml and add linting job by @Voxelot in
#1063
* Actualized the ABI for message to be compatible with last version of
the Solidity contracts. by @xgreenx in
#1060
* feat: Contract state and assets merkle data storage by @bvrooman in
#1008
* Take into account the previous block timestamp during block production
by @xgreenx in #1059
* Prune owned coin idx when inputs are spent by @Voxelot in
#1055
* Retrayable messages fuel-core part by @xgreenx in
#1067
* chore: Additional Tests for Contract States and Balances by @bvrooman
in #1073
* Rust 1.68.1 & Sparse Registry by @Voxelot in
#1077
* Nginx tuneup by @Voxelot in
#1080
* chore: Update balance and state Merkleization by @bvrooman in
#1084
* Support sticky session in the client by @xgreenx in
#1079
* Added e2e test to run 1000 `dry_run` by @xgreenx in
#1091
* Use docker.io auth credentials to overcome rate limiting by @Voxelot
in #1092
* honeycomb tracing subscription by @Voxelot in
#1083
* Update withdrawal proof API to support proving from a block header
committed to L1 by @xgreenx in
#1071
* Upstream v0.17.8 by @Voxelot in
#1102
* use chainid for transactions and predicates by @Voxelot in
#1107
* fix the dry-run e2e test to actually perform dry runs by @Voxelot in
#1111
* peer reputation with separate app & gossipsub score by @leviathanbeak
in #1028
* Adding sentry data synchronization by @rfuelsh in
#1115
* Capture metrics for graphql api by @Voxelot in
#1113
* Update cargo audit and add to commit by @freesig in
#1152
* add task params by @leviathanbeak in
#1159
* Took into account that block creation could take some time by @xgreenx
in #1162
* Applying optimizations from `0.17.11` release by @xgreenx in
#1158


**Full Changelog**:
v0.17.3...v0.18.0
crypto523 pushed a commit to crypto523/fuel-core that referenced this pull request Oct 7, 2024
The change bumps the version to `0.18.0` and exposes
`sync_max_get_header` and `sync_max_get_txns` in the helm chart.

# Release 0.18.0

## Overview

A new release brings:
- Optimization for the execution based on the performance from beta 3
and on internal benchmarks. Improved metrics gathering.
- Stabilization and better test coverage of the `fuel-vm`. We removed
almost all unsafe code and added test cases for each opcode. Fixed some
edge cases with memory in the `fuel-vm`.
- Fully integrated Merkle trees and filled all malleable fields in the
transactions.
- Added retryable messages, removed redundant fields from it, and
updated the API to support a new commitment schema.

## What's Changed

### Breaking

- All unsafe functions were replaced with safe analog in the
`fuel-crypto` - FuelLabs/fuel-vm#346
- `$hp` holds the address of the last available byte in a heap, while
previously it was `$hp - 1` -
FuelLabs/fuel-vm#377
- Each variant in the `fuel_tx::Input` enum now has its own type -
FuelLabs/fuel-vm#364
- Message nonce is unified and now `Bytes32` everywhere -
FuelLabs/fuel-vm#394
- Removed the `message_id` field from all places -
FuelLabs/fuel-vm#397,
FuelLabs/fuel-vm#373,
- Unified the block height in all places with the introduction of a new
`BlockHeigh` - FuelLabs/fuel-vm#410
- Make SMO instruction take data ptr as an argument -
FuelLabs/fuel-vm#404
- Now the chain id affects the signature and predicate's owner and
should be passed into the `sign` function -
FuelLabs/fuel-vm#406
- Updated the `produce_blocks` endpoint to accept the start time and the
number of blocks. All new blocks will use the previous timestamp as a
base - FuelLabs/fuel-core#1059
- The `fuel-core` stores only unspent coins and messages, so all API
that previously returned spent coins is affected - Prune owned coin idx
when inputs are spent by @Voxelot in
FuelLabs/fuel-core#1055
- The message proof API has been changed to be compatible with a new
version - FuelLabs/fuel-core#1071
- The `fuel-core` now has retryable messages and coin messages.
Retryable messages can only be consumed during successful transaction
execution. The coin message acts as common coins. `resouces_to_spend`
API was replaced with `coins_to_spend` that returns a new `CoinType`
type. - FuelLabs/fuel-core#1067

## All changes
* adding fuel-core service monitor to helm chart by @rfuelsh in
FuelLabs/fuel-core#1037
* Adding specific app selector by @rfuelsh in
FuelLabs/fuel-core#1039
* use sticky sessions for GQL requests to sentries by @Voxelot in
FuelLabs/fuel-core#1042
* Add ingress service name to helm chart by @rfuelsh in
FuelLabs/fuel-core#1043
* Added test to verify the iteration over owned transactions by @xgreenx
in FuelLabs/fuel-core#1041
* Change sentry lb to use clusterIP by @Voxelot in
FuelLabs/fuel-core#1045
* Fixed Tempfile dependency by @ControlCplusControlV in
FuelLabs/fuel-core#1048
* Write contract code in raw by @freesig in
FuelLabs/fuel-core#994
* attempt to use buildjet runners by @Voxelot in
FuelLabs/fuel-core#1017
* Set tx pointer during block production by @Voxelot in
FuelLabs/fuel-core#1054
* Used `BASE_AMOUNT` for test with bob to pay for fee by @xgreenx in
FuelLabs/fuel-core#1057
* Prepare GraphQL Crate for extraction by @ControlCplusControlV in
FuelLabs/fuel-core#1012
* Support large contract deployments over p2p by @Voxelot in
FuelLabs/fuel-core#1062
* fix yaml and add linting job by @Voxelot in
FuelLabs/fuel-core#1063
* Actualized the ABI for message to be compatible with last version of
the Solidity contracts. by @xgreenx in
FuelLabs/fuel-core#1060
* feat: Contract state and assets merkle data storage by @bvrooman in
FuelLabs/fuel-core#1008
* Take into account the previous block timestamp during block production
by @xgreenx in FuelLabs/fuel-core#1059
* Prune owned coin idx when inputs are spent by @Voxelot in
FuelLabs/fuel-core#1055
* Retrayable messages fuel-core part by @xgreenx in
FuelLabs/fuel-core#1067
* chore: Additional Tests for Contract States and Balances by @bvrooman
in FuelLabs/fuel-core#1073
* Rust 1.68.1 & Sparse Registry by @Voxelot in
FuelLabs/fuel-core#1077
* Nginx tuneup by @Voxelot in
FuelLabs/fuel-core#1080
* chore: Update balance and state Merkleization by @bvrooman in
FuelLabs/fuel-core#1084
* Support sticky session in the client by @xgreenx in
FuelLabs/fuel-core#1079
* Added e2e test to run 1000 `dry_run` by @xgreenx in
FuelLabs/fuel-core#1091
* Use docker.io auth credentials to overcome rate limiting by @Voxelot
in FuelLabs/fuel-core#1092
* honeycomb tracing subscription by @Voxelot in
FuelLabs/fuel-core#1083
* Update withdrawal proof API to support proving from a block header
committed to L1 by @xgreenx in
FuelLabs/fuel-core#1071
* Upstream v0.17.8 by @Voxelot in
FuelLabs/fuel-core#1102
* use chainid for transactions and predicates by @Voxelot in
FuelLabs/fuel-core#1107
* fix the dry-run e2e test to actually perform dry runs by @Voxelot in
FuelLabs/fuel-core#1111
* peer reputation with separate app & gossipsub score by @leviathanbeak
in FuelLabs/fuel-core#1028
* Adding sentry data synchronization by @rfuelsh in
FuelLabs/fuel-core#1115
* Capture metrics for graphql api by @Voxelot in
FuelLabs/fuel-core#1113
* Update cargo audit and add to commit by @freesig in
FuelLabs/fuel-core#1152
* add task params by @leviathanbeak in
FuelLabs/fuel-core#1159
* Took into account that block creation could take some time by @xgreenx
in FuelLabs/fuel-core#1162
* Applying optimizations from `0.17.11` release by @xgreenx in
FuelLabs/fuel-core#1158


**Full Changelog**:
FuelLabs/fuel-core@v0.17.3...v0.18.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking A breaking api change fuel-tx Related to the `fuel-tx` crate.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants