shapeshift / unchained Goto Github PK

AC:

• Veryify working coinstack locally (init.sh, readiness.sh)
• Deploy to personal aws account
• Update .circleci/config.yml to deploy develop and production public coinstacks

Steps:

• Verify indexer.daemon.chain (specified in your copy of coinstacks/ethereum/pulumi/Pulumi.sample.yaml) parameter works correctly to deploy a local kubernetes instance of an ethereum ropsten coinstack
  • There will be pulumi resource naming conflicts that need to be handled. It would make the most sense to update the asset name in coinstack/ethereum/pulumi/index.ts to append the chain type if it is not mainnet.
• Ensure signal catching works correctly still as defined in coinstacks/ethereum/daemon/init.sh (should work the same as mainnet node)
• Ensure readiness check works as defined in coinstacks/ethereum/daemon/readiness.sh (should work the same as mainnet node)
• Deploy and sync ethereum ropsten coinstack to personal aws account
• Update .circleci/config.yml with jobs to deploy ethereum ropsten coinstacks to the develop and production environments, specifying the correct daemon-chain paramter

The BTC chain adapter currently fetches network fee estimations from bitcoinfees.earn.com. This is effective, but fragile in the case of unforeseen external service interruptions. Unchained should provide BTC fee estimates via API call, with the network fees determined independently, without the use of any external service. For reference, look at how BTC fees are estimated in Watchtower.

Each exchange is just a string and the returned message is just a blob of data. It would be nice to wrap the exchange with the messages to be able to type the interaction with rabbit during the ingestion pipeline.

AC:

• Wrap/abstract rabbit functionality to ensure typing for each exchange (input data) and queue (output data) payloads

How to add a new chain. Note - this template is only a guide. Each chain is different so make changes to the plan as neccesary

Daemon

• Spike: Select a blockchain daemon.
• Update the Pulumi infra code, add init.sh and readiness.sh scripts
• Deploy

Indexer
The Indexer maintains an index of transaction history by address. Most nodes don't do this so a separate database is needed.

• Spike: Select an indexer. For UTXO and EVM chains, use Blockbook. For Cosmos chains (Cosmos, Binance, Thorchain) use the node
• Update the Pulumi infra code
• Deploy

API
The API is an adapter layer to the Indexer that provides a consistent set of endpoints for the ShapeShift client. Implement these endpoints using Bitcoin & Ethereum as a reference

• /account{pubkey}
• /account/{pubkey}/txs
• /account/{pubkey}/utxos
• /send

Ingester
The Ingester filters new transactions and sends only the relevant ones to each client

• Get new blocks (ws)
• Get transactions from mempool (ws)
• Get transactions from confirmed blocks
• Filter for transactions for addresses in the registry
• Handle reorgs
• Delta sync on register
• Delta sync on new transaction
• Client web sockets

Tests - Ingester

• newBlock worker: Block Reorg
• Tx worker: Delta sync
• Tx worker: parseTx
  (TODO: add more tests)

Get new blocks from the node and put them in the txid queue

We don't need to be checking in all of the generated code, but we do want to ensure the most recent generated code in a few circumstances.

• coinstacks/api/src/routes.ts does not need to be tracked. this is automatically generated on yarn build and kept up to date during development. We run yarn build and persist the workspace in CircleCI, so we will have the routes available for deployed image.
• coinstacks/api/src/swagger.json should be tracked. There is currently a pre-push hook that runs generate, but it is easy to miss the update and merge without actually committing the most recent swagger. It would be ideal to pull this out so that on merge, we run generate on the project and commit any swagger changes before merge to ensure they are up to date in the repository.
• packages/client/src/generated does not need to be tracked. We should set up a way to handle hot regeneration of the client for development. Right now publishing is manual, we will want to generate and publish this package after deployment of coinstacks.

AC:

• Support cluster autoscaling so we don't have to manually scale as we continue to add new chains

Instead of manually managing snapshotting and restore, we want this to be an automated process.

https://aws.amazon.com/blogs/containers/using-ebs-snapshots-for-persistent-storage-with-your-eks-cluster/

AC:

• Automate snapshotting on a regular schedule
• Restore stateful set from snapshot if brand new
• Clean up old snapshots to avoid burning $$$

Unchained thorchain ingester

• Due to the concurrent nature of the ingestion pipeline, transactions history can propagate to the client out of order.
• This coincides with the need for a client to be able to pick back up sync at a specific block number as determined by their database state

AC:

• Ensure a client can pick up syncing from where it last left off and not be worried about any missing transaction history

We need a Blockbook instance in production. Use Pulumi to deploy to the open-source/public production cluster.

From address is an optional argument that can be sent to the estimateGas call and may have implications on the estimated gas cost returned.

AC:

• Support a from query paramter for estimateGas endpoint

AC:

• Create and export client package (unchained-client)

CI flow should support multiple deployments as a precursor to implementing a blue/green deployment strategy.

AC:

• Export necessary types used in server class from ingester
• Abstract server class out into common/api that can be used across stacks

Add thorchain client to unchained using swagger definition if we can find one

or use one from npm if cant find a good swagger

or write custom client class is none of those exist

Acceptance criteria:
Correctly extract addresses from special txs such as:

• coinbase transactions (no input)
• op return (no output)

We don't have the ability to view logs of a pod that is no longer running. We need a way to collect and store a rolling window of logs for analysis.

We need a getTransaction endpoint to grab transaction data, and whatever else that is needed by chain-adapters to send Bitcoin transactions.

Spike: Adding Cosmos

1. Scope the work needed and document an implementation plan in the comments on this issue
2. Who will do the work
3. Estimate how long it will take to complete
4. Challenges or other considerations that are unique to this chain
5. Create Github issues to track the work

Use the following checklist as a guide:

Chain Addition Checklist

Daemon

• Spike: Select a blockchain daemon.
• Update the Pulumi infra code, add init.sh and readiness.sh scripts
• Merge and deploy to public endpoints

Indexer
The Indexer maintains an index of transaction history by address. Most nodes don't do this so a separate database is needed.

• Spike: Select an indexer. For UTXO and EVM chains, use Blockbook. For Cosmos chains (Cosmos, Binance, Thorchain) use the node
• Update the Pulumi infra code
• Merge and deploy to public endpoints

API
The API is an adapter layer that provides a consistent set of endpoints for the ShapeShift client. Implement these endpoints using Bitcoin & Ethereum as a reference

• /account{pubkey}
• /account/{pubkey}/txs
• /account/{pubkey}/utxos
• /send

Ingester
The Ingester filters new transactions and sends only the relevant ones to each client

• Get new blocks (ws)
• Get transactions from mempool (ws)
• Get transactions from confirmed blocks
• Filter for transactions for addresses in the registry
• Handle reorgs
• Delta sync on register
• Delta sync on new transaction
• Client web sockets

**Tests **
Ingester:

• newBlock worker: Block Reorg
• Tx worker: Delta sync
• Tx worker: parseTx

Examine traffic levels since the launch of the public api.ethereum.shapeshift.com endpoint, determine if it would be prudent to implement ingress throttling, and implement if so.

The ingester_meta object is not being sanitized or passed through completely on registration which results in always syncing from block 0.

AC:

• Sanitize addresses in ingester_meta object in the same way as the address array
• Allow sync to start from a block determined by client

Both the Socket and Worker classes were abstracted into the common ingester package but left process.env artifacts.

These were recently moved into the constructor to allow publishing of the package without failing on import without env vars set as a quick fix.

This should really be updated to pass in the values in the constructor to be configurable more correctly.

Follow the Ethereum spec and deploy an API to production. Add tests with chain-adapters.

Acceptance Criteria:

1. When the ingester detects a new transaction on a watched address, it performs a delta sync (since the last known transaction) and sends to the address exchange for parsing. The reason for the delta sync is to fill in the gaps for any missed transactions that might have occurred

There is currently only a single rabbitmq sts deployed for each coinstack which will result in down time whenever kube nodes roll. It would be best if we could update to use a rabbitmq cluster or replica set deployment, similar to mongodb

Acceptance Criteria:

• Identify Thorchain swaps to/from Bitcoin
• Attach trade meta-data before sending to the client

Instead of lots of flat endpoints like /balance, /utxos, etc., use a more resource driven restful design pattern like:

/account/{pubkey}
/account/{pubkey}/txs
/account/{pubkey}/utxos
/gas/estimate
/gas/price

AC:

• Single websocket per client_id
• Handle exchange/queue management
• Support subscribe/unsubscribe/update methods
• Support txs topic

Change the favicon and page title so the browser tab shows as a ShapeShift page, rather than "Swagger UI".

See screenshot and arrow for more clarity about what needs to change.

Ideally the favicon and css would live in the coinstacks/common/api so that it can be referenced by each coinstack moving forward. We are using https://github.com/scottie1984/swagger-ui-express to generate the swagger doc ui which allows for custom styling options to be passed in.

Ideally the favicon and css would live in the coinstacks/common/api so that it can be referenced by each coinstack moving forward. We are using https://github.com/scottie1984/swagger-ui-express to generate the swagger doc ui which allows for custom styling options to be passed in.

Does what it says on the box.

Please involve community members and have them shadow you when completing this ticket, such that they are able to add more arbitrary chains in future.

Spike: Adding more UTXOs

1. Scope the work needed and document an implementation plan in the comments on this issue
2. Who will do the work
3. Estimate how long it will take to complete
4. Challenges or other considerations that are unique to this chain
5. Create Github issues to track the work

https://github.com/pusher/k8s-spot-termination-handler

Currently, spot inst termination signals are not caught and handled resulting in corrupted dbs during sync if nodes churn.

AC:

• Handle spot termination signal and gracefully shutdown pods

AC:

• Remove default client_id and allow individual unique client ids
• Allow registration of many addresses for a client id

Currently all errors are being treated as axios errors, but this is an incorrect assumption and we should ultimately use proper type checking on errors (treating err as unknown) so we handle all error types correctly

We need a Bitcoin node in production. Use Pulumi to deploy a stack to the open-source/public production cluster.

The API is an adapter layer that provides a consistent set of endpoints for the ShapeShift client. Implement these endpoints using Bitcoin & Ethereum as a reference

/account/{pubkey}
/send

We need to deploy a Bitcoin Ingester to the open-source/public production cluster. Consult with @kaladinlight prior to starting ticket.

AC:

Veryify working coinstack locally (init.sh, readiness.sh)
Deploy to personal aws account
Update .circleci/config.yml to deploy develop and production public coinstacks
Steps:

Verify indexer.daemon.chain (specified in your copy of coinstacks/ethereum/pulumi/Pulumi.sample.yaml) parameter works correctly to deploy a local kubernetes instance of an ethereum ropsten coinstack
There will be pulumi resource naming conflicts that need to be handled. It would make the most sense to update the asset name in coinstack/ethereum/pulumi/index.ts to append the chain type if it is not mainnet.
Ensure signal catching works correctly still as defined in coinstacks/ethereum/daemon/init.sh (should work the same as mainnet node)
Ensure readiness check works as defined in coinstacks/ethereum/daemon/readiness.sh (should work the same as mainnet node)
Deploy and sync ethereum ropsten coinstack to personal aws account
Update .circleci/config.yml with jobs to deploy ethereum ropsten coinstacks to the develop and production environments, specifying the correct daemon-chain paramter

Currently the only notion of network is in the pulumi config under the daemon resource. This needs to be a more overarching idea for a coinstack that can be used in the pulumi iac as well as reference and returned from the app as an env var.

AC:

• Don't attach chain network type to the daemon configuration, but instead configure it at the top level (important also if using a hosted node instead of own dedicated node)
• Support chain network in .env that can be reference within the app (both docker-desktop or kube)
• Add getNetwork() endpoint to the BaseAPI and support in current coinstacks

Spike: Adding Thorchain

1. Scope the work needed and document an implementation plan in the comments on this issue

2. Identify challenges or other considerations that are unique to this chain

3. Task breakdown & create Github issues to track the work

4. 2. Who will do the work

5. Estimate how long it will take to complete

Thorchain specific:

• start with balance, rune sends and receives before adding chain-specific features like swaps, etc

Thorchain Addition Checklist

Daemon

• Update the Pulumi infra code, add init.sh and readiness.sh scripts
• Thornode - both REST & WebSocket ports open
• Midgard API
• Merge and deploy to public cluster
• more steps tbd

Indexer
The Indexer maintains an index of transaction history by address.

• For Thorchain, use the node (daemon)

API
The API is an adapter layer that provides a consistent set of endpoints for the ShapeShift client. Implement these endpoints using Bitcoin & Ethereum as a reference

• /account/{pubkey}
• /account/{pubkey}/txs (deferred for Thorchain, get tx history from WebSocket during account sync)
• /send
• fees endpt

Ingester
The Ingester filters new transactions and sends only the relevant ones to each client

• Get new blocks (WebSocket)
• Get transactions from mempool (WebSocket)
• Get transactions from confirmed blocks
• Filter for transactions for addresses in the registry
• Handle reorgs
• Delta sync on register
• Delta sync on new transaction
• Client web sockets
• Thorchain specific - parse trade details

**Tests **
Ingester:

• newBlock worker: Block Reorg
• Tx worker: Delta sync
• Tx worker: parseTx

This needs to be discussed and scoped out by @kaladinlight before work starts.

Please update the ticket with acceptance criteria when it's known.

Acceptance Criteria:

1. The ingester registers an address from the client, scans all new mempool and confirmed transactions and puts them in the output message queue for client to consume (via websocket eventually)