Skip to content

Commit d700df9

Browse files
nikerzetic-aflabsnikerzetic-aflabs
committed
feat(docs): add console outputs
1 parent af7c7d0 commit d700df9

File tree

2 files changed

+136
-48
lines changed

2 files changed

+136
-48
lines changed

‎docs/smart-accounts/guides/02-custom-instructions.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,25 @@ This time, it works.
119119
./smart_accounts.py bridge custom -a "0x296432C15504Ed465fAce11E54Ce4aac50cCd8A3" -v 1 -d "0423a132000000000000000000000000000000000000000000000000000000000000002a"
120120
```
121121

122+
<details>
123+
<summary>Expected output</summary>
124+
125+
The CLI prompts the user to press "enter" once in order to continue to the minting.
126+
The number of `.` symbols, as well as XRPL transaction hashes are expected not to match the ones in this example.
127+
128+
```
129+
sent instruction on underlying: 934945B8142E5CA10B2027B17364D587C483C61F562E2B28EF251EF3F9D0A6E5
130+
https://testnet.xrpl.org/transactions/934945B8142E5CA10B2027B17364D587C483C61F562E2B28EF251EF3F9D0A6E5/detailed
131+
132+
waiting to bridge...........
133+
BRIDGED FOR 0xF4CC61CCCDA8b792EAA112455D9DBc4bcb9AA9A0
134+
successfully bridged in tx 0x0b889937eeb43b660ffe44b23c149a540af41c8a04ae656481a15a9ffe310953
135+
https://coston2-explorer.flare.network/tx/0x0b889937eeb43b660ffe44b23c149a540af41c8a04ae656481a15a9ffe310953?tab=logs
136+
137+
```
138+
139+
</details>
140+
122141
### Mocking
123142

124143
We can speed up the process, as well as simplify it, by using the Flare Smart Accounts CLI.

‎docs/smart-accounts/guides/03-fassets-cycle.mdx‎

Lines changed: 117 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -43,32 +43,33 @@ We will mint `1` lot of FXRP, with the agent at the address `0x55c815260cBE6c45F
4343
The CLI command that does this is:
4444

4545
```sh
46-
./smart_accounts.py bridge mint -a 0x55c815260cBE6c45Fe5bFe5FF32E3C7D746f14dC -l 1
46+
./smart_accounts.py bridge mint --agent-address 0x55c815260cBE6c45Fe5bFe5FF32E3C7D746f14dC --lots 1
4747
```
4848

49-
5049
<details>
5150
<summary>Expected output</summary>
5251

5352
The CLI prompts the user to press "enter" once in order to continue to the minting.
5453
The number of `.` symbols, as well as XRPL transaction hashes are expected not to match the ones in this example.
5554

5655
```
57-
sent instruction on underlying: 07A9E514BEFE3DFC2829D8099F096B9688DED105FCA8682DE1CC061B00590C0E
58-
https://testnet.xrpl.org/transactions/07A9E514BEFE3DFC2829D8099F096B9688DED105FCA8682DE1CC061B00590C0E/detailed
56+
sent instruction on underlying: D1F3F68060C34771DD603C4597D20FF4EFFA53FCB1A9D3F2A06272CC1BB2BCB0
57+
https://testnet.xrpl.org/transactions/D1F3F68060C34771DD603C4597D20FF4EFFA53FCB1A9D3F2A06272CC1BB2BCB0/detailed
5958
60-
waiting to bridge...............
59+
waiting to bridge...........
6160
BRIDGED FOR 0xDC47B18B7aDC3DeaCA42651cAF5A91397b57BAD3
62-
successfully bridged in tx 0x0039bc923ac5466d2eab6c54cb8f1ef3c93b1d161e005619ea08e778f0e11fc3
63-
https://coston2-explorer.flare.network/tx/0x0039bc923ac5466d2eab6c54cb8f1ef3c93b1d161e005619ea08e778f0e11fc3?tab=logs
64-
65-
successful collateral resevation, continue to 2nd part of mint... press enter
66-
sent underlying assets in 97536A0908B908595513B081657174EE86F017753B2FD2C90F5633441C69DDF9
67-
https://testnet.xrpl.org/transactions/97536A0908B908595513B081657174EE86F017753B2FD2C90F5633441C69DDF9/detailed
68-
waiting for mint execution...............
69-
successfully minted in tx 0x0a071795544c71dfe084110510898eae39d28412d0804a6c1ec911aba7427445
70-
https://coston2-explorer.flare.network/tx/0x0a071795544c71dfe084110510898eae39d28412d0804a6c1ec911aba7427445?tab=logs
61+
successfully bridged in tx 0xb64a6e46613aac437fc2ee3ed418f8f872e20d9aba7c95cc003f9f54dfec3553
62+
https://coston2-explorer.flare.network/tx/0xb64a6e46613aac437fc2ee3ed418f8f872e20d9aba7c95cc003f9f54dfec3553?tab=logs
63+
64+
successful collateral reservation, continue to 2nd part of mint... press enter
65+
sent underlying assets in 0708E84E5E69731328DD357BDD934205A002876B8801813B7002EE315BB2AE8D
66+
https://testnet.xrpl.org/transactions/0708E84E5E69731328DD357BDD934205A002876B8801813B7002EE315BB2AE8D/detailed
67+
waiting for mint execution.............
68+
successfully minted in tx 0x5e78e235dbfc7f0c1356635277b70bbaefe7ce01a948309fea9bb56d8e26d3d0
69+
https://coston2-explorer.flare.network/tx/0x5e78e235dbfc7f0c1356635277b70bbaefe7ce01a948309fea9bb56d8e26d3d0?tab=logs
70+
7171
```
72+
7273
</details>
7374

7475
The CLI sends both the `reserveCollateral` instruction and the `Payment` transaction to the agent's underlying address.
@@ -80,8 +81,28 @@ Here, the CLI sends the `deposit` instruction.
8081
The command is:
8182

8283
```sh
83-
./smart_accounts.py bridge deposit -a 1
84+
./smart_accounts.py bridge deposit --amount 1
85+
```
86+
87+
<details>
88+
<summary>Expected output</summary>
89+
90+
The CLI prompts the user to press "enter" once in order to continue to the minting.
91+
The number of `.` symbols, as well as XRPL transaction hashes are expected not to match the ones in this example.
92+
8493
```
94+
sent instruction on underlying: 185EE71ECEC28C5902D45ED8AB5FCB9A6F78845EE99EC4A66F81655F78EADC87
95+
https://testnet.xrpl.org/transactions/185EE71ECEC28C5902D45ED8AB5FCB9A6F78845EE99EC4A66F81655F78EADC87/detailed
96+
97+
waiting to bridge...............
98+
BRIDGED FOR 0xF4CC61CCCDA8b792EAA112455D9DBc4bcb9AA9A0
99+
successfully bridged in tx 0x12a69822e5d399a8918ff116a049b714ef76c29e1497857148e9fbc602d7994d
100+
https://coston2-explorer.flare.network/tx/0x12a69822e5d399a8918ff116a049b714ef76c29e1497857148e9fbc602d7994d?tab=logs
101+
102+
103+
```
104+
105+
</details>
85106

86107
## Withdraw
87108

@@ -93,8 +114,28 @@ The first instruction starts the withdrawal process, and the second claims the F
93114
We use the command:
94115

95116
```sh
96-
./smart_accounts.py bridge withdraw -a 1
117+
./smart_accounts.py bridge withdraw --amount 1
118+
```
119+
120+
<details>
121+
<summary>Expected output</summary>
122+
123+
The CLI prompts the user to press "enter" once in order to continue to the minting.
124+
The number of `.` symbols, as well as XRPL transaction hashes are expected not to match the ones in this example.
125+
97126
```
127+
sent instruction on underlying: 2B1F76520C3EE921E22FE79F3DA29B1F2C64E602CD2A1C87F372E0AB8E75B270
128+
https://testnet.xrpl.org/transactions/2B1F76520C3EE921E22FE79F3DA29B1F2C64E602CD2A1C87F372E0AB8E75B270/detailed
129+
130+
waiting to bridge...........
131+
BRIDGED FOR 0xF4CC61CCCDA8b792EAA112455D9DBc4bcb9AA9A0
132+
successfully bridged in tx 0x43c13369b678c0e671d70035f8140b2cd6f4309735bce03d9e9fd0cc994792d7
133+
https://coston2-explorer.flare.network/tx/0x43c13369b678c0e671d70035f8140b2cd6f4309735bce03d9e9fd0cc994792d7?tab=logs
134+
135+
136+
```
137+
138+
</details>
98139

99140
## Redeem
100141

@@ -103,15 +144,34 @@ We will redeem the `1` lot of FXRP we minted in the first step back to XRP.
103144
We will invoke the CLI with the following command.
104145

105146
```sh
106-
./smart_accounts.py bridge redeem -a 1
147+
./smart_accounts.py bridge redeem --lots 1
148+
```
149+
150+
<details>
151+
<summary>Expected output</summary>
152+
153+
The CLI prompts the user to press "enter" once in order to continue to the minting.
154+
The number of `.` symbols, as well as XRPL transaction hashes are expected not to match the ones in this example.
155+
156+
```
157+
sent instruction on underlying: 1D6A35CB521D16E7379D0F1D4D1C4A8BB49497C4FDC27446C5D775605B802881
158+
https://testnet.xrpl.org/transactions/1D6A35CB521D16E7379D0F1D4D1C4A8BB49497C4FDC27446C5D775605B802881/detailed
159+
160+
waiting to bridge............
161+
BRIDGED FOR 0xF4CC61CCCDA8b792EAA112455D9DBc4bcb9AA9A0
162+
successfully bridged in tx 0x0600342c3a49f20676f3e1744a78f3c010e315c2f4da65edee047fa757605bb0
163+
https://coston2-explorer.flare.network/tx/0x0600342c3a49f20676f3e1744a78f3c010e315c2f4da65edee047fa757605bb0?tab=logs
164+
107165
```
108166

167+
</details>
168+
109169
## Simulation
110170

111171
The above cycle can be simulated with a single CLI command:
112172

113173
```sh
114-
./smart_accounts.py debug simulation -a 0x55c815260cBE6c45Fe5bFe5FF32E3C7D746f14dC -m 1 -d 1
174+
./smart_accounts.py debug simulation --agent-address 0x55c815260cBE6c45Fe5bFe5FF32E3C7D746f14dC --mint 1 --deposit 1
115175
```
116176

117177
<details>
@@ -121,56 +181,65 @@ The CLI prompts the user to press "enter" five times in order to continue.
121181
The number of `.` symbols, as well as XRPL transaction hashes are expected not to match the ones in this example.
122182

123183
```
124-
sent instruction on underlying: E764D0EFBE330800A67E7B350351F6E81D12313B01060256406006BD3E22A68B
125-
https://testnet.xrpl.org/transactions/E764D0EFBE330800A67E7B350351F6E81D12313B01060256406006BD3E22A68B/detailed
184+
sent instruction on underlying: AF8BDE9810B64B442F5D50C37D176B101996B75ED1586233028AC964606849B4
185+
https://testnet.xrpl.org/transactions/AF8BDE9810B64B442F5D50C37D176B101996B75ED1586233028AC964606849B4/detailed
126186
127-
waiting to bridge.................
128-
BRIDGED FOR 0xDC47B18B7aDC3DeaCA42651cAF5A91397b57BAD3
129-
successfully bridged in tx 0x70d2482352708be181a8ed1ca2d409f047d051f01be08b06a41bc46cb7b14632
130-
https://coston2-explorer.flare.network/tx/0x70d2482352708be181a8ed1ca2d409f047d051f01be08b06a41bc46cb7b14632?tab=logs
187+
waiting to bridge................
188+
BRIDGED FOR 0xF4CC61CCCDA8b792EAA112455D9DBc4bcb9AA9A0
189+
successfully bridged in tx 0xa25fcb34183e509948140346bd5d50b87c9af7b2ba1a597e116c9435d33a0602
190+
https://coston2-explorer.flare.network/tx/0xa25fcb34183e509948140346bd5d50b87c9af7b2ba1a597e116c9435d33a0602?tab=logs
131191
132-
successful collateral resevation, continue to 2nd part of mint... press enter
133-
sent underlying assets in 18D4C1DD01826D4DEB389B49E064EE6041D134141A82C6909C2AEFB8AA6BC182
134-
https://testnet.xrpl.org/transactions/18D4C1DD01826D4DEB389B49E064EE6041D134141A82C6909C2AEFB8AA6BC182/detailed
192+
successful collateral reservation, continue to 2nd part of mint... press enter
193+
sent underlying assets in 7710196AF58BF63B1260E6B999C0FDAAA032F059713CE46D1E6F39853523FA52
194+
https://testnet.xrpl.org/transactions/7710196AF58BF63B1260E6B999C0FDAAA032F059713CE46D1E6F39853523FA52/detailed
135195
waiting for mint execution.............
136-
successfully minted in tx 0xbc619a14a4aec5c549e2acaa3b8a70396f15b5e625f1c74dfcdb3460768b8382
137-
https://coston2-explorer.flare.network/tx/0xbc619a14a4aec5c549e2acaa3b8a70396f15b5e625f1c74dfcdb3460768b8382?tab=logs
196+
successfully minted in tx 0x509de6a7dcc741814a11c51925b5947d3785655aac029ddb3cf829075d809bd7
197+
https://coston2-explorer.flare.network/tx/0x509de6a7dcc741814a11c51925b5947d3785655aac029ddb3cf829075d809bd7?tab=logs
138198
139199
minted fassets, check here:
140200
https://coston2-explorer.flare.network/address/0x0b6A3645c240605887a5532109323A3E12273dc7?tab=read_proxy
141201
142202
continue to deposit... press enter
143-
sent instruction on underlying: FD3F4AFEBFFA3B9B5DA6DDBEDB8B8921487B93B13AAC74B050B48F2D104CA442
144-
https://testnet.xrpl.org/transactions/FD3F4AFEBFFA3B9B5DA6DDBEDB8B8921487B93B13AAC74B050B48F2D104CA442/detailed
203+
sent instruction on underlying: CDB763ED1487DF49B1A6198BCBA919F9D1432EAA15D1A562F18C322137C52F65
204+
https://testnet.xrpl.org/transactions/CDB763ED1487DF49B1A6198BCBA919F9D1432EAA15D1A562F18C322137C52F65/detailed
205+
206+
waiting to bridge.............
207+
BRIDGED FOR 0xF4CC61CCCDA8b792EAA112455D9DBc4bcb9AA9A0
208+
successfully bridged in tx 0x84f9ae36727feadc4c113f74cdb221b140682c2c79d8ced495c457a43ac218d8
209+
https://coston2-explorer.flare.network/tx/0x84f9ae36727feadc4c113f74cdb221b140682c2c79d8ced495c457a43ac218d8?tab=logs
145210
146-
waiting to bridge.............................................................................
147-
failed to bridge
148211
deposited into vault, check here:
149212
https://coston2-explorer.flare.network/address/0x912DbF2173bD48ec0848357a128652D4c0fc33EB?tab=read_contract
150213
151214
continue to withdraw... press enter
152-
sent instruction on underlying: D62DD427CDDF71E5D02077C9FC405C78AB741A5893D02127C6E20B6A654D061C
153-
https://testnet.xrpl.org/transactions/D62DD427CDDF71E5D02077C9FC405C78AB741A5893D02127C6E20B6A654D061C/detailed
215+
sent instruction on underlying: 51145A98CB7217499D8C80C13EB6BCC631D1184BE24E3E6B25E1C1B1A556B477
216+
https://testnet.xrpl.org/transactions/51145A98CB7217499D8C80C13EB6BCC631D1184BE24E3E6B25E1C1B1A556B477/detailed
217+
218+
waiting to bridge............
219+
BRIDGED FOR 0xF4CC61CCCDA8b792EAA112455D9DBc4bcb9AA9A0
220+
successfully bridged in tx 0x427bd56f04967580557a8be5eaa7edaa14c7f846a367cfdb54dedde11e42962b
221+
https://coston2-explorer.flare.network/tx/0x427bd56f04967580557a8be5eaa7edaa14c7f846a367cfdb54dedde11e42962b?tab=logs
154222
155-
waiting to bridge............................................................................
156-
failed to bridge
157-
sent instruction on underlying: 97195789F1FAD40A25665816AC5712FE2F5308FA502BBBF182BA34A4A851D623
158-
https://testnet.xrpl.org/transactions/97195789F1FAD40A25665816AC5712FE2F5308FA502BBBF182BA34A4A851D623/detailed
223+
sent instruction on underlying: 45E68D1B9EDB81B74765E23C342B148F7386B7DB3079C5D20DB85BCCC605B5ED
224+
https://testnet.xrpl.org/transactions/45E68D1B9EDB81B74765E23C342B148F7386B7DB3079C5D20DB85BCCC605B5ED/detailed
225+
226+
waiting to bridge...............
227+
BRIDGED FOR 0xF4CC61CCCDA8b792EAA112455D9DBc4bcb9AA9A0
228+
successfully bridged in tx 0xd82daff2fe59fe083d7d2481ef5ab216dfe59d6832526fe9c2218f19074d32d4
229+
https://coston2-explorer.flare.network/tx/0xd82daff2fe59fe083d7d2481ef5ab216dfe59d6832526fe9c2218f19074d32d4?tab=logs
159230
160-
waiting to bridge..........................................................................
161-
failed to bridge
162231
withdrawn from vault, check here:
163232
https://coston2-explorer.flare.network/address/0x912DbF2173bD48ec0848357a128652D4c0fc33EB?tab=read_contract
164233
165234
continue to redeem... press enter
166-
sent instruction on underlying: 2C9527FC5891AA13085EF9BB137AFD82F591D2F5F88B527185F898416094525F
167-
https://testnet.xrpl.org/transactions/2C9527FC5891AA13085EF9BB137AFD82F591D2F5F88B527185F898416094525F/detailed
235+
sent instruction on underlying: E4C383DDE924AF03BA13A8199EA8C9DC7CA9012D4666D43CC6E0245F64402F3B
236+
https://testnet.xrpl.org/transactions/E4C383DDE924AF03BA13A8199EA8C9DC7CA9012D4666D43CC6E0245F64402F3B/detailed
237+
238+
waiting to bridge..............
239+
BRIDGED FOR 0xF4CC61CCCDA8b792EAA112455D9DBc4bcb9AA9A0
240+
successfully bridged in tx 0xff80b1da1581304a2e9584159966ad231bc3352275fcad639d6130e905217213
241+
https://coston2-explorer.flare.network/tx/0xff80b1da1581304a2e9584159966ad231bc3352275fcad639d6130e905217213?tab=logs
168242
169-
waiting to bridge....................
170-
BRIDGED FOR 0xDC47B18B7aDC3DeaCA42651cAF5A91397b57BAD3
171-
successfully bridged in tx 0x40339b62e54b083c99c7e65bbbd094e03fe642263ae8a74cac6bf5656c856a7b
172-
https://coston2-explorer.flare.network/tx/0x40339b62e54b083c99c7e65bbbd094e03fe642263ae8a74cac6bf5656c856a7b?tab=logs
173243
```
174244

175245
</details>
176-

0 commit comments

Comments
 (0)