docs: StarkGate 2.0 function/event reference, architecture topic, procedures #922
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
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
1 similar comment
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
stoobie
force-pushed
the
starkgatev2.0
branch
from
c5f32c7 to
18d4e5b
Compare
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
stoobie
commented
Dec 4, 2023
stoobie
commented
Dec 4, 2023
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
1 similar comment
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
stoobie
commented
Dec 4, 2023
components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc
Outdated
Show resolved
Hide resolved
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
stoobie
commented
Dec 4, 2023
components/Starknet/modules/tools/pages/starkgate-automated_actions_with_bridging.adoc
Outdated
Show resolved
Hide resolved
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
3 similar comments
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
…ral content. (#886) * Adding a new topic with functions for StarkGate. * Added blockToken * Added deactivateToken * Added more functions. * Added getWithdrawalBridges. * Renamed token-bridge.adoc to starkgate-bridge.adoc. Added entries to .htaccess. * Add L2 functions. * Added params to addExistingBridge. * SME comment * Minor fixes. * Added more functions. * More edits. * Add getStatus * Add Cancelling a deposit. * Added deposit and depositReclaim * Add table-striping to description lists for parameters and returns. * Adding types to parameters. * Adding event to `Deposit` * Add depositWithMessage * Updates to overview. * Adding `depositWithMessage*` functions. * SME comments * depositWithMessage* functions. * Moved desc of Manager and Registry to top of section. * SME comments * SME comments * SME comments * Added new topic: StarkGate architecture. * Changed name of file from stargate_dev_reference.adoc to starkgate_function_reference.adoc; Removed info on adding a custom bridge from starkgate-adding_a_token.adoc. * Updated starkgate_architecture.adoc. * SME comments, cleaning up scattered links. * Edit xref text for deposit function and event * Edited name of reference doc * Fixed broken xref. * Added list of functions in each contract. * Updated architecture topic. * Removed the section on the Manager and the Registry. I don't think that this is helpful. * Added AsciiDoc role to function heading in prep for adding style to make heading clearer. * Updates to Architecture topic based on SME engineering and product feedback. * Updates to function reference based on SME comments. * Fixed typo. * Added Visibility header. * Consistency edits. * Consistency edits. --------- Co-authored-by: JameStark <113911244+JameStark@users.noreply.github.com>
…patibility (#933) * Add `on_receive` function interface. * Add snippet_backwards_compatibiity_note.adoc with a note about backwards compatibility. Put note in: starkgate_architecture.adoc starkgate_function_reference.adoc starkgate-bridge.adoc * Started to add tagged regions for event descriptions to use same text as parameter descriptions. * SME comments. * Adding tagged regions for event params. * Adding tagged regions for event params. * Added concept topic explaining the depositWithMessage flow. * SME comment * SME Comments for `on_receive` * Updated concept topic for `depositWithMessage`
…tions_with_bridging.adoc
…tions_with_bridging.adoc
…ral content. (#886) * Adding a new topic with functions for StarkGate. * Added blockToken * Added deactivateToken * Added more functions. * Added getWithdrawalBridges. * Renamed token-bridge.adoc to starkgate-bridge.adoc. Added entries to .htaccess. * Add L2 functions. * Added params to addExistingBridge. * SME comment * Minor fixes. * Added more functions. * More edits. * Add getStatus * Add Cancelling a deposit. * Added deposit and depositReclaim * Add table-striping to description lists for parameters and returns. * Adding types to parameters. * Adding event to `Deposit` * Add depositWithMessage * Updates to overview. * Adding `depositWithMessage*` functions. * SME comments * depositWithMessage* functions. * Moved desc of Manager and Registry to top of section. * SME comments * SME comments * SME comments * Added new topic: StarkGate architecture. * Changed name of file from stargate_dev_reference.adoc to starkgate_function_reference.adoc; Removed info on adding a custom bridge from starkgate-adding_a_token.adoc. * Updated starkgate_architecture.adoc. * SME comments, cleaning up scattered links. * Edit xref text for deposit function and event * Edited name of reference doc * Fixed broken xref. * Added list of functions in each contract. * Updated architecture topic. * Removed the section on the Manager and the Registry. I don't think that this is helpful. * Added AsciiDoc role to function heading in prep for adding style to make heading clearer. * Updates to Architecture topic based on SME engineering and product feedback. * Updates to function reference based on SME comments. * Fixed typo. * Added Visibility header. * Consistency edits. * Consistency edits. --------- Co-authored-by: JameStark <113911244+JameStark@users.noreply.github.com>
…patibility (#933) * Add `on_receive` function interface. * Add snippet_backwards_compatibiity_note.adoc with a note about backwards compatibility. Put note in: starkgate_architecture.adoc starkgate_function_reference.adoc starkgate-bridge.adoc * Started to add tagged regions for event descriptions to use same text as parameter descriptions. * SME comments. * Adding tagged regions for event params. * Adding tagged regions for event params. * Added concept topic explaining the depositWithMessage flow. * SME comment * SME Comments for `on_receive` * Updated concept topic for `depositWithMessage`
…tions_with_bridging.adoc
…tions_with_bridging.adoc
* Add table with list of bridged tokens * Removed TVL limitations from StarkGate overview.
stoobie
force-pushed
the
starkgatev2.0
branch
from
49ad6e3 to
09f5780
Compare
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
… function reference. (#1031)
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-922/documentation/ . |
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.
Description of the Changes
This PR contains new developer content for StarkGate 2.0. This PR should only be merged to dev on or around the release of StarkGate 2.0.
PR Preview URL
StarkGate bridge developer’s guide
Overview
StarkGate architecture
Automated actions with bridging
Procedures
StarkGate function reference
Check List
<docs/feat/fix/chore>(optional scope): <description>, e.g:fix: minor typos in codeThis change is