Skip to content

Commit 1d2929f

Browse files
committed
Fixed typo in code snippets
1 parent 601f7d5 commit 1d2929f

File tree

3 files changed

+56
-56
lines changed

3 files changed

+56
-56
lines changed

docs/markdown/autoapi/algokit_utils/accounts/account_manager/index.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ mnemonic-based, rekeyed, multisig, and logic signature accounts.
158158
* **Parameters:**
159159
**client_manager** – The ClientManager client to use for algod and kmd clients
160160
* **Example:**
161-
```pycon
161+
```python
162162
>>> account_manager = AccountManager(client_manager)
163163
```
164164

@@ -169,7 +169,7 @@ KMD account manager that allows you to easily get and create accounts using KMD.
169169
* **Return KmdAccountManager:**
170170
The ‘KmdAccountManager’ instance
171171
* **Example:**
172-
```pycon
172+
```python
173173
>>> kmd_manager = account_manager.kmd
174174
```
175175

@@ -185,7 +185,7 @@ then an error will be thrown from get_signer / get_account.
185185
* **Returns:**
186186
The AccountManager so method calls can be chained
187187
* **Example:**
188-
```pycon
188+
```python
189189
>>> signer_account = account_manager.random()
190190
>>> account_manager.set_default_signer(signer_account)
191191
```
@@ -200,7 +200,7 @@ Tracks the given TransactionSigner against the given sender address for later si
200200
* **Returns:**
201201
The AccountManager instance for method chaining
202202
* **Example:**
203-
```pycon
203+
```python
204204
>>> account_manager.set_signer("SENDERADDRESS", transaction_signer)
205205
```
206206

@@ -214,7 +214,7 @@ Merges the given AccountManager into this one.
214214
* **Returns:**
215215
The AccountManager instance for method chaining
216216
* **Example:**
217-
```pycon
217+
```python
218218
>>> accountManager2.set_signers(accountManager1)
219219
```
220220

@@ -243,7 +243,7 @@ The ‘signer’ parameter is deprecated and will show a warning when used.
243243
* **Raises:**
244244
**ValueError** – If no account or signer argument is provided
245245
* **Example:**
246-
```pycon
246+
```python
247247
>>> account_manager = AccountManager(client_manager)
248248
>>> # Using positional argument
249249
>>> account_manager.set_signer_from_account(
@@ -272,7 +272,7 @@ If no signer has been registered for that address then the default signer is use
272272
* **Raises:**
273273
**ValueError** – If no signer is found and no default signer is set
274274
* **Example:**
275-
```pycon
275+
```python
276276
>>> signer = account_manager.get_signer("SENDERADDRESS")
277277
```
278278

@@ -287,7 +287,7 @@ Returns the TransactionSignerAccountProtocol for the given sender address.
287287
* **Raises:**
288288
**ValueError** – If no account is found or if the account is not a regular account
289289
* **Example:**
290-
```pycon
290+
```python
291291
>>> sender = account_manager.random().address
292292
>>> # ...
293293
>>> # Returns the `TransactionSignerAccountProtocol` for `sender` that has previously been registered
@@ -306,7 +306,7 @@ for response data schema details.
306306
* **Returns:**
307307
The account information
308308
* **Example:**
309-
```pycon
309+
```python
310310
>>> address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"
311311
>>> account_info = account_manager.get_information(address)
312312
```
@@ -326,7 +326,7 @@ Be careful how the mnemonic is handled. Never commit it into source control and
326326
from the environment (ideally via a secret storage service) rather than the file system.
327327

328328
* **Example:**
329-
```pycon
329+
```python
330330
>>> account = account_manager.from_mnemonic("mnemonic secret ...")
331331
```
332332

@@ -355,7 +355,7 @@ Convention:
355355
it will create it and fund the account for you
356356

357357
* **Example:**
358-
```pycon
358+
```python
359359
>>> # If you have a mnemonic secret loaded into `MY_ACCOUNT_MNEMONIC` then you can call:
360360
>>> account = account_manager.from_environment('MY_ACCOUNT')
361361
>>> # If that code runs against LocalNet then a wallet called `MY_ACCOUNT` will automatically be created
@@ -375,7 +375,7 @@ Tracks and returns an Algorand account with private key loaded from the given KM
375375
* **Raises:**
376376
**ValueError** – If unable to find KMD account with given name and predicate
377377
* **Example:**
378-
```pycon
378+
```python
379379
>>> # Get default funded account in a LocalNet:
380380
>>> defaultDispenserAccount = account.from_kmd('unencrypted-default-wallet',
381381
... lambda a: a.status != 'Offline' and a.amount > 1_000_000_000
@@ -392,7 +392,7 @@ Tracks and returns an account that represents a logic signature.
392392
* **Returns:**
393393
A logic signature account wrapper
394394
* **Example:**
395-
```pycon
395+
```python
396396
>>> account = account.logicsig(program, [new Uint8Array(3, ...)])
397397
```
398398

@@ -406,7 +406,7 @@ Tracks and returns an account that supports partial or full multisig signing.
406406
* **Returns:**
407407
A multisig account wrapper
408408
* **Example:**
409-
```pycon
409+
```python
410410
>>> account = account_manager.multi_sig(
411411
... version=1,
412412
... threshold=1,
@@ -422,7 +422,7 @@ Tracks and returns a new, random Algorand account.
422422
* **Returns:**
423423
The account
424424
* **Example:**
425-
```pycon
425+
```python
426426
>>> account = account_manager.random()
427427
```
428428

@@ -435,7 +435,7 @@ This account can be used to fund other accounts.
435435
* **Returns:**
436436
The account
437437
* **Example:**
438-
```pycon
438+
```python
439439
>>> account = account_manager.localnet_dispenser()
440440
```
441441

@@ -448,7 +448,7 @@ If environment variables are not present, returns the default LocalNet dispenser
448448
* **Returns:**
449449
The account
450450
* **Example:**
451-
```pycon
451+
```python
452452
>>> account = account_manager.dispenser_from_environment()
453453
```
454454

@@ -462,7 +462,7 @@ Tracks and returns an Algorand account that is a rekeyed version of the given ac
462462
* **Returns:**
463463
The rekeyed account
464464
* **Example:**
465-
```pycon
465+
```python
466466
>>> account = account.from_mnemonic("mnemonic secret ...")
467467
>>> rekeyed_account = account_manager.rekeyed(account, "SENDERADDRESS...")
468468
```
@@ -492,7 +492,7 @@ Please be careful with this function and be sure to read the
492492
[official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying).
493493

494494
* **Example:**
495-
```pycon
495+
```python
496496
>>> # Basic example (with string addresses):
497497
>>> algorand.account.rekey_account("ACCOUNTADDRESS", "NEWADDRESS")
498498
>>> # Basic example (with signer accounts):
@@ -542,7 +542,7 @@ See [https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr](htt
542542
The result of executing the dispensing transaction and the amountFunded if funds were needed,
543543
or None if no funds were needed
544544
* **Example:**
545-
```pycon
545+
```python
546546
>>> # Basic example:
547547
>>> algorand.account.ensure_funded("ACCOUNTADDRESS", "DISPENSERADDRESS", AlgoAmount.from_algo(1))
548548
>>> # With configuration:
@@ -592,7 +592,7 @@ process.env.DISPENSER_MNEMONIC and optionally process.env.DISPENSER_SENDER
592592
if it’s a rekeyed account, or against default LocalNet if no environment variables present.
593593

594594
* **Example:**
595-
```pycon
595+
```python
596596
>>> # Basic example:
597597
>>> algorand.account.ensure_funded_from_environment("ACCOUNTADDRESS", AlgoAmount.from_algo(1))
598598
>>> # With configuration:
@@ -626,7 +626,7 @@ See [https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr](htt
626626
* **Raises:**
627627
**ValueError** – If attempting to fund on non-TestNet network
628628
* **Example:**
629-
```pycon
629+
```python
630630
>>> # Basic example:
631631
>>> account_manager.ensure_funded_from_testnet_dispenser_api(
632632
... "ACCOUNTADDRESS",

docs/markdown/autoapi/algokit_utils/algorand/index.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Sets the default validity window for transactions.
2020
* **Returns:**
2121
The AlgorandClient so method calls can be chained
2222
* **Example:**
23-
```pycon
23+
```python
2424
>>> algorand = AlgorandClient.mainnet().set_default_validity_window(1000);
2525
```
2626

@@ -33,7 +33,7 @@ Sets the default signer to use if no other signer is specified.
3333
* **Returns:**
3434
The AlgorandClient so method calls can be chained
3535
* **Example:**
36-
```pycon
36+
```python
3737
>>> signer = SigningAccount(private_key=..., address=...)
3838
>>> algorand = AlgorandClient.mainnet().set_default_signer(signer)
3939
```
@@ -48,7 +48,7 @@ Tracks the given account for later signing.
4848
* **Returns:**
4949
The AlgorandClient so method calls can be chained
5050
* **Example:**
51-
```pycon
51+
```python
5252
>>> signer = SigningAccount(private_key=..., address=...)
5353
>>> algorand = AlgorandClient.mainnet().set_signer(signer.addr, signer.signer)
5454
```
@@ -62,7 +62,7 @@ Sets the default signer to use if no other signer is specified.
6262
* **Returns:**
6363
The AlgorandClient so method calls can be chained
6464
* **Example:**
65-
```pycon
65+
```python
6666
>>> accountManager = AlgorandClient.mainnet()
6767
>>> accountManager.set_signer_from_account(TransactionSignerAccount(address=..., signer=...))
6868
>>> accountManager.set_signer_from_account(algosdk.LogicSigAccount(program, args))
@@ -81,7 +81,7 @@ Sets a cache value to use for suggested params.
8181
* **Returns:**
8282
The AlgorandClient so method calls can be chained
8383
* **Example:**
84-
```pycon
84+
```python
8585
>>> algorand = AlgorandClient.mainnet().set_suggested_params_cache(suggested_params, time.time() + 3.6e6)
8686
```
8787

@@ -94,7 +94,7 @@ Sets the timeout for caching suggested params.
9494
* **Returns:**
9595
The AlgorandClient so method calls can be chained
9696
* **Example:**
97-
```pycon
97+
```python
9898
>>> algorand = AlgorandClient.mainnet().set_suggested_params_cache_timeout(10_000)
9999
```
100100

@@ -103,7 +103,7 @@ Sets the timeout for caching suggested params.
103103
Get suggested params for a transaction (either cached or from algod if the cache is stale or empty)
104104

105105
* **Example:**
106-
```pycon
106+
```python
107107
>>> algorand = AlgorandClient.mainnet().get_suggested_params()
108108
```
109109

@@ -131,7 +131,7 @@ Unregister an error transformer function
131131
Start a new TransactionComposer transaction group
132132

133133
* **Example:**
134-
```pycon
134+
```python
135135
>>> composer = AlgorandClient.mainnet().new_group()
136136
>>> result = await composer.add_transaction(payment).send()
137137
```
@@ -141,7 +141,7 @@ Start a new TransactionComposer transaction group
141141
Get clients, including algosdk clients and app clients.
142142

143143
* **Example:**
144-
```pycon
144+
```python
145145
>>> clientManager = AlgorandClient.mainnet().client
146146
```
147147

@@ -150,7 +150,7 @@ Get clients, including algosdk clients and app clients.
150150
Get or create accounts that can sign transactions.
151151

152152
* **Example:**
153-
```pycon
153+
```python
154154
>>> accountManager = AlgorandClient.mainnet().account
155155
```
156156

@@ -159,7 +159,7 @@ Get or create accounts that can sign transactions.
159159
Get or create assets.
160160

161161
* **Example:**
162-
```pycon
162+
```python
163163
>>> assetManager = AlgorandClient.mainnet().asset
164164
```
165165

@@ -168,7 +168,7 @@ Get or create assets.
168168
Get or create applications.
169169

170170
* **Example:**
171-
```pycon
171+
```python
172172
>>> appManager = AlgorandClient.mainnet().app
173173
```
174174

@@ -177,7 +177,7 @@ Get or create applications.
177177
Get or create applications.
178178

179179
* **Example:**
180-
```pycon
180+
```python
181181
>>> appDeployer = AlgorandClient.mainnet().app_deployer
182182
```
183183

@@ -186,7 +186,7 @@ Get or create applications.
186186
Methods for sending a transaction and waiting for confirmation
187187

188188
* **Example:**
189-
```pycon
189+
```python
190190
>>> result = await AlgorandClient.mainnet().send.payment(
191191
>>> PaymentParams(
192192
>>> sender="SENDERADDRESS",
@@ -200,7 +200,7 @@ Methods for sending a transaction and waiting for confirmation
200200
Methods for building transactions
201201

202202
* **Example:**
203-
```pycon
203+
```python
204204
>>> transaction = AlgorandClient.mainnet().create_transaction.payment(
205205
>>> PaymentParams(
206206
>>> sender="SENDERADDRESS",
@@ -216,7 +216,7 @@ Returns an AlgorandClient pointing at default LocalNet ports and API token.
216216
* **Returns:**
217217
The AlgorandClient
218218
* **Example:**
219-
```pycon
219+
```python
220220
>>> algorand = AlgorandClient.default_localnet()
221221
```
222222

@@ -227,7 +227,7 @@ Returns an AlgorandClient pointing at TestNet using AlgoNode.
227227
* **Returns:**
228228
The AlgorandClient
229229
* **Example:**
230-
```pycon
230+
```python
231231
>>> algorand = AlgorandClient.testnet()
232232
```
233233

@@ -238,7 +238,7 @@ Returns an AlgorandClient pointing at MainNet using AlgoNode.
238238
* **Returns:**
239239
The AlgorandClient
240240
* **Example:**
241-
```pycon
241+
```python
242242
>>> algorand = AlgorandClient.mainnet()
243243
```
244244

@@ -253,7 +253,7 @@ Returns an AlgorandClient pointing to the given client(s).
253253
* **Returns:**
254254
The AlgorandClient
255255
* **Example:**
256-
```pycon
256+
```python
257257
>>> algorand = AlgorandClient.from_clients(algod, indexer, kmd)
258258
```
259259

@@ -268,7 +268,7 @@ Expects to be called from a Python environment.
268268
* **Returns:**
269269
The AlgorandClient
270270
* **Example:**
271-
```pycon
271+
```python
272272
>>> algorand = AlgorandClient.from_environment()
273273
```
274274

@@ -283,6 +283,6 @@ Returns an AlgorandClient from the given config.
283283
* **Returns:**
284284
The AlgorandClient
285285
* **Example:**
286-
```pycon
286+
```python
287287
>>> algorand = AlgorandClient.from_config(algod_config, indexer_config, kmd_config)
288288
```

0 commit comments

Comments
 (0)