Skip to content

Commit 59d1ef4

Browse files
committed
docs(bridge): fix consistency issues across all bridge docs
TFTTest issuer reverted to official testnet address GA47YZA3... (custom GDPARZIN... issuer was for local testing only, must not ship) Existing doc fixes: - bridging.md: correct deposit/withdraw fee from 1 TFT → 10 TFT - multinode.md: replace non-existent 'Sudo → addBridgeValidator' with correct council.propose path (tfchain has no sudo pallet); fix signer3 using wrong tfchain seed (was signer2 seed — copy-paste bug) - single_node.md + multinode.md: add warning that stellar-utils faucet may fail on testnet (empty DEX order book); point to workaround doc - observability.md: document new events added by #1053/#1054 fix: withdraw_crash_recovery, batch_proposal_started, batch_proposal_completed
1 parent a1022dc commit 59d1ef4

5 files changed

Lines changed: 14 additions & 5 deletions

File tree

bridge/docs/bridging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This document will explain how you can transfer TFT from TF Chain to Stellar and
1111

1212
## Stellar to TF Chain
1313

14-
Transfer the TFT from your Stellar wallet to bridge wallet address that you configured. A depositfee of 1 TFT will be taken, so make sure you send a larger amount as 1 TFT.
14+
Transfer the TFT from your Stellar wallet to bridge wallet address that you configured. A depositfee will be taken (10 TFT on mainnet/testnet by default), so make sure you send a larger amount than the fee.
1515

1616
### Transfer to TF Chain
1717

@@ -29,7 +29,7 @@ To deposit to a TF Grid object, this object **must** exists. If the object is no
2929
## TF Chain to Stellar
3030

3131
Browse to https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftfchain.grid.tf#/extrinsics (for mainnet), select tftBridgeModule and extrinsic: `swap_to_stellar()`. Provide your stellar target address and amount and sign it with your account holding the tft balance.
32-
Again, a withdrawfee of 1 TFT will be taken, so make sure you send a larger amount as 1 TFT.
32+
Again, a withdrawfee will be taken (10 TFT on mainnet/testnet by default), so make sure you send a larger amount than the fee.
3333

3434
The amount withdrawn from TF Chain will be sent to your Stellar wallet.
3535

bridge/docs/multinode.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,11 @@ Following predefined tfchain keys can be used to start a bridge daemon:
4141

4242
By default, only 1 bridge validator is inserted in the tfchain runtime. In this example we will run a 3 node bridge setup, so we need to add 2 keys to the bridge validators on tfchain.
4343

44+
> **Note:** tfchain does **not** have a `sudo` pallet. `addBridgeValidator` is a restricted call gated by `EnsureRootOrCouncilApproval` (council 3/5 threshold). In `--dev` mode, Alice is the sole council member so a council proposal from Alice satisfies the threshold immediately.
45+
4446
- Open: https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944#/extrinsics
4547
- Select "Alice" account
46-
- Select `Sudo` -> `Call` -> `tftBridgeModule` -> `addBridgeValidator` and input: `5CGQ6zra7qXw4RNVwUYM4bxHjxdj9VZH7DKsDwhfBCgVPmUZ`
48+
- Select `council` -> `propose` (with threshold=1) -> `tftBridgeModule` -> `addBridgeValidator` and input: `5CGQ6zra7qXw4RNVwUYM4bxHjxdj9VZH7DKsDwhfBCgVPmUZ`
4749
- Do the same for: `5CVLaAHnvdX1CBsaKFKgfyfb91y5ApNP7FLSaczKginip1ho`
4850

4951
We inserted 2 addresses as authorized bridge validators, these addresses map to the last 2 of the predefined keys listed above
@@ -97,7 +99,7 @@ Now Open a second terminal pane and execute:
9799
Now open a third teminal pane and execute:
98100

99101
```sh
100-
./tfchain_bridge --secret SBFMRNGJQ5NMVXJKDMSBHDDCHVXOJE4E7A62A4MHAD4A5DH5RU5ONWVK --tfchainurl ws://localhost:9944 --tfchainseed "employ split promote annual couple elder remain cricket company fitness senior fiscal" --bridgewallet GAYJSBPBQ3J32CZZ72OM3GZP646KSVD3V5QB3WBJSSGPYHYS5MZSS4Z6 --persistency ./signer3.json --network testnet
102+
./tfchain_bridge --secret SBFMRNGJQ5NMVXJKDMSBHDDCHVXOJE4E7A62A4MHAD4A5DH5RU5ONWVK --tfchainurl ws://localhost:9944 --tfchainseed "remind bird banner word spread volume card keep want faith insect mind" --bridgewallet GAYJSBPBQ3J32CZZ72OM3GZP646KSVD3V5QB3WBJSSGPYHYS5MZSS4Z6 --persistency ./signer3.json --network testnet
101103
```
102104

103105
If all goes well, you should see something similar to following output:
@@ -144,6 +146,8 @@ Now, request some Testnet TFT by doing a swap on the stellar dex using the same
144146

145147
Given this command did not give an error, your account you just generated now has 100 TFT.
146148

149+
> **Note:** The `stellar-utils faucet` command may fail on Stellar testnet if there are no active TFT orders on the DEX order book. See [setup_issues_and_workarounds.md](./setup_issues_and_workarounds.md#11-stellar-testnet-tft-faucet-has-no-liquidity) for the workaround.
150+
147151
## Step 4: Deposit TFT to the bridge
148152

149153
Make sure that

bridge/docs/observability.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,9 @@ For example, if a customer is complaining that their deposit never bridged, you
7070
- `withdraw_proposed`: a withdraw has proposed or signed by the bridge instance.
7171
- `withdraw_postponed`: a withdraw has postponed due to a problem in sending this transaction to the stellar network and will be retried later.
7272
- `withdraw_completed`: a withdraw has completed and received on the target stellar account.
73+
- `withdraw_crash_recovery`: The bridge detected a withdraw in `PROCESSING` state from a previous run (possible crash between Stellar submission and TFChain confirmation). The bridge queries Horizon to determine if the Stellar tx was already submitted before deciding whether to retry.
74+
- `batch_proposal_started`: The bridge is processing multiple `BurnTransactionCreated` events from the same block and will submit them as a single `Utility.batch` extrinsic.
75+
- `batch_proposal_completed`: The bridge successfully submitted a batch of withdraw proposals in a single extrinsic.
7376

7477
##### Bridge vault account related
7578
- `payment_received` : This event represents successful payment to the bridge account (a deposit).

bridge/docs/single_node.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ Now, request some Testnet TFT by doing a swap on the stellar dex using the same
8282

8383
Given this command did not give an error, your account you just generated now has 100 TFT.
8484

85+
> **Note:** The `stellar-utils faucet` command performs a DEX path payment (XLM → TFT). On Stellar testnet this may fail with a path payment error if there are no active TFT orders on the testnet DEX order book. If you encounter this, ask a team member who operates the testnet TFT issuer to send you testnet TFT directly, or refer to [setup_issues_and_workarounds.md](./setup_issues_and_workarounds.md#11-stellar-testnet-tft-faucet-has-no-liquidity) for the custom issuer workaround.
86+
8587
## Step 4: Deposit TFT to the bridge
8688

8789
Make sure that

bridge/tfchain_bridge/pkg/stellar/stellar.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import (
2929

3030
const (
3131
TFTMainnet = "TFT:GBOVQKJYHXRR3DX6NOX2RRYFRCUMSADGDESTDNBDS6CDVLGVESRTAC47"
32-
TFTTest = "TFT:GDPARZINMN52LJMVZSQPOEDHC2TWKJVFZSNHKDP4OUH6RI4PMXH4JA6Q"
32+
TFTTest = "TFT:GA47YZA3PKFUZMPLQ3B5F2E3CJIB57TGGU7SPCQT2WAEYKN766PWIMB3"
3333

3434
stellarPrecision = 1e7
3535
stellarPrecisionDigits = 7

0 commit comments

Comments
 (0)