Skip to content

Commit

Permalink
Merge pull request #847 from nullun/staging
Browse files Browse the repository at this point in the history
Docs regen
  • Loading branch information
barnjamin authored Jul 14, 2022
2 parents 26b47c6 + 5b53ea4 commit 85cb0a5
Show file tree
Hide file tree
Showing 40 changed files with 671 additions and 113 deletions.
4 changes: 3 additions & 1 deletion docs/clis/algokey/algokey.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ algokey [flags]

```
-h, --help help for algokey
-h, --help help for algokey
-v, --version Display and write current build version and exit
```

Expand Down
2 changes: 1 addition & 1 deletion docs/clis/algokey/part/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ algokey part generate [flags]

```
--dilution uint Key dilution (default to sqrt of validity window)
--dilution uint Key dilution for two-level participation keys (defaults to sqrt of validity window)
--first uint First round for participation key
Expand Down
2 changes: 1 addition & 1 deletion docs/clis/goal/account/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ goal account [flags]


* [goal](../../../goal/goal/) - CLI for interacting with Algorand
* [goal account addpartkey](../addpartkey/) - Generate a participation key for the specified account
* [goal account addpartkey](../addpartkey/) - Generate and install participation key for the specified account
* [goal account balance](../balance/) - Retrieve the balances for the specified account
* [goal account changeonlinestatus](../changeonlinestatus/) - Change online status for the specified account
* [goal account delete](../delete/) - Delete an account
Expand Down
6 changes: 3 additions & 3 deletions docs/clis/goal/account/addpartkey.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ title: goal account addpartkey



Generate a participation key for the specified account
Generate and install participation key for the specified account



### Synopsis



Generate a participation key for the specified account. This participation key can then be used for going online and participating in consensus.
Generate and install participation key for the specified account. This participation key can then be used for going online and participating in consensus.



Expand All @@ -34,7 +34,7 @@ goal account addpartkey [flags]
-h, --help help for addpartkey
--keyDilution uint Key dilution for two-level participation keys
--keyDilution uint Key dilution for two-level participation keys (defaults to sqrt of validity window)
-o, --outdir string Save participation key file to specified output directory to (for offline creation)
Expand Down
6 changes: 4 additions & 2 deletions docs/clis/goal/account/changeonlinestatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ goal account changeonlinestatus [flags]

```
-a, --address string Account address to change (required if no -partkeyfile)
-a, --address string Account address to change (required if no --partkeyfile)
-f, --fee uint The Fee to set on the status change transaction (defaults to suggested fee)
Expand All @@ -46,7 +46,9 @@ goal account changeonlinestatus [flags]
-o, --online Set this account to online or offline (default true)
--partkeyfile string Participation key file (required if no -account)
--partkeyfile string Participation key file (required if no --address)
-S, --signer string Address of key to sign with, if different due to rekeying
-t, --txfile string Write status change transaction to this file
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/account/marknonparticipating.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ goal account marknonparticipating [flags]
-N, --no-wait Don't wait for transaction to commit
-S, --signer string Address of key to sign with, if different from address due to rekeying
-t, --txfile string Write status change transaction to this file, rather than posting to network
-v, --validrounds uint The validity period for the status change transaction
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/app/call.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ goal app call [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/app/clear.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ goal app clear [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/app/closeout.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ goal app closeout [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/app/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ goal app create [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/app/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ goal app delete [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
8 changes: 5 additions & 3 deletions docs/clis/goal/app/interact/execute.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ goal app interact execute [flags]

```
--app-id uint Application ID (if omitted, zero, which creates an application)
--app-id uint Application ID (if omitted, zero, which creates an application)
-f, --from string Account to execute interaction from
-f, --from string Account to execute interaction from
-h, --help help for execute
-h, --help help for execute
-S, --signer string Address of key to sign with, if different from "from" address due to rekeying
```

Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/app/method.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ goal app method [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/app/optin.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ goal app optin [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/app/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ goal app update [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
1 change: 1 addition & 0 deletions docs/clis/goal/asset/asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ goal asset [flags]
* [goal asset destroy](../destroy/) - Destroy an asset
* [goal asset freeze](../freeze/) - Freeze assets
* [goal asset info](../info/) - Look up current parameters for an asset
* [goal asset optin](../optin/) - Optin to assets
* [goal asset send](../send/) - Transfer assets


Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/asset/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ goal asset config [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/asset/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ goal asset create [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--total uint Total amount of tokens for created asset
--unitname string Name for the unit of asset
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/asset/destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ goal asset destroy [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/asset/freeze.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ goal asset freeze [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```
Expand Down
98 changes: 98 additions & 0 deletions docs/clis/goal/asset/optin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
title: goal asset optin
---
## goal asset optin



Optin to assets



### Synopsis



Opt in to receive a new asset. An account will begin accepting an asset by issuing a zero-amount asset transfer to itself.



```
goal asset optin [flags]
```



### Options



```
-a, --account string Account address to opt in to using the asset (if not specified, uses default account)
--asset string Unit name of the asset being accepted
--assetid uint ID of the asset being accepted
--creator string Account address for asset creator
--dryrun-accounts strings additional accounts to include into dryrun request obj
--dryrun-dump Dump in dryrun format acceptable by dryrun REST api
--dryrun-dump-format string Dryrun dump format: json, msgp (default "json")
--fee uint The transaction fee (automatically determined by default), in microAlgos
--firstvalid uint The first round where the transaction may be committed to the ledger
-h, --help help for optin
--lastvalid uint The last round where the transaction may be committed to the ledger
-x, --lease string Lease value (base64, optional): no transaction may also acquire this lease until lastvalid
-N, --no-wait Don't wait for transaction to commit
-n, --note string Note text (ignored if --noteb64 used also)
--noteb64 string Note (URL-base64 encoded)
-o, --out string Write transaction to this file
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
--validrounds uint The number of rounds for which the transaction will be valid
```



### Options inherited from parent commands



```
-d, --datadir stringArray Data directory for the node
-k, --kmddir string Data directory for kmd
-w, --wallet string Set the wallet to be used for the selected operation
```



### SEE ALSO



* [goal asset](../../asset/asset/) - Manage assets



2 changes: 2 additions & 0 deletions docs/clis/goal/asset/send.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ goal asset send [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
-t, --to string Address to send to money to (required)
--validrounds uint The number of rounds for which the transaction will be valid
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/clerk/compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ goal clerk compile [input file 1] [input file 2]... [flags]
-h, --help help for compile
-m, --map write out source map
-n, --no-out don't write contract program binary
-o, --outfile string Filename to write program bytes or signed LogicSig to
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/clerk/send.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ goal clerk send [flags]
-s, --sign Use with -o to indicate that the dumped transaction should be signed
-S, --signer string Address of key to sign with, if different from transaction "from" address due to rekeying
-t, --to string Address to send to money to (required)
--validrounds uint The number of rounds for which the transaction will be valid
Expand Down
2 changes: 2 additions & 0 deletions docs/clis/goal/network/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ goal network create [flags]

```
--devMode Forces the configuration to enable DevMode, returns an error if the template is not compatible with DevMode.
-h, --help help for create
-n, --network string Specify the name to use for the private network
Expand Down
2 changes: 1 addition & 1 deletion docs/clis/goal/node/catchup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Catchup the Algorand node to a specific catchpoint



Catchup allows making large jumps over round ranges without the need to incrementally validate each individual round.
Catchup allows making large jumps over round ranges without the need to incrementally validate each individual round. If no catchpoint is provided, this command attempts to lookup the latest catchpoint from algorand-catchpoints.s3.us-east-2.amazonaws.com.



Expand Down
Loading

0 comments on commit 85cb0a5

Please sign in to comment.