Emily API

Emily 是一个帮助促进并监督 sBTC 桥接的 API，作为 sBTC 用户与签名者之间的程序化联络人。

概览

Emily API 旨在跟踪存款和取款，提供有关正在进行的 sBTC 操作状态的信息。它服务于两类主要用户：sBTC 用户和 sBTC 应用开发者。

为什么称为 Emily？

Emily API 使用一个间接的名称，因为它处理的不仅仅是存款和取款；它还能检测系统的健康状况，并可能随着用户需求的成熟而扩展以处理更多功能。它曾被称为“Revealer API”，但在几次设计变更后这个名称不再合适，随后又称为“Deposit API”，几次变更后同样不再合适。最明显的选择“sBTC API”也会给出错误的印象，因为该 API 本身并不管理协议的全部内容。

大型公司常把其 API 命名为与之松散相关但足够模糊的名字，以便在扩展时不会让原始名称变得误导。基于此，我们选择了“Emily”，以纪念 Emily Warren Roebling，她在布鲁克林大桥的建造中担任建造者与首席工程师（她的丈夫）之间的联络人。实际上她是桥梁建设的监督者；类似地，Emily API 监督 sBTC 桥接并在协议用户与 sBTC 签名者之间进行联络。

主要功能

• 跟踪存款：监控将 BTC 转换为 sBTC 的过程。

• 跟踪取款：监控将 sBTC 转回 BTC 的过程。

• 提供操作状态：为正在进行的 sBTC 操作提供实时状态更新。

• 检索历史数据：允许查询过去的 sBTC 操作。

核心概念

sBTC 操作

sBTC 操作是 Emily 跟踪的基本流程：

• 存款：将 BTC 转换为 sBTC

• 取款：将 sBTC 转回 BTC

操作状态

每个 sBTC 操作都会经历几个状态：

• PENDING：操作已被发起。

• ACCEPTED：操作已被签名者批准。

• CONFIRMED：操作已完成并在区块链上确认。

• FAILED：操作无法完成。

Emily 在 sBTC 流程中的参与位置

在 sBTC 的每个存款和取款流程中，Emily 都发挥着重要作用。以下是 Emily 在存款和取款流程中的位置。

在存款流程中

1. 用户在比特币上创建一个存款交易

2. 用户向存款 API 提交存款证明

3. Emily 将该存款记录为 PENDING（待处理）

4. 签名者验证并对存款投票

5. 如果被接受，Emily 将状态更新为 ACCEPTED（已接受）

6. 签名者处理比特币交易

7. 签名者在 Stacks 上铸造 sBTC

8. Emily 将存款状态更新为 CONFIRMED（已确认）

在取款流程中

1. 用户通过 sBTC Clarity 合约发起取款

2. Emily 将该取款记录为 PENDING（待处理）

3. 签名者决定接受或拒绝该取款

4. 如果被接受，Emily 将状态更新为 ACCEPTED（已接受）

5. 签名者处理比特币交易

6. 签名者在 Stacks 上销毁 sBTC

7. Emily 将取款状态更新为 CONFIRMED（已确认）