Implement CLI for local dev testing

we have this in web, do the same in lib

Lint test build step for lib

Implement method and tests

We are currently calling toUpperCase() on symbol everywhere in web. Standard style is uppercase symbol anyway so we should follow that

captured in shapeshift/web#65

Implement method and tests

Once Thorchain is added, choose best quote given a set of assets.

Note: getQuote can be expensive. This may need to only happen when assets are changed. This actually probably should be getBestSwapper. More discussion is needed when we get here

Implement method and tests

We need a way to get market cap data, so we can sort assets in the UI (and display market cap obv).

Use coingecko API to get this, cache the calls, and generate static data and commit to github (like we do in the asset service) as a fallback for when clients inevitably get rate limited.

when we get an address from chain adapters, we currently need to specify a path

const address = await chainAdapter.getAddress({ wallet, path: "m/44'/60'/0'/0/0" })

most times this is the same default path. make the path a default param with the value above, and make it overridable

this is being captured in the bitcoin chain adapters branch

We are currently not showing any feedback to the user for basic trade errors, (ie: input value is less than min trade amount). We need to add some basic error handling for these states:

• User tries to trade an amount that is less than the minimum trade amount.
• User tries to trade more than their balance of that asset.
• User tries to trade, but their ETH balance does not cover the txFee.

https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-19.md

Copy the spec for ethereum and write all the functions needed by the interface but for BTC.

Bring over the swapper from platform-shared into lib

For example: getZrxQuote, buildZrxTx

Setup semantic release to do CI on merging to main

We will need something to get a call to get available assets using all swappers in the manager

There are going to be a few utility type functions that we want to share between packages in lib.

We don't want to define these within each package and they should live happily together.

Create a utils package within lib to host shared functions.

https://github.com/shapeshift/lib/pull/136/files#diff-c3f51ca8777f4cc6e6128ef417f7c38d87662e7413cd8471dfc9237b5685beb4R1-R17

this is not production ready and isn't the solution. we need to fork this repo and fix it.

I yolo'd the package version higher to get semantic release to publish.

It published based on the actually "semantic" versions it should.

Go back and change all the package.json versions to match the latest tag published on npm.

MrNerdHair convinced us this is correct so make the change now before it's called this everywhere

This was way more agro than I anticipated. I'd hoped it would only lint the merge commit message to main and develop, not every commit on a branch going into them.

It doesn't seem configurable to allow this behavior.

For discussion

pros

• extremely tidy commit messages
• enables automatic releases conforming to semantic versioning based on types of commits
• enables automatically generated changelogs
• can ignore merge commits, so we can merge develop into a PR to ensure it's up to date

cons

• requires all commits on a PR branch to confirm to the spec, or branches to be rebased/squashed to a single commit before PRing (not necessarily a bad thing)
• adds additional friction for new contributors
• may not be able to use github's super handy commit suggestion feature (TBD)

Implement method and tests

In order to sign an ETH tx, we need getAddress to return the addressNList. Currently, it only returns the address.

Implement method and tests

Implement method and tests

lint warnings should fail CI

We need docs that describe conventional commits: https://www.conventionalcommits.org/en/v1.0.0/

We also need a way to enforce conventional commits.

AC:

• Use unchained-client's ethereum websocket class and implement subscribeTxs using chain adapter generics setup

• Service to return supported asset list
• Return in format of current asset db layout.
• Start with getFullList() but make it generic enough to extend later.
• Unique identifier per asset should be same format that mikep came up with!

Implement method and tests

We already have a few shared types and enums between packages. These should belong in a shared/common package and will avoid circular dependencies in future.

Create a types package within lib and move things like ChainType NetworkType or Asset in there and fix in the imports in the other package.

sometimes it shows "asset service is not initialized"

also seeing this error:

GET http://localhost:3000/assets/bitcoin 404 (Not Found)

Implement method and tests

Implement method and tests

Implement method and tests

Implement method and tests

Implement getName method and tests

Background

Chain adapters are an abstraction layer that our applications use to hide chain specific functionality. Currently we have implemented a BitcoinChainAdapter that should be able to be made generic enough to be turned into a UTXOChainAdapter that supports all UTXO base chains (LTC, DOGE, etc)

This will require some modifications to inject chain specific dependencies via the constructor, and it's internal functionality. This will allow us to support many utxo chains in the future by instantiating a new instance of the adapter with appropriate constructor arguments.

Acceptance Criteria

• refactor the BitcoinChainAdapter to AbstractUTXOChainAdapter
• create concrete classes for BitcoinChainAdapter and DogecoinChainAdapter
• getType() should return the UTXO ChainType that is based on the arguments passed into the constructor.
• getCaip2() should return correct caip2 based on the UTXO passed into the constructor
• getAccount() returns a more generic promise type with a correct chain in the return object
• getTxHistory() returns a more generic promise type with a correct chain in the return object
• use slip44 coin types from the spec https://github.com/satoshilabs/slips/blob/master/slip-0044.md
• Add / modify unit tests for the new generic adapter
• Search for anywhere we are creating this chain adapter in a hard coded fashion would need to be updated.

See #289 as a reference to how this is being done for Cosmos.

Bounty Hunters

• This issue may take a bit of exploring to understand how this can be refactored in a generic fashion and the bounty amount hopefully reflects some time spent on that.
• Please refer to this link for some basic info
• Join our discord here
• Please include an expected timeline for you to complete work in the work plan when you apply for this bounty!