This folder is for storing any scripts that may be helpful for using stellar-core.

• Overlay survey
• Diff Tracy CSV

• Name - OverlaySurvey.py

• Description - A Python script that will walk the network using the Overlay survey mechanism to gather connection information. See admin for more information on the overlay survey. The survey will use the peers of the initial node to seed the survey.

• Usage - Ex. python3 OverlaySurvey.py -gs gs.json survey -n http://127.0.0.1:11626 -d 50 -sr sr.json -gmlw gmlw.graphml to run the survey, python3 OverlaySurvey.py -gs gs.json analyze -gmla gmla.graphml to analyze an existing graph, or python3 OverlaySurvey.py -gs gs.json augment -gmli gmlw.graphml -gmlo augmented.graphml to augment the existing graph with data from StellarBeat.

  • -gs GRAPHSTATS, --graphStats GRAPHSTATS - output file for graph stats (Optional)
  • sub command survey - run survey and analyze
    • -n NODE, --node NODE - address of initial survey node
    • -d DURATION, --duration DURATION - duration of survey in seconds
    • -nl NODELIST, --nodeList NODELIST - list of seed nodes. One node per line. (Optional)
    • -gmlw GRAPHMLWRITE, --graphmlWrite GRAPHMLWRITE - output file for graphml file
    • -sr SURVEYRESULT, --surveyResult SURVEYRESULT - output file for survey results
  • sub command analyze - analyze an existing graph
    • -gmla GRAPHMLANALYZE, --graphmlAnalyze GRAPHMLANALYZE - input graphml file
  • sub command augment - analyze an existing graph
    • -gmli GRAPHMLINPUT - input graphml file
    • -gmlo GRAPHMLOUTPUT - output graphml file
  • sub command flatten - Take a graphml file containing a bidrectional graph (possibly augmented with StellarBeat data) and flatten it into an undirected graph in JSON.
    • -gmli GRAPHMLINPUT - input graphml file
    • -json JSONOUTPUT - output json file

• Name - DiffTracyCSV.py
• Description - A Python script that compares two CSV files produced by tracy-csvexport (which in turn reads output from tracy-capture). The purpose of this script is to detect significant performance impacts of changes to stellar-core by capturing before-and-after traces.
• Usage - Ex. tracy-capture -o old.tracy -s 10 -a 127.0.0.1 to capture a 10 second trace of stellar-core running on the local machine. Then run tracy-csvexport -u old.tracy >old.csv. Then make a change to stellar-core and repeat the process to capture new.tracy and new.csv. Finally, run DiffTracyCSV.py --old old.csv --new new.csv and inspect the differences.

We follow PEP-0008.