@adamsoffer/3box 中文文档教程

Question

< a href="#install">安装 | 用法 | 例子 | 数据标准 | API 文档

3box-js

这是一个允许您设置、获取和删除与以太坊帐户关联的私人和公共数据的库。 使用支持 web3 的浏览器的 dapp 可以使用它来存储身份数据、用户设置等。 只要用户可以访问所用以太坊帐户的私钥，就可以检索数据。 数据经过加密处理，任何未经用户授权的第三方均无法读取。 默认情况下，所有授权 dapps 访问的数据有一个共享空间，然后 dapps 必须请求明确同意访问的空间。

Getting Started

Installation

在您的 npm 项目中安装 3box：

$ npm install 3box

Usage

Import 3Box into your project

导入 3box 模块

const Box = require('3box')

在您的 html 代码中使用 dist 构建导入

<script type="text/javascript" src="../dist/3box.js"></script>

或选择从 unpkg CDN 加载远程副本。

<!-- The most recent version  -->
<script src="https://unpkg.com/3box/dist/3box.js"></script>
<!-- The most recent minified version  -->
<script src="https://unpkg.com/3box/dist/3box.min.js"></script>
<!-- Load specific versions by specifying the version as follows -->
<script src="https://unpkg.com/3box@<version>/dist/3box.js"></script>

Profiles API

Get the existing public profile of an address (or DID)

3Box 允许用户为其以太坊地址创建一个公共配置文件。 在你的 dapp 中，你可能有多个以太坊地址，你希望为这些地址显示名称、图像和其他基本社交元数据。 getProfile 方法允许您获取任何以太坊地址（如果有的话）的公开资料。 这是一个静态 方法，因此您可以直接从Box 对象调用它。

const profile = await Box.getProfile('0x12345abcde')
console.log(profile)

Update (get, set, remove) public and private profile data

3Box 允许应用程序创建、读取、更新和删除存储在用户 3Box 中的公共和私有数据。 要启用此功能，应用程序必须首先通过调用 auth 方法对用户的 3Box 进行身份验证。 此方法提示用户对您的 dapp 进行身份验证（登录）并返回带有 threeBox 实例的承诺。 您只能更新（设置、获取、删除）已通过身份验证并当前正在与您的 dapp 交互的用户的数据。 下面的 ethereumProvider 指的是您将从 web3.currentProvider 或 window.ethereum 获得的对象。

1. Create a 3Box instance

要创建 3Box 会话，您可以调用 create 方法。 这将创建 Box 类的一个实例，该实例可用于以任何顺序打开线程和验证用户。 为了创建一个 3Box 会话，需要传递一个 provider。 这可以是 ethereum provider（来自 web3.currentProvider 或 window.ethereum）或 3ID Provider（来自 IdentityWallet）。 现在建议使用 3ID Connect Provider，这是一个 3ID 提供程序，它包装了可用的 ethereum providers 并将管理/许可 3ID 密钥、身份验证和 iframe 中的区块链帐户链接。 这将很快成为默认设置，并将覆盖通过的 ethereum providers。 您可以按如下方式获取 3ID Connect Provider。

const provider = await Box.get3idConnectProvider()
const box = await Box.create(provider)

2. Authenticate user

调用 auth 方法将对用户进行身份验证。 如果您想将用户验证到一个或多个空间，您可以在此处指定。 如果您在创建 3Box 会话时使用了以太坊提供商，则需要将以太坊地址传递给 auth 方法。 如果用户没有现有的 3Box 帐户，此方法将在后台自动为他们创建一个。

const address = '0x12345abcde'
const spaces = ['myDapp']
await box.auth(spaces, { address })

3. Sync user's available 3Box data from the network

当您第一次验证 dapp 中的盒子时，所有数据可能尚未从网络同步。 因此，您应该等待数据完全同步。 为此，您只需等待 box.syncDone 承诺：

await box.syncDone

这将使您知道何时可以使用所有用户数据。 我们建议不要在此同步发生之前设置任何数据。 但是，在同步完成之前读取数据是很好的，也是值得鼓励的——只要记住在同步完成后检查更新！ 请注意，box.syncDone 只能在用户通过身份验证后调用，如果仅调用 Box.create 方法则不可能。

如果您不想使用承诺，您可以使用 onSyncDone 方法添加回调。

3. Interact with 3Box profile data

您现在可以使用 box 实例对象与存储在用户配置文件中的公共和私人数据进行交互。 在公共和私有数据存储中，您都使用 key 来设置 value。

// use the public profile
// get
const nickname = await box.public.get('name')
console.log(nickname)
// set
await box.public.set('name', 'oed')
// remove
await box.public.remove('name')

// use the private store
// get
const email = await box.private.get('email')
console.log(email)
// set
await box.private.set('email', 'oed@email.service')
// remove
await box.private.remove('email')

Set multiple fields at once:

const fields = ['name', 'website', 'employer']
const values = ['Jon Schwartz', 'openworklabs.com', 'Open Work Labs']

await box.public.setMultiple(fields, values)

const privateFields = ['age', 'coinBalance']
const privateValues = ['xxx', 'yyy']

await box.private.setMultiple(privateFields, privateValues)

Open a thread

创建 3Box 会话后，您可以打开一个线程来查看其中的数据。 这可以在您对用户进行身份验证之前完成（他们需要在线程中发帖）。 打开线程时，需要提供审核选项。 您可以传递 firstModerator，第一个主持人的 3ID（或以太坊地址），以及一个指示它是否是成员线程的 members 布尔值。

const thread = await box.openThread('myDapp', 'myThread', { firstModerator: 'did:3:bafy...', members: true })

打开一个线程后，您可以调用 getPosts() 方法来检索帖子。

Spaces API (Storage)

Open a space

空间是用户 3Box 的命名部分。 每个空间都有一个公共商店和一个私人商店，对于您打开的每个空间，用户必须明确同意才能查看该空间。 这意味着，如果您的 dapp 使用其他 dapp 未使用的空间，则只有您的 dapp 可以更新数据并读取该特定空间的私有存储。 要打开一个名为 narwhal 的空间，您只需

const space = await box.openSpace('narwhal')

Sync user's available space data from the network

：

await space.syncDone

Get, set, and remove space data

调用 空间的完成方式与与 box.public 和 box.private 的交互方式相同（参见此处). 例如：

const config = await space.private.get('dapp-config')

Threads API (Messaging)

Add public and confidential message threads to your app

线程是一种共享数据存储，通过允许一个或多个用户按顺序发布消息，实现用户之间的去中心化通信。 此功能非常适合向您的应用程序添加评论、聊天、消息传递、提要和流媒体功能。 线程保存在一个空间中，加入线程的用户（具有相同的名称、空间、审核配置和访问配置）将能够在该线程中进行通信。

如需完整详细的规范，请查看文档。

Viewing a Public Thread

您可以在不打开空间的情况下获取公共线程中的所有帖子。 这对于允许您网站的访问者查看其他用户发表的评论非常有用。 这是通过调用 Box 对象的 getThread 方法实现的。 线程可以通过其所有配置选项或地址来引用。

const posts = await Box.getThread(spaceName, threadName, firstModerator, membersThread)
console.log(posts)

也可以在不打开空间的情况下查看线程，或者通过对从 openThread 返回的线程对象调用 getPosts() 方法进行身份验证（请参阅上面的打开线程部分）。

const posts = await Box.getThreadByAddress(threadAddress)
console.log(posts)

但是，如果应用程序想要向线程添加交互性，例如允许用户在线程中发帖或关注线程中的更新，则需要打开它们的空间以启用其他功能。 机密线程也是如此，这需要您进行身份验证才能访问以查看机密线程中的帖子。

Interacting with a Thread

1.a Creating a Public Thread

要创建和加入公共线程，您只需加入线程即可。 这将隐式使用当前用户为 firstModerator 且 members 为 false 的审核选项。

const thread = await space.joinThread('myThread')

线程也可以在加入时获得审核选项。 您可以传递 firstModerator、第一个主持人的 3ID 和一个指示它是否是成员线程的 members 布尔值。 版主可以添加其他版主、添加成员以及删除话题中的任何帖子。 会员可以在仅限会员的主题中发帖。

const thread = await space.joinThread('myThread', { firstModerator: 'some3ID', members: true })

1.b Creating a Confidential Thread

创建并加入机密线程。

const thread = await space.createConfidentialThread('myConfThread')

在创建时，您可能希望添加其他成员，以便他们可以读取消息并将消息写入线程，如下所示。

2. Joining a Thread

现有的公共或机密线程可以通过其地址加入。 机密线程最好通过其地址引用。

const thread = await space.joinThreadByAddress('/orbitdb/zdpuAp5QpBKR4BBVTvqe3KXVcNgo4z8Rkp9C5eK38iuEZj3jq/3box.thread.testSpace.testThread')

虽然可以通过地址或通过传递已知配置（与上述相同）加入公共线程。

const publicThread = await space.joinThread('myThread', { firstModerator: 'some3ID', members: true })

线程加入后可以找到如下地址。

const threadAddress = thread.address

3. Posting to a thread

这允许用户向线程添加消息。 消息的作者将是用户的 3Box DID。 当用户在线程中发帖时，他们会自动订阅该线程，并将其保存在应用程序使用的空间中，关键字为 thread-threadName。

await thread.post('hello world')

4. Getting all posts in a thread

这允许应用程序获取线程中的帖子。

const posts = await thread.getPosts()
console.log(posts)

5. Listening for updates in thread

这允许应用程序侦听线程中的新帖子，并在发生时执行操作，例如将新消息添加到应用程序的 UI。

thread.onUpdate(myCallbackFunction)

6. Handling moderation and capabilities

添加主持人并列出所有现有主持人

await thread.addModerator('some3ID')

const mods = await thread.listModerators()

添加成员并列出所有现有成员，如果成员仅线程

await thread.addMember('some3ID')

const members = await thread.listMembers()

监听何时添加了主持人或成员。

thread.onNewCapabilities(myCallbackFunction)

Example Application

您可以通过查看 /example 文件夹中的文件来快速运行某些代码并与之交互。 您使用以下命令运行该示例：

$ npm ci
$ npm run example:start

这将在 http://localhost:3000/ 运行一个简单的服务器，该服务器为静态 example/index.html 文件提供服务。 这使它可以轻松地与元掩码交互。 您可以编辑 example/index.html 文件来尝试不同的代码。

Build

Optimize build for read-only 3Box API

如果您只想从 3Box 的配置文件 API 获取配置文件数据，您可以通过仅导入那些函数或特定于 API 的 dist 文件来进行优化。 由于这包括最小的依赖项，因此文件大小约为 80kb，而完整构建的文件大小为 4+mb。

const { profileGraphQL, getProfile, getProfiles, getVerifiedAccounts } = require('3box/lib/api')

<script src="https://unpkg.com/3box/dist/3box.api.min.js"></script>

Resolving build size issues and out of memory errors

某些平台、工具或配置导致构建过程抛出内存不足错误。 这是我们库的大小（加上依赖项）和您构建的特定配置的组合。 它可能是在依赖项上运行的工具之类的东西，而不仅仅是你的源代码或依赖项被递归解析。 无论如何，您都可以尝试通过添加以下环境变量来构建库，以增加节点进程的内存。

NODE_OPTIONS=--max_old_space_size=4096 npm run build

Data Standards

Dapp 可以存储仅与他们的 dapp 相关的用户数据。 然而，我们鼓励 dapps 在它们之间共享数据以获得更丰富的 web3 体验。 因此，我们创建了Key Conventions 以便促进这一点。 请随时对此文件进行 PR，以向社区解释您如何使用 3Box！

Validate claims

使用 idUtils 模块验证声明。 看 did-jwt 库了解更多详情。

const { idUtils } = require('3box')

const claim = 'eyJ0eX...'
idUtils.verifyClaim(claim)
  .then(valid => console.info('details:', valid)
  .catch(err => console.error('claim verification failed:', err)

API Documentation

Box ⇐ BoxApi

种类：全局类
扩展：BoxApi

• Box ⇐ BoxApi
  • new Box()
  • instance
    • .public
    • .private
    • .verified
    • .spaces
    • .syncDone
    • .DID
    • .auth(spaces, opts)
    • .openSpace(name, opts) ⇒ Space
    • .openThread(space, name, opts) ⇒ Thread
    • .onSyncDone(syncDone) ⇒ Promise
    • .linkAddress([link])
    • .removeAddressLink(address)
    • .isAddressLinked([query])
    • .listAddressLinks() ⇒ Array
    • .logout()
  • static
    • .idUtils
      • .verifyClaim ⇒ Object
      • .isSupportedDID(did) ⇒ \* | boolean
      • .isClaim(claim, opts) ⇒ Promise.<boolean>
    • .create(provider, opts) ⇒ Box
    • .get3idConnectProvider() ⇒ 3IDProvider
    • .openBox(address, provider, opts) ⇒ Box
    • .isLoggedIn(address) ⇒ Boolean
    • .getIPFS() ⇒ IPFS

new Box()

请使用openBox< /strong> 方法来实例化一个 3Box

box.public

Kind: Box
Properties

Name	Type	Description
public	KeyValueStore	access the profile store of the users 3Box

box.private

Kind：Box
Properties

Name	Type	Description
private	KeyValueStore	access the private store of the users 3Box

box.verified

Kind：Box
Properties

Name	Type	Description
verified	Verified	check and create verifications

box.spaces

Kind：Box
Properties

Name	Type	Description
spaces	Object	an object containing all open spaces indexed by their name.

box.syncDone

Kind：Box
Properties

Name	Type	Description
syncDone	Promise	A promise that is resolved when the box is synced

box.DID

Kind：Box
Properties

Name	Type	Description
DID	String	the DID of the user

box.auth(spaces, opts)

验证用户

Kind: Box 的实例方法

Param	Type	Description
spaces	Array.<String>	A list of spaces to authenticate (optional)
opts	Object	Optional parameters
opts.address	String	An ethereum address
opts.consentCallback	function	A function that will be called when the user has consented to opening the box

box.openSpace(name, opts) ⇒ Space

在用户3Box中打开给定名字的空间

Kind: 盒子
返回：Space - 给定空间名称的 Space 实例

Param	Type	Description
name	String	The name of the space
opts	Object	Optional parameters
opts.consentCallback	function	A function that will be called when the user has consented to opening the box
opts.onSyncDone	function	A function that will be called when the space has finished syncing with the pinning node

< /a>

box.openThread(space, name, opts) ⇒ Thread

打开一个线程。 使用它开始接收更新

Kind：Box
的实例方法 返回：Thread - 加入线程的线程类实例

Param	Type	Description
space	String	The name of the space for this thread
name	String	The name of the thread
opts	Object	Optional parameters
opts.firstModerator	String	DID of first moderator of a thread, by default, user is first moderator
opts.members	Boolean	join a members only thread, which only members can post in, defaults to open thread
opts.noAutoSub	Boolean	Disable auto subscription to the thread when posting to it (default false)
opts.ghost	Boolean	Enable ephemeral messaging via Ghost Thread
opts.ghostBacklogLimit	Number	The number of posts to maintain in the ghost backlog
opts.ghostFilters	Array.<function()>	Array of functions for filtering messages

box.onSyncDone(syncDone) ⇒ Promise

设置盒子完全同步时调用一次的回调函数。

Kind：Box
的实例方法 返回：Promise - 当框被同步时实现的承诺

Param	Type	Description
syncDone	function	The function that will be called

box.linkAddress([link])

创建链接以太坊地址的证明到用户的 3Box 帐户。 如果给出证明，它将被简单地添加到根存储中。

Kind：Box

Param	Type	Description
[link]	Object	Optional link object with type or proof
[link.proof]	Object	Proof object, should follow spec

box.removeAddressLink(address)

的实例方法移除给定地址链接，成功则返回true

Kind: Box

Param	Type	Description
address	String	address that is linked

的实例方法/a>

box.isAddressLinked([query])

检查是否有证明将外部帐户链接到用户的 3Box 帐户。 如果没有给定参数并且存在任何链接，则返回 true

Kind：Box

Param	Type	Description
[query]	Object	Optional object with address and/or type.
[query.type]	String	Does the given type of link exist
[query.address]	String	Is the given adressed linked

box.listAddressLinks() ⇒ Array

列出与此 3Box 关联的地址链接

Kind: Box
的实例方法> 返回：Array - 链接对象数组

box.logout()

关闭 3box 实例并清除本地缓存。 如果你这样称呼， 用户需要签署同意消息才能下次登录 你叫 openBox。

Kind：Box
的实例方法

Box.idUtils

验证 & 的模块 验证声明

Kind：Box

• .idUtils
  • .verifyClaim ⇒ Object
  • .isSupportedDID(did) ⇒ \* | boolean
  • .isClaim(claim, opts) ⇒ Promise.<boolean>

idUtils.verifyClaim ⇒ Object

验证声明并返回其内容。 有关详细信息，请参阅 https://github.com/uport-project/did-jwt/。

种类：idUtils
的静态属性 返回：对象 - 经过验证的声明

Param	Type	Description
claim	String
opts	Object	Optional parameters
opts.audience	string	The DID of the JWT's audience

idUtils.isSupportedDID(did) ⇒ \* | boolean

检查字符串是否为 muport

种类：idUtils
的静态方法 返回：\* | boolean - did 是否为受支持的 did

Param	Type	Description
did	String	A string containing a user did

idUtils.isClaim(claim, opts) ⇒ Promise.<boolean>

检查字符串是否为有效声明

Kind: idUtils
的静态方法 返回：Promise.<boolean> - 参数是否为实际声明

Param	Type	Description
claim	String
opts	Object	Optional parameters
opts.audience	string	The DID of the audience of the JWT

Box.create(provider, opts) ⇒ Box

创建一个3Box

Kind 的实例：Box
的静态方法 返回：Box - 3Box 会话实例

Param	Type	Description
provider	provider	A 3ID provider, or ethereum provider
opts	Object	Optional parameters
opts.pinningNode	String	A string with an ipfs multi-address to a 3box pinning node
opts.ipfs	Object	A js-ipfs ipfs object
opts.addressServer	String	URL of the Address Server

Box.get3idConnectProvider() ⇒ 3IDProvider

返回和 3ID Connect Provider 来管理密钥、身份验证和帐户链接。 将来成为默认值。

Kind：Box
的静态方法 返回：3IDProvider - 解析为 3ID Connect Provider 的 Promise

Box.openBox(address, provider, opts) ⇒ Box

打开与给定地址关联的 3Box

Kind：Box
返回：Box - 给定地址的 3Box 实例

Param	Type	Description
address	String	An ethereum address
provider	provider	An ethereum or 3ID provider
opts	Object	Optional parameters
opts.consentCallback	function	A function that will be called when the user has consented to opening the box
opts.pinningNode	String	A string with an ipfs multi-address to a 3box pinning node
opts.ipfs	Object	A js-ipfs ipfs object
opts.addressServer	String	URL of the Address Server
opts.contentSignature	String	A signature, provided by a client of 3box using the private keys associated with the given address, of the 3box consent message

Box.isLoggedIn(address) ⇒ Boolean

检查给定地址是否在

Kind 中登录：Box
的静态方法 返回：Boolean - 如果用户登录则为真

Param	Type	Description
address	String	An ethereum address

Box.getIPFS() ⇒ IPFS

在不调用 openBox 的情况下实例化 3Box 使用的 ipfs。

Kind：Box
的静态方法 返回：IPFS - ipfs 实例

BoxApi

Kind: global class

• BoxApi
  • .listSpaces(address, opts) ⇒ Object
  • .getSpace(address, name, opts) ⇒ Object
  • .getThread(space, name, firstModerator, members, opts) ⇒ Array.<Object>
  • .getThreadByAddress(address, opts) ⇒ Array.<Object>
  • .getConfig(address, opts) ⇒ Array.<Object>
  • .getProfile(address, opts) ⇒ Object
  • .getProfiles(address, opts) ⇒ Object
  • .profileGraphQL(query, opts) ⇒ Object
  • .getVerifiedAccounts(profile) ⇒ Object

BoxApi.listSpaces(address, opts) ⇒ Object

获取用户拥有的所有空间的名称

Kind : BoxApi
的静态方法 返回: Object - 一个所有空格都是字符串的数组

Param	Type	Description
address	String	An ethereum address
opts	Object	Optional parameters
opts.profileServer	String	URL of Profile API server

BoxApi.getSpace(address, name, opts) ⇒ Object

获取给定地址空间中的公共数据具有给定名称

Kind：BoxApi
的静态方法 返回：对象 - 带有公共空间数据的 json 对象

Param	Type	Description
address	String	An ethereum address
name	String	A space name
opts	Object	Optional parameters
opts.blocklist	function	A function that takes an address and returns true if the user has been blocked
opts.metadata	String	flag to retrieve metadata
opts.profileServer	String	URL of Profile API server

BoxApi.getThread(space, name, firstModerator, members, opts) ⇒ Array.<Object>

获取所有发布到线程的帖子。

种类：BoxApi
的静态方法 返回：Array.<Object> - 帖子数组

Param	Type	Description
space	String	The name of the space the thread is in
name	String	The name of the thread
firstModerator	String	The DID (or ethereum address) of the first moderator
members	Boolean	True if only members are allowed to post
opts	Object	Optional parameters
opts.profileServer	String	URL of Profile API server

BoxApi.getThreadByAddress(address, opts) ⇒ Array.<Object>

获取所有帖子做成一个线程。

种类：BoxApi
的静态方法 返回：Array.<Object> - 一个帖子数组

Param	Type	Description
address	String	The orbitdb-address of the thread
opts	Object	Optional parameters
opts.profileServer	String	URL of Profile API server

BoxApi.getConfig(address, opts) ⇒ Array.<Object>

获取a的配置users 3Box

Kind: BoxApi
的静态方法 返回：Array.<Object> - 帖子数组

Param	Type	Description
address	String	The ethereum address
opts	Object	Optional parameters
opts.profileServer	String	URL of Profile API server

BoxApi.getProfile(address, opts) ⇒ Object

获取的公开资料给定的地址

Kind：BoxApi
的静态方法 返回：对象 - 具有给定地址配置文件的 json 对象

Param	Type	Description
address	String	An ethereum address
opts	Object	Optional parameters
opts.blocklist	function	A function that takes an address and returns true if the user has been blocked
opts.metadata	String	flag to retrieve metadata
opts.profileServer	String	URL of Profile API server

BoxApi.getProfiles(address, opts) ⇒ Object

获取给定的公共配置文件列表地址。 这依赖于 3Box 配置文件 API。

种类：BoxApi
的静态方法 返回：对象 - 一个 json 对象，每个键都有一个地址和值配置文件

Param	Type	Description
address	Array	An array of ethereum addresses
opts	Object	Optional parameters
opts.profileServer	String	URL of Profile API server

BoxApi.profileGraphQL(query, opts) ⇒ Object

GraphQL for 3Box profile API

< strong>种类：BoxApi
的静态方法 返回：对象 - 一个 json 对象，每个键都有一个地址和值配置文件

Param	Type	Description
query	Object	A graphQL query object.
opts	Object	Optional parameters
opts.graphqlServer	String	URL of graphQL 3Box profile service

BoxApi.getVerifiedAccounts(profile) ⇒ Object

验证社交帐户的证明存在于配置文件中。

种类：BoxApi
的静态方法 返回：对象 - 包含已验证帐户的对象

Param	Type	Description
profile	Object	A user profile object, received from the getProfile function

KeyValueStore

种类：全局类

• KeyValueStore
  • new KeyValueStore()
  • .get(key, opts) ⇒ String | Object
  • .getMetadata(key) ⇒ Metadata
  • .set(key, value) ⇒ Boolean
  • .setMultiple(keys, values) ⇒ Boolean
  • .remove(key) ⇒ Boolean
  • .all(opts) ⇒ Array.<(String\|{value: String, timestamp: Number})>
  • .log() ⇒ Array.<Object>

new KeyValueStore()

请使用box.public 或box.private 获取该类的实例

keyValueStore.get(key, opts) ⇒ String | Object

获取给定键的值和可选的元数据

Kind：KeyValueStore 的实例方法br> 返回：String | Object - 与键关联的值，如果没有这样的键则未定义

Param	Type	Description
key	String	the key
opts	Object	optional parameters
opts.metadata	Boolean	return both value and metadata

keyValueStore.getMetadata(key) ⇒ Metadata

获取给定键的元数据

Kind: KeyValueStore
的实例方法 返回：Metadata - 键的元数据，如果没有这样的键则未定义

Param	Type	Description
key	String	the key

keyValueStore.set(key, value) ⇒ Boolean

为给定的键设置一个值

Kind：KeyValueStore
的实例方法 返回：布尔值 - 如果成功则为真

Param	Type	Description
key	String	the key
value	String	the value

keyValueStore.setMultiple(keys, values) ⇒ Boolean

为多个键设置多个值

种类： KeyValueStore
的实例方法 返回：布尔值 - 如果成功则为真，否则则抛出错误

Param	Type	Description
keys	Array.<String>	the keys
values	Array.<String>	the values

keyValueStore.remove(key) ⇒ Boolean

删除给定键的值

种类：KeyValueStore
的实例方法 返回：Boolean - 如果成功则为真

Param	Type	Description
key	String	the key

keyValueStore.all(opts) ⇒ Array.<(String\|{value: String, timestamp: Number})>

获取所有值和可选的元数据

Kind： KeyValueStore
的实例方法 返回：Array.<(String\|{value: String, timestamp: Number})&gt; - 值

Param	Type	Description
opts	Object	optional parameters
opts.metadata	Boolean	return both values and metadata

keyValueStore.log() ⇒ Array.<Object>

返回底层日志条目的数组。 根据他们的 Lamport 时钟以线性化顺序排列。 用于生成商店中所有操作的完整历史记录。

Kind：KeyValueStore
的实例方法 返回：Array.<Object> - 有序日志条目对象数组
示例

const log = store.log
 const entry = log[0]
 console.log(entry)
 // { op: 'PUT', key: 'Name', value: 'Botbot', timeStamp: '1538575416068' }

User

表示用户的类。

Kind：全局类

• User
  • .DID
  • .signClaim(payload, opts) ⇒ String
  • .encrypt(message, opts, to) ⇒ Object
  • .decrypt(encryptedObject) ⇒ String

user.DID

Kind：User 的实例属性
Properties

Name	Type	Description
DID	String	the DID of the user

user.signClaim(payload, opts) ⇒ String

签署 JWT 声明

Kind： 的实例方法用户
返回：String - 签名的 JWT

Param	Type	Description
payload	Object	The payload to sign
opts	Object	Optional parameters

user.encrypt(message, opts, to) ⇒ Object

加密消息。 默认情况下对称加密消息 使用用户私钥。 如果使用 to 参数， 该消息将被非对称加密给收件人。

Kind：User
的实例方法 返回：对象 - 包含加密负载的对象

Param	Type	Description
message	String	The message to encrypt
opts	Object	Optional parameters
to	String	The receiver of the message, a DID or an ethereum address

user.decrypt(encryptedObject) ⇒ String

如果用户拥有正确的解密密钥，则解密消息它。

Kind：User
的实例方法 返回：String - 明文消息

Param	Type	Description
encryptedObject	Object	The encrypted message to decrypt (as encoded by the encrypt method

Space

种类：全局类

• Space
  • new Space()
  • .public
  • .private
  • .syncDone
  • .user
  • .joinThread(name, opts) ⇒ Thread
  • .createConfidentialThread(name) ⇒ Thread
  • .joinThreadByAddress(address, opts) ⇒ Thread
  • .subscribeThread(address, config)
  • .unsubscribeThread(address)
  • .subscribedThreads() ⇒ Array.<Objects>

new Space()

请使用box.openSpace获取此类的实例

space.public

Kind: instance 空间
的属性 Properties

Name	Type	Description
public	KeyValueStore	access the profile store of the space

space.private

Kind：Space
Properties

Name	Type	Description
private	KeyValueStore	access the private store of the space

space.syncDone

Kind：Space
Properties

Name	Type	Description
syncDone	Promise	A promise that is resolved when the space data is synced

space.user

Kind：Space
属性

Name	Type	Description
user	User	access the user object to encrypt data and sign claims

space.joinThread(name, opts) ⇒ Thread

加入一个线程。 使用它开始接收来自线程的更新，并在线程中发布

Kind：Space
的实例方法 返回：Thread - 已加入线程的线程类实例

Param	Type	Description
name	String	The name of the thread
opts	Object	Optional parameters
opts.firstModerator	String	DID of first moderator of a thread, by default, user is first moderator
opts.members	Boolean	join a members only thread, which only members can post in, defaults to open thread
opts.confidential	Boolean	create a confidential thread with true or join existing confidential thread with an encKeyId string
opts.noAutoSub	Boolean	Disable auto subscription to the thread when posting to it (default false)
opts.ghost	Boolean	Enable ephemeral messaging via Ghost Thread
opts.ghostBacklogLimit	Number	The number of posts to maintain in the ghost backlog
opts.ghostFilters	Array.<function()>	Array of functions for filtering messages

space.createConfidentialThread(name) ⇒ Thread

创建机密线程

种类：Space
的实例方法 返回：Thread - 已创建线程的线程类实例

Param	Type	Description
name	String	The name of the thread

space.joinThreadByAddress(address, opts) ⇒ Thread

通过完整的线程地址加入线程。 使用它开始接收来自线程的更新，并在线程中发布

Kind：Space
的实例方法 返回：Thread - 加入线程的线程类实例

Param	Type	Description
address	String	The full address of the thread
opts	Object	Optional parameters
opts.noAutoSub	Boolean	Disable auto subscription to the thread when posting to it (default false)

space.subscribeThread(address, config)

订阅给定的线程，如果尚未订阅

种类：Space 的实例方法

Param	Type	Description
address	String	The address of the thread
config	Object	configuration and thread meta data
opts.name	String	Name of thread
opts.firstModerator	String	DID of the first moderator
opts.members	String	Boolean string, true if a members only thread

space.unsubscribeThread(address)

如果已订阅，则取消订阅给定的线程

种类：Space 的实例方法/a>

Param	Type	Description
address	String	The address of the thread

space.subscribedThreads() ⇒ Array.<Objects>

获取该空间所有订阅的线程列表

Kind：的实例方法空间
返回：Array.<Objects> - 作为{address, firstModerator, members, name}
的线程对象列表

Thread

Kind：全局类

• Thread
  • new Thread()
  • .post(message) ⇒ String
  • .addModerator(id)
  • .listModerators() ⇒ Array.<String>
  • .addMember(id)
  • .listMembers() ⇒ Array.<String>
  • .deletePost(id)
  • .getPosts(opts) ⇒ Array.<Object>
  • .onUpdate(updateFn)
  • .onNewCapabilities(updateFn)

new Thread()

请使用space.joinThread获取此类的实例

thread.post(message) ⇒ String

向线程发送消息

种类：Thread<的实例方法/代码>
返回：String - 新帖子的postId

Param	Type	Description
message	Object	The message

thread.addModerator(id)

给这个帖子添加版主，抛出错误是用户可以不添加主持人

Kind: Thread

Param	Type	Description
id	String	Moderator Id

thread.listModerators() ⇒ Array.<String>

列出版主

种类：Thread
的实例方法 返回：Array.<String> - 主持人 DID 数组

thread.addMember(id)

添加一个成员到这个线程，如果用户不能添加成员抛出，抛出不是成员线程

Kind: Thread

Param	Type	Description
id	String	Member Id

thread.listMembers() ⇒ Array.<String>

列出成员，如果不是成员则抛出线程

Kind: 实例方法线程
返回：Array.<String> - 成员 DID 数组

thread.deletePost(id)

删除帖子

种类：Thread的实例方法

Param	Type	Description
id	String	Moderator Id

< a name="Thread+getPosts">

thread.getPosts(opts) ⇒ Array.<Object>

根据选项返回一组帖子。 如果传递 gt、gte、lt 或 lte 时未找到散列， 迭代器将返回所有项目（尊重限制和反向）。

Kind：Thread
的实例方法 返回：Array.<Object> - 如果成功则返回true

Param	Type	Description
opts	Object	Optional parameters
opts.gt	String	Greater than, takes an postId
opts.gte	String	Greater than or equal to, takes an postId
opts.lt	String	Less than, takes an postId
opts.lte	String	Less than or equal to, takes an postId
opts.limit	Integer	Limiting the number of entries in result, defaults to -1 (no limit)
opts.reverse	Boolean	If set to true will result in reversing the result

thread.onUpdate(updateFn)

注册一个要调用的函数新更新后 已从网络或本地收到。

Kind：Thread的实例方法

Param	Type	Description
updateFn	function	The function that will get called

thread.onNewCapabilities(updateFn)

注册一个函数被称为每一个新的 添加到线程访问控制器的功能。 这包括在添加版主或成员时。 该函数接受一个参数，即 capabilities obj，或者 您可以再次调用 listModerator / listMembers。

Kind：Thread

Param	Type	Description
updateFn	function	The function that will get called

Verified

Kind< 的实例方法/strong>: global class

• Verified
  • new Verified()
  • .DID() ⇒ String
  • .github() ⇒ Object
  • .addGithub(gistUrl) ⇒ Object
  • .twitter() ⇒ Object
  • .addTwitter(claim) ⇒ Object
  • .email() ⇒ Object
  • .addEmail(claim) ⇒ Object

new Verified()

请使用box.verified获取该类的实例

verified.DID() ⇒ String

返回用户的已验证 DID

Kind: Verified
的实例方法 返回：String - 用户的 DID

verified.github() ⇒ Object

验证用户是否拥有有效的github账号 否则抛出错误。

种类：Verified
的实例方法 返回：对象 - 包含用户名和证明的对象

verified.addGithub(gistUrl) ⇒ Object

向用户配置文件添加 github 验证 如果验证失败则抛出错误。

种类：Verified
的实例方法 返回：对象 - 包含用户名和证明的对象

Param	Type	Description
gistUrl	Object	URL of the proof

verified.twitter() ⇒ Object

验证用户是否拥有有效的 Twitter 帐户 否则抛出错误。

种类：Verified
的实例方法 返回：对象 - 包含用户名、证明和验证者的对象

verified.addTwitter(claim) ⇒ Object

向用户个人资料添加推特验证 如果验证失败则抛出错误。

种类：Verified
的实例方法 返回：对象 - 包含用户名、证明和验证器的对象

Param	Type	Description
claim	String	A did-JWT claim ownership of a twitter username

verified.email() ⇒ Object

验证用户是否拥有经过验证的电子邮件帐户 否则抛出错误。

种类：Verified
的实例方法 返回：对象 - 包含用户名、证明和验证者的对象

verified.addEmail(claim) ⇒ Object

向用户个人资料添加电子邮件验证 如果验证失败则抛出错误。

种类：Verified
的实例方法 返回：对象 - 包含用户名、证明和验证者的对象

Param	Type	Description
claim	String	A did-JWT claim ownership of an email username