topl / daml-on-bifrost Goto Github PK

h3. Summary

Sending and receiving transactions to a Bifrost node requires checks to make sure the output matches the Daml transaction and to properly

h3. Acceptance criteria

┆Issue is synchronized with this Jira Task by Unito

Summary

Automated integration testing and deployment would benefit from having Docker images automatically generated from the CI for every PR and release. A Github Actions workflow should be added to the project to push a new Docker image to Docker Hub and the Github Container Registry.

Acceptance criteria

• A new snapshot is pushed for every successful merge into dev
• A new release is pushed for every tag

┆Issue is synchronized with this Jira Task by Unito

┆Issue is synchronized with this Jira Task by Unito

Summary

The path to minting and transferring assets on-chain use an implementation of a specific AssetTransfer function under a defined Topl module. This DAML smart contract module should be placed into a public repository

Acceptance criteria

┆Issue is synchronized with this Jira Task by Unito

Statement of Problem

Acceptance Criteria

┆Issue is synchronized with this Jira Task by Unito

h3. Summary

The participant node standard routes use a common set of queries to store log and metadata information. The implementation of these queries differs slightly between database implementations. To match the in-memory and PostgreSQL implementations, MongoDB needs to recreate all common queries provided in the DAML SDK and be tested to make sure all queries execute correctly.

h3. Acceptance criteria

• Define the set of queries needed to run against a MongoDB database
• Create a mock MongoDB database for testing
• Unit tests for all queries

┆Issue is synchronized with this Jira Task by Unito

┆Issue is synchronized with this Jira Task by Unito

┆Issue is synchronized with this Jira Task by Unito

Statement of Problem

Having a visual representation of the different interactions between Bifrost, daml-on-bifrost, and Daml smart contracts would be useful for internal and external contributors. An example with “NuCarbit”, a fake company producing and tokenizing carbon credits, can go into enough depth to realistically show how a real company or developer might use Daml smart contracts to control minting and transferring assets. The example can also show some of the privacy aspects of how state in a Daml smart contract is displayed to different users of the smart contract.

Acceptance Criteria

┆Issue is synchronized with this Jira Task by Unito

h3. Summary

Currently Daml supports PostgreSQL, SQLite, and H2. Having the daml-on-bifrost implementation use MongoDB would be helpful for integrating event-sourcing and testing with other Topl services and tools. MongoDB should be implemented to be fully compliant with the events and calls being made to any SQL server, and should fully replicate the behavior of the H2 in-memory database or a PostgreSQL server.

h3. Acceptance criteria

• A MongoDB reference implementation to store contracts as documents
• Implement the API fully to support contract creation and update calls from the Ledger API

┆Issue is synchronized with this Jira Task by Unito

┆Issue is synchronized with this Jira Task by Unito

┆Issue is synchronized with this Jira Task by Unito

Summary

As unit tests are being written, an automated CI/CD pipeline should be set up to run the unit tests and force checks on pull requests.

Acceptance criteria

• A simple Github Actions workflow is created to run all unit tests
• The workflow runs on all pull requests made to the dev and main branches

┆Issue is synchronized with this Jira Task by Unito

h3. Summary

Running a Daml participant node/driver requires a connection to a ledger, either a sandbox or full blockchain. To help with testing and application version management.

h3. Acceptance criteria

• A Docker compose file to start a participant node and a Bifrost node, and check for a successful connection from the participant node to the Bifrost node using an API call

┆Issue is synchronized with this Jira Task by Unito

┆Issue is synchronized with this Jira Task by Unito

h3. Statement of Problem

For testing and running in a local sandbox environment, a separate set of validators should be created to replicate the updates from Bifrost transactions that are either sent or mocked responses from a Bifrost node.

h3. Acceptance Criteria

• A validator that can accept mock transaction responses
• Unit test for sending mock transactions to the validator and checking the result is a valid update

┆Issue is synchronized with this Jira Task by Unito

┆Issue is synchronized with this Jira Task by Unito

1. Summary
   Daml provides a Ledger API Test Tool that has a suite of contracts to test against a live ledger. Incorporating this into a CI/CD pipeline will help to continually test the Bifrost driver against the Ledger API and make it easier to incorporate integration testing.
2. Acceptance criteria

• A Github Actions workflow that downloads and uses the Ledger API Test Tool to run against the driver and Bifrost node

┆Issue is synchronized with this Jira Task by Unito