# @exodus/personal-notes 中文文档

规范地址：https://npmcn.com/package/%40exodus/personal-notes/

版本：3\.9\.2
npm 元数据更新时间：2026-10-09T20:41:54.801Z
中文译文更新时间：2026-11-14T04:13:10.294Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40exodus/personal-notes
原文对照：https://npmcn.com/package/%40exodus/personal-notes/?lang=original
项目主页：https://github.com/ExodusMovement/exodus/tree/master/libs/features/personal-notes
源码仓库：https://github.com/ExodusMovement/exodus

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

- 包体积（解压后）：23.5 kB，22 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2022-11-22T00:48:34.267Z
- 最新版本发布：2026-10-09T20:41:54.453Z
- 近 30 天下载量：10776（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 2 个）

## 中文简介

个人笔记的 CRUD 界面(用户生成的离链交易元数据)

## 安装

```sh
npm install @exodus/personal-notes
```

也可以使用：`pnpm add @exodus/personal-notes`、`yarn add @exodus/personal-notes`、`bun add @exodus/personal-notes`

## README

# @exodus/个人笔记

该模块允许用户为交易安全创建、管理和存储个人笔记

## 如何运作

1.  个人笔记原子

模块的核心功能由 `personalNotesAtom`,用于存储用户生成的注释. 每个音符都有uniq id并被绑定为txId. 使用存储的个人笔记 `PersonalNoteSet` 财务报告和审定财务报表 `PersonalNote` [模型](https://github.com/ExodusOSS/hydra/blob/8ac3c1382e3d51923de4d73c43c32f92005ae351/libraries/models/src/personal-note-set/index.js#L9)

```js
const personalNotes = PersonalNoteSet.fromArray([
  { txId: 'bitcoin-tx-1', message: 'gift for friend' },
  { txId: 'ethereum-tx-1', message: 'gift from friend' },
])
personalNotesAtom.set(personalNotes)

const bitcoinTxPersonalNote = personalNotes.get('bitcoin-tx-1')
```

2.  模块

这个模块有两件事:

1.  将个人笔记同步到 `fusion`
2.  提供 `upsert` 添加个人笔记的方法 仅允许以下道具:

```js
exodus.personalNotes.upsert({
  txId, // required
  message, // string
  // specific fields used by platforms features
  username,
  address,
  dapp,
  providerData,
  walletConnect,
  xmrInputs,
})
```

3.  插件

插件订阅到 `personalNotesAtom` 并释放其价值 `port`

4.  Redux 模块

提供选择者获取个人笔记

## 使用量

此特性设计为与 `@exodus/headless`。见 [使用 sdk](https://npmcn.com/package/docs/development/using-the-sdk.md)。 。 。 .

### 来玩吧

1.  打开游乐场 [https://exodus-hydra.pages.dev/ 页面存档备份,存于互联网档案馆](https://exodus-hydra.pages.dev/)
2.  运行 `exodus.personalNotes.upsert({txId: 'e7b8f55e3173aed308b8fbff11ee1fb96183e51f111ac415da9ae057c72ac8ca', message: 'my note'})` 在 Dev 工具控制台中.
3.  运行 `selectors.personalNotes.data(store.getState())` 在 Dev 工具控制台中。 你应该看看存有的个人笔记
4.  运行 `selectors.personalNotes.get(store.getState())('e7b8f55e3173aed308b8fbff11ee1fb96183e51f111ac415da9ae057c72ac8ca')` 在 Dev 工具控制台中。 你应该看看具体的个人说明

### API 边

见 [使用 sdk](https://npmcn.com/package/docs/development/using-the-sdk.md#setup-the-api-side) 更多关于特性插入 SDK 的细节

```ts
exodus.personalNotes.upsert(<Event>{
  txId: 'bitcoin-tx-id',
  message: 'tx for friend',
})
```

### UI 侧

见 [使用 sdk](https://npmcn.com/package/docs/development/using-the-sdk.md#events) 关于基本UI侧设置的更多细节.

```js
import { selectors } from '~/ui/flux'

const usePersonalNote = (txId) => {
  const getPersonalNote = useSelector(selectors.personalNotes.get)
  const personalNote = getPersonalNote(txId)

  return personalNote
}
```

## 常见问题

### @exodus/personal-notes 是什么？

个人笔记的 CRUD 界面\(用户生成的离链交易元数据\)

### 如何安装 @exodus/personal-notes？

在项目目录运行 npm install @exodus/personal-notes，或使用 pnpm add / yarn add / bun add。

### @exodus/personal-notes 支持 TypeScript 吗？

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

### @exodus/personal-notes 支持 ESM 还是 CommonJS？

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

### @exodus/personal-notes 可以商用吗？

@exodus/personal-notes 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @exodus/personal-notes 的下载量有多少？

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

### @exodus/personal-notes 还在维护吗？

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