search

ParadigmFoundation / zaidan-monorepo

Zaidan Liquidity Monorepo
2 stars 0 forks source link

Open source certain services/libraries from monorepo #116

Open hrharder opened 4 years ago

hrharder commented 4 years ago

Overview

As we wind down, I think it makes sense to open-source some of the components of this repo so that others who may one day build on the Zaidan spec may use them.

Some of the libraries (within lib) may be independently useful for non-zaidan projects, too.

New repos

These new public repos should be created, with the indicated components of zaidan-monorepo added to them.

  1. go-zrx - Go library with helpful tools for interacting with the 0x system.
    • lib/go/zrx package
  2. go-eth - Go library with helpful tools for interacting with Ethereum.
    • lib/go/eth package
  3. go-ptr - Simple library for working with basic type pointers and defaults.
    • lib/go/utils/ptr
  4. go-bugsnag-logger - Logger abstractions for projects that use bugsnag.
    • lib/go/logger
  5. dealer-types - Proto definitions that may be useful for Zaidan dealer implementations.
  6. go-obm - gRPC based order book manager for centralized cryptocurrency exchanges
    • services/order-book-manager
    • All necessary .proto files
  7. go-hot-wallet - gRPC based Ethereum "hot wallet" for microservice applications
    • services/hot-wallet
    • All necessary .proto files

For each repo

For each repo, the following (at minimum) should be completed.

  1. Short description fo repo on GitHub page
  2. Brief/descriptive README with instructions as necessary
  3. Select/add MIT license
  4. Comment code where possible
  5. Ensure necessary tests are present and pass.
  6. (OPTIONAL) Setup travis CI/GitHub actions for running test

Feel free to add more, or make edits as you are migrating code.

Checklist/assignments

qustavo commented 4 years ago

@hrharder I noticed that the only part of the zaidan codebase that is using go-ptr is the GetMarkets RPC method from the Dealer package. Do you think that it still makes sense to extract it and package as a library?

hrharder commented 4 years ago

good point, let's drop that one. unless there are other standalone utilities that warrant a util package

On Tue, Feb 25, 2020 at 12:34 PM Gustavo Chaín notifications@github.com wrote:

@hrharder https://github.com/hrharder I noticed that the only part of the zaidan codebase that is using go-ptr is the GetMarkets RPC method from the Dealer package. Do you think that it still makes sense to extract it and package as a library?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ParadigmFoundation/zaidan-monorepo/issues/116?email_source=notifications&email_token=ABV4VM53YSOI5ZULNIHR77LREVJA3A5CNFSM4K2MTW2KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEM4YGEI#issuecomment-590971665, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABV4VM3XCKM46EWA2XZCFF3REVJA3ANCNFSM4K2MTW2A .