概述

Embedded MPC Node 提供 iOS（Object-C & Swift）、Android 和 WASM 原生支持，接口设计几乎完全一致，方便开发者各端快速集成。API 主要通过 SMNTenantClient 、SMNECDSAClient 、SMNEdDSAClient 和 SMNSchnorrClient 四个类提供。

SMNTenantClient

SMNTenantClient 类，主要处理租户维度相关逻辑，如获取 SDK 版本信息、通信、本地私钥分片存储等。

创建 SMNTenantClient 实例

功能概述

初始化 SMNTenantClient 对象。如果参数符合要求，将会初始化并返回 一个 SMNTenantClient 实例，否则会抛出异常。

接口

参数

返回值

SMNTenantClient 类的实例

查看 SDK 版本号

功能概述

获取 Embedded MPC Node SDK 的版本号。

由于 MPC 计算需要多方参与，当其中一方协议出现不兼容更新时，开发者就需要考虑不同版本嵌入式 SDK 之间以及与服务端MPC Node Service 之间的兼容性问题，建议开发者在执行 MPC 协议时上报 SDK 版本号用于将来兼容性升级。

接口

参数

无

返回值

查看 Tenant 配置信息

功能概述

获取当前 SMNTenantClient 的基本配置信息。

接口

参数

无

返回值

查看 Tenant 的 Party ID

功能概述

获取当前 SMNTenantClient 的 Party ID。该 ID 源自于首次创建 SMNTenantClient 对象的配置文件中的配置。

接口

参数

无

返回值

number

查看 Tenant 的 TPK

功能概述

获取当前 SMNTenantClient 的 Tenant Public Key(TPK)。在创建 SMNTenantClient 对象实例时，随机生成一个非对称密钥对（即 Tenant Private Key 与 Tenant Public Key）。在 MPC 计算过程中以及和 Relayer 通信鉴权时会使用此密钥对。

接口

参数

无

返回值

string

查看 Tenant 本地 Party

功能概述

获取当前 SMNTenantClient 的 Party 信息，包含 Party ID 和 TPK。

接口

参数

无

返回值

修改本地数据密钥

功能概述

修改加密本地数据的密钥，该加密密钥为不包含 0x 前缀的 64 位十六进制字符串。修改成功后， 后续初始化 SMNTenantClient 需要使用新密钥，否则初始化失败。

接口

参数

返回值

设置 Relayer Token 回调函数

功能概述

设置获取 Relayer Token(OTT)的回调函数。当 Embedded MPC Node 参与 MPC 计算时，需要与 SMN Relayer 建立网络连接，和其他参与方实时通信。SDK 自动调用此函数获取一次性 Token(OTT)， 在与 SMN Relayer 连接认证时使用。

接口

参数

其中：

• partyId: 当前 SMNTenantClient 的 Party ID

• tpk: 当前 SMNTenantClient 的 TPK

返回值

自定义 MPC 消息通信方式

功能概述

默认情况下，在进行 MPC 计算的过程中， Embedded MPC Node 和其他参与方通过 SMN Relayer 进行通信，同时可使用此方法设置自定义通信方式，如同一个应用终端内集成两个及以上的 SMNTenantClient 时， 可配合 postMessage 接口，实现多个 SMNTenantClient 直接通信，以提升 MPC 协议执行速度。

接口

参数

返回值

无

SMNTenantClient 间直接通信

功能概述

一般情况下，此方法与 addSendMessageCallback 配合使用。当一个应用终端内集成两个及以上的 SMNTenantClient 时，这些 SMNTenantClient 之间无需通过 Relayer 通信。

接口

参数

返回值

无

算法 API

• SMNECDSAClient 类提供了 MPC-CMP 协议相关协议和辅助函数。

• SMNEdDSAClient 类提供了 Lin22 相关协议和辅助函数。

• SMNSchnorrClient 类提供了 Lin22 协议相关协议和辅助函数。

创建算法 Client 实例

功能概述

创建一个算法的 Client 实例，使用该实例完成特定算法的 MPC 计算。

接口

参数

返回值

object - 算法 Client 实例对象，类型为 SMNECDSAClient、SMNEdDSAClient 或者 SMNSchnorrClient

获取本地 Party

功能概述

获取本地 Party 信息，包含 Party ID 和 TPK。

接口

参数

无

返回值

generatePreKeygenData

功能概述

生成本地私钥分片对应的预计算数据，该方法为静态方法，不需要初始化 SMNECDSAClient 实例。主要应对用户的租户尚未初始化的情况下，需要生成预生成数据的场景，返回预计算数据字符串。此方法与 addPreKeygenData 搭配使用。仅 ECDSA-CMP 算法支持此接口。

接口

参数

仅 JS SDK 需要以下参数，Android 和 iOS SDK 无参数

返回值

string - 生成的预计算数据

addPreKeygenData

功能概述

向 SMNECDSAClient 对应的 SMNTenantClient 存储中添加 MPC 预计算生成的数据。仅 ECDSA-CMP 算法支持此接口。

接口

参数

返回值

boolean 是否添加成功

preKeygen

功能概述

在分布式私钥生成的过程中，各方 Party 在本地创建私钥分片时会进行大量耗时计算，调用本接口后会预生成一个本地私钥分片对应的预计算数据，从而减少执行 keygen/recover/refresh 时的耗时。该方法需要在 keygen/recover/refresh 创建私钥分片之前调用，并且返回 true 为预计算成功。该方法可以执行多次，每次执行成功都会加密存储一份预计算数据。每次执行 keygen/recover/refresh，无论协议计算成功失败都会消耗一份存储的预计算数据。仅 ECDSA-CMP 算法支持此接口。

接口

参数

无

返回值

boolean

getPartyId

功能概述

获取当前 SMNTenantClient 的 Party ID。

接口

参数

无

返回值

number

getTpk

功能概述

获取当前 SMNTenantClient 的 TPK。

接口

参数

无

返回值

string

keygen

功能概述

该方法用于分布式私钥分片生成，需要所有参与方 MPC Node 同时调用 keygen 方法，MPC Node 接收到 keygen 指令后，根据 sessionId  和远程参与方启动本次 MPC 任务，如果 MPC 计算执行成功，则返回 keyId 和 xPub，其中 keyId 为私钥分片的标识，xPub 为扩展公钥。如果计算失败，则抛出错误信息。

注意：

• 该方法是线程不安全的，当需要执行多次 keygen 时，需要等待上一次 keygen 结束后再执行下一次 keygen

• 由于 MPC 计算是分布式计算，可能会出现服务端先完成计算或者客户端先完成计算的情况，因此建议开发者在进行下一步业务逻辑之前，通过开发者后端服务判断，是否所有参与计算的 Node 都完成计算并且取得相同的 keyId 和 xPub，判断相同后再进行后续步骤；其他协议如 sign、recover、refresh 需要进行类似判断

例如：手机端和服务端构建 MPC 钱包，服务端收到 keyId 和 xPub 后判定私钥分片创建成功，进入后续创建钱包逻辑，此时客户端由于网络问题最后一轮计算失败，本地未得到私钥分片。如果此时钱包功能正常，用户使用钱包进行转入操作，转出时由于本地私钥分片不存在造成无法签名转账，从而造成用户资产损失。

接口

参数

返回值

sign

功能概述

该方法用于私钥分片的分布式签名，需要所有签名参与方 MPC Node 同时调用 sign 方法，如果 MPC 任务执行成功，则返回对应响应参数，如果计算失败，抛出具体的错误信息。

注意：

• 该方法是线程不安全的，当需要执行多次 sign 时，需要等待上一次 sign 结束后再执行下一次 sign

接口

参数

返回值

Array<object>

refresh

功能概述

该方法用于私钥分片的分布式刷新。

示例说明：对于 2/3 门限，需要 3 方同时调用 refresh 方法，当 MPC Node 收到 refresh 指令后，3 方的私钥分片全部都会刷新，得到一组新的私钥分片和对应新的 keyId。如果刷新失败，则抛出异常，需要重新触发刷新。老的私钥分片依然可用，开发者根据自己的业务决定禁用或者删除老的私钥分片。

注意：

• 该方法是线程不安全的，当需要执行多次 refresh 时，需要等待上一次 refresh 结束后再执行下一次的 refresh。

接口

参数

返回值

recover

功能概述

该方法用于私钥分片的分布式恢复，仅支持 2/3 门限场景。对于 2/3 门限，使用其中两个私钥分片恢复另外一个私钥分片，需要 3 方同时调用 recover 方法。根据输入的 sessionId 对当前计算任务达成共识，所有的参与方都必须输入 keyId，即使本地私钥分片不存在的的参与方，也需要输入 keyId。其中 recoveredParty 表示需要恢复私钥分片的一方。恢复成功后得到一组新的私钥分片和对应新的 keyId，老的私钥分片依然可用，开发者根据自己的业务决定禁用或者删除老的私钥分片。

注意：

• 该方法是线程不安全的，当需要执行多次 recover 时，需要等待上一次 recover 结束后再执行下一次 recover

接口

参数

返回值

verify

功能概述

给定公钥、消息摘要、签名，验证签名是否是一个有效的签名。如果验证有效返回 true，否则返回 false。

接口

参数

返回值

boolean 代表是否验证成功

derivePublicKeys

功能概述

扩展公钥派生子公钥。当创建钱包时，需要使用子公钥根据不同公链的地址生成算法计算地址。

接口

参数

返回值

Array<object>

recoverPublicKey

功能概述

给定摘要、签名和 recoveryId，恢复公钥。仅 ECDAS-CMP 算法支持此接口

接口

参数

返回值

string 恢复出来的公钥

recoverPrivateKeys

功能概述

输入私钥分片数组和指定的 BIP44 路径数组，恢复出对应的原始私钥和公钥，其中输入的私钥分片数量需要等于签名门限，否则无法恢复私钥。需要特别注意，输入的分片数组仅支持以下场景：

假设签名门限 2/3，一组私钥分片 KeyId 为 1，三个参与方 Party 1、2、3 分别对应的私钥分片为 A、B、C；使用 A、B 执行分布式恢复协议，得到一组新的 KeyId 为 2，三个私钥分片为 A'、B'、C'；使用 A、B、C 执行分布式刷新协议，得到一组新的 KeyId 为 3，得到 A*、B*、C*

（1）支持使用 A、B、C 中任意两个参与方的私钥分片

（2）支持使用 A'、B'、C' 中任意两个参与方的私钥分片

（3）支持使用 A*、B*、C* 中任意两个参与方私钥分片

（4）支持  A、B、C 和  A'、B'、C' 中任意两个参与方私钥分片，比如 A 和 B' 、A 和 C' 、B 和 A' 、B 和 C' 、B 和 A'、C 和 A'、C 和 B'

（5）不支持经过分布式刷新后的私钥分片和其他 KeyId 私钥分片合成原始私钥

接口

参数

返回值

Array<object>

backup

功能概述

备份私钥分片，该方法返回未加密的私钥分片内容，开发者在使用和存储时应注意安全。强烈建议开发者备份私钥分片时加密存储，避免私钥分片数据泄漏。

接口

参数

返回值

restore

功能概述

恢复私钥分片，该方法将私钥分片明文导入到 SMNTenantClient 实例内。

接口

参数

返回值

keyInfo

给定私钥分片 keyId，获取私钥分片的可公开部分信息。

接口

参数

返回值

listKeys

功能概述

查询 keyId 列表，默认按照创建时间降序查询。

接口

参数

无

返回值

Array<object>

deleteKey

功能概述

指定 keyId，物理删除指定的私钥分片，一旦删除不可恢复。删除成功返回 true，失败返回 false。

接口

参数

返回值

boolean 是否删除成功

文档变更记录

2024-07-04 1.2.0 版本更新

• 增加 getParty 接口

• 丰富 restore 接口返回值

• keygen 接口门限参数更新说明