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

docs: Update transactions.adoc with txs v3 fee estimation #1296

Merged
merged 4 commits into from
Jul 2, 2024

Conversation

odednaor
Copy link
Collaborator

@odednaor odednaor commented Jun 16, 2024

Description of the Changes

Link to the recommended way to translate the response of starknet_estimateFee call to the different fields of resource_bounds when sending txs v3.

PR Preview URL

Transaction v3 Fee Estimation

Check List

  • Changes have been done against main branch, and PR does not conflict
  • PR title follows the convention: <docs/feat/fix/chore>(optional scope): <description>, e.g: fix: minor typos in code

This change is Reviewable

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

@stoobie stoobie changed the title Update transactions.adoc with txs v3 fee estimation docs: Update transactions.adoc with txs v3 fee estimation Jun 16, 2024
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

stoobie
stoobie previously approved these changes Jun 16, 2024
Copy link
Collaborator

@stoobie stoobie left a comment

Choose a reason for hiding this comment

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

LGTM.

@odednaor
Copy link
Collaborator Author

lgtm as well, @ArielElp, please review.

@stoobie stoobie requested review from leo-starkware and removed request for ArielElp June 17, 2024 07:22
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

1 similar comment
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

Copy link
Collaborator

@ArielElp ArielElp left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @leo-starkware and @odednaor)


components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc line 468 at r2 (raw file):

== v3 transaction fee estimation

Estimate the fees of transactions with the `starknet_estimateFee` API call, which is part of the of the Starknet JSON RPC v0.7 and above. For more information see the link:https://github.com/starkware-libs/starknet-specs/blob/v0.7.1/api/starknet_api_openrpc.json#L612[Starknet API JSON RPC specification]. For information on the recommended way to translate the response fields of the call to the fields in `resource_bounds`, see link:https://community.starknet.io/t/starknet-v0-13-1-pre-release-notes/113664#sdkswallets-how-to-use-the-new-fee-estimates-7[How to use the new fee estimates?] on the Starknet community forum.

Starknet's json RPC v0.7.0 and above.

Code quote:

the Starknet JSON RPC v0.7

components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc line 468 at r2 (raw file):

== v3 transaction fee estimation

Estimate the fees of transactions with the `starknet_estimateFee` API call, which is part of the of the Starknet JSON RPC v0.7 and above. For more information see the link:https://github.com/starkware-libs/starknet-specs/blob/v0.7.1/api/starknet_api_openrpc.json#L612[Starknet API JSON RPC specification]. For information on the recommended way to translate the response fields of the call to the fields in `resource_bounds`, see link:https://community.starknet.io/t/starknet-v0-13-1-pre-release-notes/113664#sdkswallets-how-to-use-the-new-fee-estimates-7[How to use the new fee estimates?] on the Starknet community forum.

For more information on how to construct the appropriate resource_bounds based on the response of starknet_estimateFee, see ...

Code quote:

or information on the recommended way to translate the response fields of the call to the fields in `resource_bounds`

components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc line 468 at r2 (raw file):

== v3 transaction fee estimation

Estimate the fees of transactions with the `starknet_estimateFee` API call, which is part of the of the Starknet JSON RPC v0.7 and above. For more information see the link:https://github.com/starkware-libs/starknet-specs/blob/v0.7.1/api/starknet_api_openrpc.json#L612[Starknet API JSON RPC specification]. For information on the recommended way to translate the response fields of the call to the fields in `resource_bounds`, see link:https://community.starknet.io/t/starknet-v0-13-1-pre-release-notes/113664#sdkswallets-how-to-use-the-new-fee-estimates-7[How to use the new fee estimates?] on the Starknet community forum.

Starknet JSON RPC specification

Code quote:

API JSON RPC specification

@odednaor odednaor requested a review from ArielElp June 26, 2024 14:00
Copy link
Collaborator Author

@odednaor odednaor left a comment

Choose a reason for hiding this comment

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

Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @ArielElp and @leo-starkware)


components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc line 468 at r2 (raw file):

Previously, ArielElp wrote…

Starknet's json RPC v0.7.0 and above.

Done.


components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc line 468 at r2 (raw file):

Previously, ArielElp wrote…

For more information on how to construct the appropriate resource_bounds based on the response of starknet_estimateFee, see ...

Done.


components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc line 468 at r2 (raw file):

Previously, ArielElp wrote…

Starknet JSON RPC specification

Done.

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

stoobie
stoobie previously approved these changes Jun 26, 2024
Copy link
Collaborator

@stoobie stoobie left a comment

Choose a reason for hiding this comment

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

@odednaor One comment.

@odednaor
Copy link
Collaborator Author

@stoobie, resolved the comment. Please merge.

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

1 similar comment
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

Copy link
Collaborator

@ArielElp ArielElp left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r4, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @leo-starkware, @odednaor, and @stoobie)


components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc line 468 at r2 (raw file):

Previously, odednaor wrote…

Done.

I see Starknet API 0.7.0, which is not a term we're using. Starknet JSON-RPC v0.7.0 is more consistent with other references


components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc line 468 at r3 (raw file):

Previously, stoobie (Steve Goodman) wrote…

JSON RPC is an API format. Referring to Starknet's API as "Starknet's JSON RPC" is grammatically incorrect.

Starknet JSON-RPC or Ethereum JSON-RPC are known references. It's true that technically JSON-RPC is an API format, but Starknet JSON-RPC (or Starknet's JSON-RPC) has a clearer meaning to readers.

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

1 similar comment
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1296/ .

Copy link
Collaborator

@stoobie stoobie left a comment

Choose a reason for hiding this comment

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

LGTM

@stoobie stoobie merged commit 2d5739b into main Jul 2, 2024
1 of 2 checks passed
@stoobie stoobie deleted the odednaor-patch-4 branch July 2, 2024 15:43
stoobie added a commit that referenced this pull request Jul 8, 2024
* Update transactions.adoc with txs v3 fee estimation

* Update transactions.adoc

* Update transactions.adoc

* Update transactions.adoc

---------

Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>
raizo07 pushed a commit to raizo07/starknet-docs that referenced this pull request Jul 9, 2024
…o#1296)

* Update transactions.adoc with txs v3 fee estimation

* Update transactions.adoc

* Update transactions.adoc

* Update transactions.adoc

---------

Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>
LandauRaz added a commit that referenced this pull request Aug 8, 2024
* doc: compiled class hash

* further improvement to the doc

* fix: Dir structure changes for SEO (#1261)

* Changed /documentation/ to /root/ in antora.yml.

* Changed root to ROOT.

* Change file names for SEO:
* underscores to hyphens
* uppercase to lowercase

* Change file names for SEO to be match content matter

* Added broken links from 3rd party sites

* Update messaging-mechanism.adoc to latest on main.

* Updated xrefs in messaging-mechanism.adoc.

* Updated URL for preview to drop `/documentation/`

* fix: Change "cross-chain" to "cross-layer" in L1-L2 Messaging mechanism (#1289)

* Change "cross-chain" to "cross-layer" in L1-L2 Messaging mechanism

* Apply suggestions from code review

* Removed `seo-optimization` branch from playbook. (#1299)

* docs: add messaging_reference.adoc (#1094)

* create messaging_reference.adoc
* add messaging_reference.adoc to nav
* add the functions implemented in StarknetMessaging.sol but not part of the IStarknetMessaging.sol
* Explain `deployer_address`
* Added links between consumeMessageFromL2 function and ConsumedMessageToL2 event.
* Added links between consumeMessageFromL2 function and ConsumedMessageToL2 event.
* modify event descriptions and add event heading for functions
* fix directory structure
* Comment out events from internal `processMessages` function

* docs: Update Starknet book ToC (#1297)

* Update Starknet book ToC: Update outdated information about Starknet book

---------

Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

* fix typo adding class hashes in tx v3 invoke computation (#1292)

* Update playbook.yml to use main branch for ui-bundle.zip (#1306)

* Fix hash calculation documentation: change 1 to 0 in v1 (deprecated) hash calculation (#1304)

* docs: Update transactions.adoc with txs v3 fee estimation (#1296)

* Update transactions.adoc with txs v3 fee estimation

* Update transactions.adoc

* Update transactions.adoc

* Update transactions.adoc

---------

Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

* Update transaction-life-cycle.adoc with finality status of deploy_account and declare transactions (#1295)

* Update transaction-life-cycle.adoc with finality status of deploy_account and declare transactions

---------

Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

* docs: add validate warnings and refactor the account's functions page (#1302)

* add validate warnings and refactor account functions page

* fix typo

* minor fixes

* Update serialization-of-cairo-types.adoc (#1307)

* docs: Migrate Provers topic from the Starknet Book (#1270)

* Migrating Provers topic from the Starknet Book at https://book.starknet.io/ch03-03-provers.html.

* Import sharp.adoc from the Book in order to bring in a commit with multiple contributors.

* Edits, and removed sharp.adoc
---------

Co-authored-by: Omar U. Espejel <espejelomar@gmail.com>

* Update README.adoc

* docs: add L1HandlerTransaction table and info on caller address (#1275)

* feat: add l1 handler transaction type version

* fix: fix typo

* fix: fix typo

* fix: add a new ref to l1 handler transaction

* fix: reword L1HandlerTransaction to L1 handler transaction in normal text

* fix: reword for consistent format and better readability

* Update components/Starknet/modules/architecture-and-concepts/pages/network-architecture/messaging-mechanism.adoc

* Update components/Starknet/modules/architecture-and-concepts/pages/network-architecture/messaging-mechanism.adoc

* fix: remove old file

* Update components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc

Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

* fix: reword as suggested

---------

Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

* Added a link to info on the L1 handler tx type from the tx versions table. (#1312)

* Update components/Starknet/modules/architecture-and-concepts/nav.adoc

* change file name to use hyphens

* implement reviewed changes

* Update nav.adoc

---------

Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>
Co-authored-by: xiaolou86 <20718693+xiaolou86@users.noreply.github.com>
Co-authored-by: Lauri Peltonen <20242241+microbecode@users.noreply.github.com>
Co-authored-by: antiyro <74653697+antiyro@users.noreply.github.com>
Co-authored-by: Nnaji Benjamin <60315147+Benjtalkshow@users.noreply.github.com>
Co-authored-by: odednaor <odednaor@gmail.com>
Co-authored-by: ArielElp <86294909+ArielElp@users.noreply.github.com>
Co-authored-by: jumpman <57270771+kkawula@users.noreply.github.com>
Co-authored-by: Omar U. Espejel <espejelomar@gmail.com>
Co-authored-by: Raz Landau <125185051+LandauRaz@users.noreply.github.com>
Co-authored-by: glihm <dev@glihm.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants