bda9bbec66
* Exchanges: Remove example BespokeGenerateMessageID * Okx: Replace conn.RequestIDGenerator with MesssageID Continued overall direction to remove the closed-loop of e => conn => e roundtrip for message ids * Exchanges: Add MessageSequence This method removes the either/or nature of message id generation. We don't tie the message ids to connections, or to anything. Consumers just call whichever they want, or even combine them as they want. Anything more complicated will need a separate installation anyway * GateIO: Split usage of MessageID and MessageSequence * Binance: Switch to UUID message IDs * Kraken: Switch to e.MessageSequence * Kucoin: Switch to MessageID * HitBTC: Switch to UUIDv7 for ws message ID * Bybit: Switch to UUIDv7 for ws message ID * Bitfinex: Switch to UUIDv7 and MessageSequence Tested CID - It accepts 53 bits only for an int, so MessageSequence makes sense. Can't use MessageID * Websocket: Remove now unused MessageID function Moved all MessageID usage into funcs and onto base methods, to remove the closed loop of message IDs * Docs: Update guidance for message signatures
GoCryptoTrader package Documentation
This documentation package is part of the GoCryptoTrader codebase.
This is still in active development
You can track ideas, planned features and what's in progress on our GoCryptoTrader Kanban board.
Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack
Current Features for documentation
This tool allows for the generation of new documentation through templating
From the gocryptotrader/cmd/documentation/ folder, using the go command: go run documentation.go this will auto-generate and regenerate documentation across the GoCryptoTrader code base.
Using the -v command will, ie go run documentation.go -v put the tool into verbose mode allowing you to see what is happening with a little more depth.
Be aware, this tool will:
- Works off a configuration JSON file located at
gocryptotrader/cmd/documentation/for future use with multiple repositories. - Automatically find the directory and file tree for the GoCryptoTrader source code and alert you of undocumented file systems which need to be updated.
- Automatically find the template folder tree.
- Fetch an updated contributor list and rank on pull request commit amount. Set the
GITHUB_TOKENenvironment variable or use theghtokencommand-line flag for optional authentication. - Sets up core folder docs for the root directory tree including LICENSE and CONTRIBUTORS
config.json example
{
"githubRepo": "https://api.github.com/repos/thrasher-corp/gocryptotrader", This is your current repo
"exclusionList": { This allows for excluded directories and files
"Files": null,
"Directories": [
"_templates",
".git",
"web"
]
},
"rootReadmeActive": true, allows a root directory README.md
"licenseFileActive": true, allows for a license file to be generated
"contributorFileActive": true, fetches a new contributor list
"referencePathToRepo": "../../"
}
Template example
place a new template example_file.tmpl located in the current gocryptotrader/cmd/documentation/ folder; when the documentation tool finishes it will give you the define template associated name e.g.
Template not found for path ../../cmd/documentation create new template with \{\{define "cmd documentation" -\}\} TEMPLATE HERE \{\{end}}so you can replace the below example with\{\{define "cmd documentation" -}}
\{\{\define "example_definition_created_by_documentation_tool" -}}
\{\{\template "header" .}}
## Current Features for documentation
#### A concise blurb about the package or tool system
+ Coding examples
import "github.com/thrasher-corp/gocryptotrader/something"
testString := "aAaAa"
upper := strings.ToUpper(testString)
// upper == "AAAAA"
{\{\template "contributions"}}
{\{\template "donations"}}
{\{\end}}
ALL NEW UPDATES AND FILE SYSTEM ADDITIONS NEED A DOCUMENTATION UPDATE USING THIS TOOL OR PR MERGE REQUEST MAY BE POSTPONED.
Donations
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc