Skip to content

Commit

Permalink
Remove selfRemove and Removing a token
Browse files Browse the repository at this point in the history
  • Loading branch information
stoobie committed Jan 15, 2024
1 parent c7d05ce commit f0e610b
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 66 deletions.
1 change: 0 additions & 1 deletion components/Starknet/modules/tools/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
*** Procedures
**** xref:starkgate-automated_actions_with_bridging.adoc[Performing a Smart Deposit]
**** xref:starkgate-adding_a_token.adoc[Adding a token]
**** xref:starkgate-removing_a_token.adoc[Removing a token]
**** xref:starkgate-cancelling a deposit.adoc[Cancelling a deposit]
**** xref:starkgate-estimating_fees.adoc[Estimating StarkGate fees]
*** xref:starkgate_function_reference.adoc[StarkGate function and event reference]
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@ Use the Registry to view the addresses of existing bridges and to stop servicing
An interface is available through https://github.com/starkware-libs/starkgate/blob/dev/src/solidity/IStarkgateRegistry.sol[`IStarkgateRegistry.sol`].
a| * xref:#getBridge[`getBridge`]
* xref:getWithdrawalBridges[`getWithdrawalBridges`]
* xref:#selfRemove[`selfRemove`]


|https://github.com/starkware-libs/starkgate/blob/dev/src/solidity/StarknetTokenBridge.sol[`StarknetTokenBridge.sol`] |The primary StarkGate bridge contract. The functions and events in this reference that provide the main user bridge functionality are defined in this contract. a|
* xref:#deposit[`deposit`]
Expand Down Expand Up @@ -903,8 +901,6 @@ None.
==== Function definition
link:https://github.com/starkware-libs/starkgate/blob/2f96bca50cc6203645b419a890b4a066d617a1cd/src/solidity/StarknetTokenBridge.sol#L89[`identify`] in `StarknetTokenBridge.sol`



'''

[#isServicingToken]
Expand Down Expand Up @@ -950,59 +946,6 @@ link:https://github.com/starkware-libs/starkgate/blob/f060fd5d1ca49a0014dbcb0777

'''

[#selfRemove]
=== `selfRemove`

[discrete]
==== Description

Removes enlisting of a specific token bridge from the registry.

Use this function when writing a custom bridge in order to remove the bridge from the registry if you no longer support the specified token.

The bridge must implement the `isServicingToken` function.

If you don’t implement `isServicingToken`, or if it returns `true`, this function fails and the entire transaction is reverted.


[discrete]
==== Visibility

`external`

[discrete]
==== State Mutability

`view`

[discrete]
==== Parameters

[horizontal,labelwidth="20",role=stripes-odd]
`address _token_`:: The address of the token bridge contract to remove.

[discrete]
==== Returns

None.

[discrete]
==== Emitted event

None.

[discrete]
==== Function definition

link:https://github.com/starkware-libs/starkgate/blob/53151ea8d1e775ee114555b3d36443ed2b62fc02/src/solidity/StarkgateRegistry.sol#L113[`selfRemove`] in `StarkgateRegistry.sol`

[discrete]
==== See also

* xref:#isServicingToken[`isServicingToken`]

'''

[#withdraw]
=== `withdraw`

Expand Down

0 comments on commit f0e610b

Please sign in to comment.