# @canvas-js/interfaces 中文文档

规范地址：https://npmcn.com/package/%40canvas-js/interfaces/

版本：0\.16\.1
npm 元数据更新时间：2025-07-30T15:06:09.115Z
中文译文更新时间：2026-11-09T08:03:17.778Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40canvas-js/interfaces
原文对照：https://npmcn.com/package/%40canvas-js/interfaces/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：9.2 kB，24 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2022-06-09T16:51:28.898Z
- 最新版本发布：2025-07-30T15:06:08.847Z
- 近 30 天下载量：3733（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：262（近 12 个月 0 个）

## 中文简介

此套件会导出 Canvas 信件和其他接口的 TypeScript 类型 .

## 安装

```sh
npm install @canvas-js/interfaces
```

也可以使用：`pnpm add @canvas-js/interfaces`、`yarn add @canvas-js/interfaces`、`bun add @canvas-js/interfaces`

## README

# @ canvas- js/ 接口

此套件会导出 Canvas 信件和其他接口的 TypeScript 类型 .

## 目录

-   [安装](https://npmcn.com/package/%40canvas-js/interfaces/#readme-installation)
-   [API 密码](https://npmcn.com/package/%40canvas-js/interfaces/#readme-api)
    -   [签署](https://npmcn.com/package/%40canvas-js/interfaces/#readme-signatures)
    -   [签名人](https://npmcn.com/package/%40canvas-js/interfaces/#readme-signers)
    -   [信件](https://npmcn.com/package/%40canvas-js/interfaces/#readme-messages)
    -   [行动](https://npmcn.com/package/%40canvas-js/interfaces/#readme-actions)
    -   [会议](https://npmcn.com/package/%40canvas-js/interfaces/#readme-sessions)
    -   [会话签名符](https://npmcn.com/package/%40canvas-js/interfaces/#readme-session-signers)
    -   [工具类型](https://npmcn.com/package/%40canvas-js/interfaces/#readme-utility-types)
        -   [等待时间](https://npmcn.com/package/%40canvas-js/interfaces/#readme-awaitable)

## 安装

```
npm i @canvas-js/interfaces
```

## API 密码

### 签署

```ts
import type { CID } from "multiformats"

export type Signature = {
  publicKey: string
  signature: Uint8Array
  cid: CID
}
```

### 签名人

```ts
import type { Signature } from "./Signature.js"

export interface Signer<T = any> {
  sign(value: T): Signature
}
```

### 信件

```ts
export type Message<Payload = unknown> = {
  topic: string
  clock: number
  parents: string[]
  payload: Payload
}
```

### 行动

```ts
export type Action = {
  type: "action"

  /** DID of the user that authorized the session (e.g. "did:pkh:eip155:1:0xb94d27...") */
  address: string

  name: string
  args: any

  context: {
    timestamp: number
    blockhash?: string
  }
}
```

### 会议

```ts
export type Session<AuthorizationData = any> = {
  type: "session"

  /** DID of the user that authorized the session (e.g. "did:pkh:eip155:1:0xb94d27...") */
  address: string

  /** did:key URI of the ephemeral session key used to sign subsequent actions */
  publicKey: string

  /** signer-specific session payload, e.g. a SIWE message & signature */
  authorizationData: AuthorizationData

  context: {
    blockhash?: string
    duration?: number
    timestamp: number
  }
}
```

### 会话签名符

```ts
import type { Signer } from "./Signer.js"
import type { Message } from "./Message.js"
import type { Session } from "./Session.js"
import type { Action } from "./Action.js"
import type { Awaitable } from "./Awaitable.js"

export interface SessionSigner extends Signer<Action | Session> {
  match: (chain: string) => boolean

  /**
   * Produce an signed Session object, which authorizes `session.publicKey`
   * to represent the user `${session.chain}:${session.address}`.
   *
   * The signature is stored in `session.data`, and the entire Session
   * object is then signed using the session-key, and appended to our message log.
   */
  getSession: (topic: string, options?: { chain?: string; timestamp?: number }) => Awaitable<Session>

  /**
   * Verify that `session.data` authorizes `session.publicKey`
   * to take actions on behalf of the user `${session.chain}:${session.address}`
   */
  verifySession: (session: Session) => Awaitable<void>
}
```

### 工具类型

#### `Awaitable`

```ts
export type Awaitable<T> = T | Promise<T>
```

## 常见问题

### @canvas-js/interfaces 是什么？

此套件会导出 Canvas 信件和其他接口的 TypeScript 类型 \.

### 如何安装 @canvas-js/interfaces？

在项目目录运行 npm install @canvas-js/interfaces，或使用 pnpm add / yarn add / bun add。

### @canvas-js/interfaces 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @canvas-js/interfaces 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @canvas-js/interfaces 可以商用吗？

@canvas-js/interfaces 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @canvas-js/interfaces 的下载量有多少？

根据 npm 官方下载统计，@canvas-js/interfaces 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,733 次，日均约 124 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @canvas-js/interfaces 还在维护吗？

最新版本 0\.16\.1 发布于 2025/07/30（1\.3 年前）；至今共发布 262 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/06/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。