Interledger(ILP)Javascript分类帐插件接口版本2

Javascript分类帐插件接口版本2

Interledger协议是用于跨多个不同结算系统进行支付的协议套件。

该规范为Interledger客户端和连接器定义了一个JavaScript分类帐抽象接口，用于跨不同分类帐协议进行通信和路由支付。虽然这里定义的确切方法和事件是JavaScript实现特有的，但它可以用作其他语言的分类帐抽象的指南。

要通过新分类账发送ILP付款，必须实施一个分类账插件，该分类账插件公开以下定义的接口。这可以与ILP客户端和连接器一起使用，并且应该可以直接使用。

这个规格取决于ILP规范。

类：LedgerPlugin

class LedgerPlugin

方法

	名称
new	LedgerPlugin（opts，api）
	connect（options ）⇒ Promise.
	disconnect（）⇒ Promise.
	isConnected（）⇒ Boolean
	sendData（options ）⇒ Promise.
	sendMoney（amount ）⇒ Promise.
	registerDataHandler（dataHandler）⇒ undefined
	deregisterDataHandler（）⇒ undefined
	registerMoneyHandler（moneyHandler）⇒ undefined
	deregisterMoneyHandler（）⇒ undefined

常量

	名称
static	版本 = 2

活动

名称	处理器
connect	( ) ⇒
connect	( ) ⇒
error	( ) ⇒

实例管理

新的LedgerPlugin

new LedgerPlugin( opts : object, api? : PluginServices )

创建一个插件的新实例。每个实例通常对应于不同的分类账。然而，一些插件可能偏离严格的一对一关系，并可能在内部充当一个以上对手的虚拟连接器。

第一个参数opts是一个配置对象，其形状是每个插件特有的。插件通常会通过环境变量进行配置，所以建议opts应该使用JSON序列化。但是，插件可能使用不可序列化的值来提供高级功能。

第二个参数api是可选的，用于将附加环境服务传递给插件，例如记录器或键值存储。大多数插件应该工作，即使这个参数是undefined，但可能会提供较少的功能（例如没有持久性）。

InvalidFieldsError如果构造函数被赋予不正确的参数，则抛出opts。抛出TypeError如果opts不是对象或被api定义而不是对象。抛出InvalidServicesError如果需要服务，但不提供通过api。

参数

名称	类型	描述
OPTS	PluginOptions	包含分类帐相关设置的对象。可能包含特定于插件的字段。

例

const  ledgerPlugin  =  new  LedgerPlugin（{

  // auth参数由插件定义

  _Store ： {
     //可能需要持久性内部使用一些分类帐插件
    //（例如，当系统中有降低的备忘录功能，我们只能把在备忘录的ID）
    //存储密钥下的值
    put：（key，value）=> {
       //返回Promise。
    }，
    
    get ：（ key） => {
       //返回Promise。