README
¶
bridge-server
This suite consists of the following apps:
bridge- builds, submits and monitors transaction in Stellar network,compliance- helper server for using Compliance protocol.
More information about each server can be found in corresponding README file.
Downloading the server
Prebuilt binaries of the bridge-server server are available on the releases page.
| Platform | Binary file name |
|---|---|
| Mac OSX 64 bit | name-darwin-amd64 |
| Linux 64 bit | name-linux-amd64 |
| Windows 64 bit | name-windows-amd64.exe |
Alternatively, you can build the binary yourself.
Building
gb is used for building and testing.
Given you have a running golang installation, you can build the server with:
gb build
After a successful build, you should find bin/bridge in the project directory.
Running tests
gb test
Documentation
godoc -goroot=. -http=:6060
Then simply open:
http://localhost:6060/pkg/github.com/stellar/gateway/
in a browser.
Directories
¶
| Path | Synopsis |
|---|---|
|
src
|
|
|
github.com/stellar/gateway/external
Package external contains helper types for external packages.
|
Package external contains helper types for external packages. |
|
github.com/stellar/gateway/protocols
Package protocols contains message structures used to implement protocols.
|
Package protocols contains message structures used to implement protocols. |
|
github.com/stellar/gateway/protocols/compliance
Package compliance contains message structures required to implement compliance protocol.
|
Package compliance contains message structures required to implement compliance protocol. |
|
github.com/stellar/gateway/server
Package server contains some helper function used by http server
|
Package server contains some helper function used by http server |
Click to show internal directories.
Click to hide internal directories.