moov/wire repository overview

Project Documentation⁠ · API Endpoints⁠ · Community⁠ · Blog⁠

⁠moov-io/wire

Moov's mission is to give developers an easy way to create and integrate bank processing into their own software products. Our open source projects are each focused on solving a single responsibility in financial services and designed around performance, scalability, and ease of use.

Wire implements a reader, writer, and validator for FED Wire Messages (FEDWire⁠) in an HTTP server and Go library. The HTTP server is available in a Docker image⁠ and the Go package github.com/moov-io/wire is available.

⁠Table of Contents

• Project Status
• Usage
  • Docker
  • Google Cloud
  • Configuration Settings
  • Data Persistence
• Learn About Wire
• FAQ
• Getting Help
• Supported and Tested Platforms
• Contributing
• Related Projects

⁠Project Status

Moov Wire is actively used in multiple production environments. Please star the project if you are interested in its progress. If you have layers above Wire to simplify tasks, perform business operations, or found bugs we would appreciate an issue or pull request. Thanks!

⁠Usage

The Wire project implements an HTTP server and Go library⁠ for creating and modifying Wire files. We also have some examples⁠ of the reader and writer.

⁠Docker

We publish a public Docker image moov/wire⁠ on Docker Hub with every tagged release of Wire. No configuration is required to serve on :8088 and metrics at :9098/metrics in Prometheus format. We also have Docker images for OpenShift⁠ published as quay.io/moov/wire.

Pull & start the Docker image:

docker pull moov/wire:latest
docker run -p 8088:8088 -p 9098:9098 moov/wire:latest

List files stored in-memory:

curl localhost:8088/files

null

Create a file on the HTTP server:

curl -X POST --data-binary "@./test/testdata/fedWireMessage-CustomerTransfer.txt" http://localhost:8088/files/create

{"id":"<YOUR-UNIQUE-FILE-ID>","fedWireMessage":{"id":"","senderSupplied":{"formatVersion":"30", .....

Get the file in its original format:

curl http://localhost:8088/files/<YOUR-UNIQUE-FILE-ID>/contents

{1500}30User ReqT
{1510}1000
{1520}20190410Source08000001
...

⁠Google Cloud Run

To get started in a hosted environment you can deploy this project to the Google Cloud Platform.

From your Google Cloud dashboard⁠ create a new project and call it:

moov-wire-demo

Enable the Container Registry⁠ API for your project and associate a billing account⁠ if needed. Then, open the Cloud Shell terminal and run the following Docker commands, substituting your unique project ID:

docker pull moov/wire
docker tag moov/wire gcr.io/<PROJECT-ID>/wire
docker push gcr.io/<PROJECT-ID>/wire

Deploy the container to Cloud Run:

gcloud run deploy --image gcr.io/<PROJECT-ID>/wire --port 8088

Select your target platform to 1, service name to wire, and region to the one closest to you (enable Google API service if a prompt appears). Upon a successful build you will be given a URL where the API has been deployed:

https://YOUR-WIRE-APP-URL.a.run.app

Now you can list files stored in-memory:

curl https://YOUR-WIRE-APP-URL.a.run.app/files

You should get this response:

null

⁠Configuration Settings

The following environmental variables can be set to configure behavior in Wire.

⁠Data Persistence

By design, Wire does not persist (save) any data about the files or entry details created. The only storage occurs in memory of the process and upon restart Wire will have no files or data saved. Also, no in-memory encryption of the data is performed.

⁠Learn About Wire

• Intro to Fedwire⁠
• FedWire Message Structure⁠
• Sending or Receiving International Wires via the Fedwire Funds Service⁠

⁠FAQ

⁠Getting Help

⁠Supported and Tested Platforms

• 64-bit Linux (Ubuntu, Debian), macOS, and Windows

Note: 32-bit platforms have known issues and are not supported.

⁠Contributing

Yes please! Please review our Contributing guide⁠ and Code of Conduct⁠ to get started!

This project uses Go Modules⁠ and uses Go v1.14 or higher. See Golang's install instructions⁠ for help setting up Go. You can download the source code and we offer tagged and released versions⁠ as well. We highly recommend you use a tagged release for production.

⁠Releasing

To make a release of wire simply open a pull request with CHANGELOG.md and version.go updated with the next version number and details. You'll also need to push the tag (i.e. git push origin v1.0.0) to origin in order for CI to make the release.

⁠Testing

We maintain a comprehensive suite of unit tests and recommend table-driven testing when a particular function warrants several very similar test cases. To run all test files in the current directory, use go test. Current overall coverage can be found on Codecov⁠.

⁠Fuzzing

We currently run fuzzing over Wire in the form of a moov/wirefuzz⁠ Docker image. You can read more⁠ or run the image and report crasher examples to [email protected]⁠. Thanks!

⁠Related Projects

As part of Moov's initiative to offer open source fintech infrastructure, we have a large collection of active projects you may find useful:

• Moov Watchman⁠ offers search functions over numerous trade sanction lists from the United States and European Union.

• Moov Fed⁠ implements utility services for searching the United States Federal Reserve System such as ABA routing numbers, financial institution name lookup, and FedACH and Fedwire routing information.

• Moov Image Cash Letter⁠ implements Image Cash Letter (ICL) files used for Check21, X.9 or check truncation files for exchange and remote deposit in the U.S.

• Moov ACH⁠ provides ACH file generation and parsing, supporting all Standard Entry Codes for the primary method of money movement throughout the United States.

• Moov Metro 2⁠ provides a way to easily read, create, and validate Metro 2 format, which is used for consumer credit history reporting by the United States credit bureaus.

⁠License

Apache License 2.0 - See LICENSE⁠ for details.