[doc] devex roadmap #4533
Merged
[doc] devex roadmap #4533
Conversation
This file contains 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
sblackshear
force-pushed
the
devex_roadmap
branch
from
2b80d11
to
3c4d1b8
Compare
DEVX_ROADMAP.md
Outdated
| @@ -0,0 +1,46 @@ | |||
| # Developer Experience Roadmap | |||
|
|
|||
| This is a list of the upcoming DevX changes in the next 30 days | |||
There was a problem hiding this comment.
Could we include a start date for the 30 days? If I see this on the 28th day most of the items would be in the past already
DEVX_ROADMAP.md
Outdated
|
|
||
| ## JSON RPC | ||
| *[Gateway deprecation] Sui_syncAccountState will be deprecated and removed. | ||
| * [Gateway deprecation] Gateway’s sui_executeTransaction will be replaced by fullnode’s sui_executeTransaction which has an extra parameter that allows users to choose if a method should block or return immediately. |
There was a problem hiding this comment.
Suggested change
| * [Gateway deprecation] Gateway’s sui_executeTransaction will be replaced by fullnode’s sui_executeTransaction which has an extra parameter that allows users to choose if a method should block or return immediately. | |
| * [Gateway deprecation] Gateway’s `sui_executeTransaction` method will be replaced by fullnode’s `sui_executeTransaction` method, which has an extra parameter that allows users to choose whether a method should block or return immediately. |
DEVX_ROADMAP.md
Outdated
| * get_events_by_recipient | ||
| * get_events_by_object | ||
| * get_events_by_timerange | ||
| * sui_eventSubscription API that enables subscribing to all transaction events, including ones that don’t generate network activity (github) |
There was a problem hiding this comment.
why is (github) included in this line? Should be GitHub
There was a problem hiding this comment.
this was a hyperlink in the source doc to this pull request #4288
DEVX_ROADMAP.md
Outdated
| * get_events_by_object | ||
| * get_events_by_timerange | ||
| * sui_eventSubscription API that enables subscribing to all transaction events, including ones that don’t generate network activity (github) | ||
| * A sui_call API that emulates transaction execution, but does not commit the same to the network, akin to eth_call in Ethereum. |
There was a problem hiding this comment.
Suggested change
| * A sui_call API that emulates transaction execution, but does not commit the same to the network, akin to eth_call in Ethereum. | |
| * A sui_call API that emulates transaction execution, but does not commit the transaction to the network, akin to eth_call in Ethereum. |
DEVX_ROADMAP.md
Outdated
|
|
||
| ## SDK (Typescript, Rust) | ||
| * Reliability improvements in Typescript SDK support for sui_publish API | ||
| * Support for sui_subscribeEvent in Typescript SDK |
There was a problem hiding this comment.
Suggested change
| * Support for sui_subscribeEvent in Typescript SDK | |
| * Support for `sui_subscribeEvent` in the Typescript SDK |
Or it could be "Support for the sui_subscribeEvent method in the Typescript SDK."
DEVX_ROADMAP.md
Outdated
| * Rust SDK will be kept at parity with the Typescript SDK when feasible | ||
|
|
||
| # Sui Move | ||
| * Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation. |
There was a problem hiding this comment.
Suggested change
| * Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation. | |
| * Support for dynamic access of child objects to nullify the need to pass child objects explicitly in a transaction and to enable implementation of design patterns/collections that require pointer-like parent->child representation. |
| ## JSON RPC | ||
| *[Gateway deprecation] Sui_syncAccountState will be deprecated and removed. | ||
| * [Gateway deprecation] Gateway’s sui_executeTransaction will be replaced by fullnode’s sui_executeTransaction which has an extra parameter that allows users to choose if a method should block or return immediately. | ||
| * Pagination support for the following APIs. |
There was a problem hiding this comment.
are these all APIs or methods of the Sui API?
There was a problem hiding this comment.
these are a subset that may potential return a very lengthy list and hence requires pagination.
DEVX_ROADMAP.md
Outdated
|
|
||
| # Sui Move | ||
| * Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation. | ||
| * Support for passing strings and object ID's encodings to entry functions |
There was a problem hiding this comment.
Suggested change
| * Support for passing strings and object ID's encodings to entry functions | |
| * Support for passing strings and object ID encodings to entry functions |
or encoded object IDs?
DEVX_ROADMAP.md
Outdated
| # Sui Move | ||
| * Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation. | ||
| * Support for passing strings and object ID's encodings to entry functions | ||
| * [done] Support for passing a vector of objects to entry functions which will open up a variety of flexible use cases wrt payments and coin management. |
There was a problem hiding this comment.
[done] means completed? Complete is a better word here, Done refers to food...I cooked it until the food was was done. I worked until the project was finished/completed.
There was a problem hiding this comment.
if PRs are merged but not yet tagged for release we should not mark them as done.
janetwu11
reviewed
Sep 8, 2022
DEVX_ROADMAP.md
Outdated
| # Sui Move | ||
| * Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation. ([issue](https://github.com/MystenLabs/sui/issues/4203)) | ||
| * Support for passing strings and object ID's encodings to entry functions | ||
| * [done] This frequently requested feature allows passing a vector of objects to entry functions which will open up a variety of flexible use cases wrt payments and coin management. |
There was a problem hiding this comment.
@sblackshear did you add the [done]? if they are only merged and not yet tagged for release they strictly speaking it is not usable. It may be good to leave out the [done] notation and direct people to the release notes instead.
janetwu11
reviewed
Sep 9, 2022
DEVX_ROADMAP.md
Outdated
| # Sui Move | ||
| * Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation. ([issue](https://github.com/MystenLabs/sui/issues/4203)) | ||
| * Support for passing strings and object ID's encodings to entry functions | ||
| * [done] This frequently requested feature allows passing a vector of objects to entry functions which will open up a variety of flexible use cases wrt payments and coin management. |
sblackshear
force-pushed
the
devex_roadmap
branch
2 times, most recently
from
8e91493
to
6a6bea5
Compare
janetwu11
reviewed
Sep 9, 2022
DEVX_ROADMAP.md
Outdated
| * `get_events_by_object` | ||
| * `get_events_by_timerange` | ||
| * A `sui_call` API that emulates transaction execution, but does not commit the transaction to the network, akin to eth_call in Ethereum. This is useful for gas cost prediction and transaction effect simulation. | ||
| * [done] `sui_eventSubscription` API that enables subscribing to all transaction events, including ones that don’t generate network activity ([issue](https://github.com/MystenLabs/sui/pull/4288)) |
janetwu11
reviewed
Sep 9, 2022
DEVX_ROADMAP.md
Outdated
| # Sui Move | ||
| * Support for dynamic access of child objects to avoid explicitly passing child objects as transaction inputs and to enable implementation of design patterns/collections that require pointer-like parent->child representation. ([issue](https://github.com/MystenLabs/sui/issues/4203)) | ||
| * Support for passing strings and object ID encodings to entry functions | ||
| * [done] This frequently requested feature allows passing a vector of objects to entry functions which will open up a variety of flexible use cases *wrt* payments and coin management. |
janetwu11
reviewed
Sep 9, 2022
DEVX_ROADMAP.md
Outdated
| * Support for dynamic access of child objects to avoid explicitly passing child objects as transaction inputs and to enable implementation of design patterns/collections that require pointer-like parent->child representation. ([issue](https://github.com/MystenLabs/sui/issues/4203)) | ||
| * Support for passing strings and object ID encodings to entry functions | ||
| * [done] This frequently requested feature allows passing a vector of objects to entry functions which will open up a variety of flexible use cases *wrt* payments and coin management. | ||
| * [done] A collection of cryptographic libraries are exposed as Move native functions to use on-chain. They can be found at: |
sblackshear
force-pushed
the
devex_roadmap
branch
from
6a6bea5
to
91b473b
Compare
janetwu11
approved these changes
Sep 9, 2022
srinath-mysten
approved these changes
Sep 9, 2022
| @@ -0,0 +1,50 @@ | |||
| # Developer Experience Roadmap | |||
There was a problem hiding this comment.
@sblackshear @janetwu11 Does it make sense to explicitly point out breaking changes ?
There was a problem hiding this comment.
Spoke with Janet and resolving this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Document upcoming changes to Sui dev experience in one place