[Design]: Deposit API LLD

[AshtonStephens]

Design - Deposit API LLD

Ownership breakdown: #47

• Primary: Ashton (@AshtonStephens )
• Secondary: Joey (@xoloki)
• reviewer: Jesus (@setzeus)

This ticket tracks creating the low level design document for the deposit api. For a low level design to be "complete" it must have the approval of the majority of the sBTC team and meet the criteria of the checklist below.

• Deposit API Design Doc

Related Research

• Deposit API
  • [Research]: Deposit API Service (formerly Revealer API) #18
  • [Design]: Deposit API #41
• Deposit Flow
  • [Design]: sBTC Deposit #15
  • [Research]: Deposit Attack Vectors #23
  • [Design]: sBTC Operation Clarity Contract Fees #45
• Withdrawal Flow
  • [Design]: sBTC Withdrawal #16
• Clarity Info
  • [Design]: sBTC Clarity Readonly Parameters (draft) #24
  • [Design]: Deposit Flow Clarity LLD #56
  • [Research]: Withdrawal Script #17

Acceptance Criteria Checklist

• There's a written low level design doc with the following
  • Clear descriptions of all component interactions including serialization format
  • Diagram/s on how the component will work
  • Clear descriptions of the programming languages and infrastructure that will be used
  • Justifications for the design decisions
  • A rough task breakdown of the component's implementation plan referencing inter-dependencies
  • A general list of the of tests required for the component
• Low level design has been reviewed and approved with the secondary.
• Low level design has been reviewed and approved with the team.
• The task breakdown is refined with GitHub issues for each task

[AshtonStephens]

@xoloki @setzeus, I'm looking at some updated API queries for the Deposit API. What are our thoughts on this:

Create Deposit Request

Name	Datatype	Meaning
txid	String	Bitcoin transaction id
output-index	Int	Bitcoin transaction output index for the deposit.
deposit-script	String	The deposit taproot script that pays to the sBTC Bootstrap Signers.
reclaim-script	String	The reclaim taproot script that allows the depositor to take the Bitcoin they attempted to deposit back.

What other information does the deposit API need to assess whether the deposit-script and the reclaim-script are the full taproot script tree?

• [Research]: Deposit Attack Vectors #23

[AshtonStephens]

Created and closed this ticket today, where I created a proof of concept local development environment for a lambda-backed CDK-deployed API Gateway instance.

• [Research]: Running AWS Infrastructure Locally #61

[AshtonStephens]

Closing out