Model API Types for Transactions in Servant

[Anviking]

Context

Adding support for transactions. In a separate issue (to be created), Transaction-related types will be introduced inside WalletLayer. This ticket is about modeling this functionality on the API-level — creating wrapping types, JSON instances, etc.

• Cf https://github.com/input-output-hk/cardano-wallet/wiki/Roadmap#submit-transactions for some additional details

• The API we want to implement is described by our swagger spec https://raw.githubusercontent.com/input-output-hk/cardano-wallet/master/specifications/api/swagger.yaml

• Note: The API layer is under construction in Translate the Swagger API specification into a Servant API specification. #53 as of currently

Decision

Add wrapping Transaction-related API types, and extend our Servant API with handlers.

Acceptance Criteria

1. The API must support creation of transactions according to the API Swagger specification https://raw.githubusercontent.com/input-output-hk/cardano-wallet/master/specifications/api/swagger.yaml
2. The added code should be consistent with existing API Layer code (likely from Translate the Swagger API specification into a Servant API specification. #53 )

---

Development Plan

• I plan on adding new transaction endpoint to the Cardano.Wallet.Api module
• I plan on adding missing argument types (Payment, TransactionOutput) to Wallet.Api.Types module
• I plan on adding missing return type (Transaction). This type looks a lot a like transaction meta which will be added by Compute metadata for transaction #101
• I plan on adding json roundtrip test for arguments and return type
• I plan to remove swagger object renaming rules Add servant post transaction endpoint #111 (comment)
• I plan to increase number of samples for tx status golden test Add servant post transaction endpoint #111 (comment)
• I plan to document types better Add servant post transaction endpoint #111 (comment)
• TODO: check whether there are other tests that can increase coverage

PR

Number	Base
#111	master
#139	master
#184	master

QA

• API definition is now complete for transaction creation: cf Cardano.Wallet.Api

• Corresponding API representations have corresponding golden tests roundtrips in Cardano.Wallet.Api.TypesSpec

• We do also check that the servant definition matches the API specification (cf: here)

• The handler's implementation is currently untested but will be as part of Extend cardano Wallet CLI with selected commands #96 or Extend Wallet Layer to Support Transaction Creation #95

[KtorZ]

@akegalj I believe we can put this one in QA now right?

[akegalj]

@akegalj I believe we can put this one in QA now right?

yes - its ready

[piotr-iohk]

lgtm 👍