stc is a library and command-line tool for creating, editing, and manipulating transactions for the Stellar blockchain. It supports translating back and forth between human-readable txrep format and Stellar's native binary XDR representation, as well submitting transactions to the network, querying account status, and more. The library makes it easy to build and submit transactions programmatically from go applications.
To install or upgrade this software if you don't plan to hack on it,
run the following two commands (assuming your GOPATH is in the default
location of ~/go):
rm -rf ~/go/src/github.com/xdrpp/stc
GOPRIVATE='*' go get github.com/xdrpp/stc/...
The rm command is necessary when upgrading because some go get
limitation leaves your
tree in a detached state, so that go get -u cannot pull from the
remote go1 branch. The GOPRIVATE environment variable requests
the latest version of the software from github, instead of calling
home to Google's module proxy and allowing Google to supply an
incorrect or stale version of the software (which unfortunately
happened to the author).
Once this command completes, put the ~/go/bin directory on your path
and you should be able to run stc.
For most purposes you can simply depend on the latest release.
However, if you wish to install the latest development version from
within a go module (a directory with a go.mod file), you will need
to specify the go1 branch to get autogenerated files that are not
available on the master branch. Do so by running:
GOPRIVATE='*' go get github.com/xdrpp/stc/...@go1
See the stc(1) man page for the command-line tool.
See the godoc documentation for the library. Because
stc contains auto-generated source files that are not on the
master branch in git, you may wish to view the documentation
locally, rather than through on-line godoc viewers that may not show
you the correct branch. To view godoc, after installing stc with
go get as described above, start a local godoc server and open it in
your browser as follows:
godoc -index -http localhost:6060 &
xdg-open http://localhost:6060/pkg/github.com/xdrpp/stc
On MacOS computers, run open instead of xdg-open, or just paste
the URL into your browser.
Because stc requires autogenerated files, the master branch is not
meant to be compiled under $GOPATH, but rather in a standalone
directory with make.
Furthermore, to build stc from the master branch, you also need to
have the goxdr compiler. Because
stc is codeveloped with goxdr, you may want to use a development
version of goxdr, which you can do by placing a the goxdr source
tree (or a symbolic link to it) in cmd/goxdr. If you don't want to
do this, but are okay just using a snapshot of goxdr, you can run:
make depend
Once you have goxdr, you can build stc by running:
make
To install stc, you will also need pandoc to
format the man page.
There is no warranty for the program, to the extent permitted by applicable law. Except when otherwise stated in writing the copyright holders and/or other parties provide the program "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the program is with you. Should the program prove defective, you assume the cost of all necessary servicing, repair or correction.
In no event unless required by applicable law or agreed to in writing will any copyright holder, or any other party who modifies and/or conveys the program as permitted above, be liable to you for damages, including any general, special, incidental or consequential damages arising out of the use or inability to use the program (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the program to operate with any other programs), even if such holder or other party has been advised of the possibility of such damages.