# @awakentax/crypto-tax 中文文档

规范地址：https://npmcn.com/package/%40awakentax/crypto-tax/

版本：0\.1\.3
npm 元数据更新时间：2026-04-10T19:47:28.457Z
中文译文更新时间：2026-11-07T08:29:53.247Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：14.5 kB，18 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2025-12-13T00:27:32.049Z
- 最新版本发布：2025-12-13T09:10:49.380Z
- 近 30 天下载量：13090（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

对 Awaken 征税 SDK

## 安装

```sh
npm install @awakentax/crypto-tax
```

也可以使用：`pnpm add @awakentax/crypto-tax`、`yarn add @awakentax/crypto-tax`、`bun add @awakentax/crypto-tax`

## README

# @ awakentax/ crypto- tax

对 Awaken 征税 SDK – 将加密税计算链接轻松整合到您的应用程序中.

## 步骤1:获得 API 密钥

要使用这个SDK,你需要API密钥. 请联系 **[ưμ㼯a](mailto:andrew@awaken.tax)** 以获取您的 API 密钥.

## 安装

```bash
npm install @awakentax/crypto-tax
```

或带线:

```bash
yarn add @awakentax/crypto-tax
```

## 使用量

### 初始化 SDK

首先,用您的 API 密钥导入并初始化 SDK :

```typescript
import { CryptoTaxSDK } from '@awakentax/crypto-tax';

const cryptotax = new CryptoTaxSDK({
  apiKey: 'your-api-key-here'
});
```

### 获取链接 URL

通过提供钱包地址创建链接 :

```typescript
import type { CreateLinkRequest } from '@awakentax/crypto-tax';

const request: CreateLinkRequest = {
  wallets: [
    {
      address: '0x1234567890123456789012345678901234567890',
      name: 'My Main Wallet' // Optional
    },
    {
      address: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd'
    }
  ]
};

const response = await cryptotax.createLink(request);
console.log('Link URL:', response.url);
console.log('Link Code:', response.code);
```

### 打开链接

一旦拥有了URL,您可以在浏览器中打开,或者重新定向您的用户:

```typescript
// In a browser environment
window.location.href = response.url;

// Or open in a new tab/window
window.open(response.url, '_blank');

// In a Node.js environment, you can log it or use a library like 'open'
console.log('Open this URL:', response.url);
```

### 完整示例

```typescript
import { CryptoTaxSDK } from '@awakentax/crypto-tax';
import type { CreateLinkRequest } from '@awakentax/crypto-tax';

async function createTaxLink() {
  // Initialize SDK
  const cryptotax = new CryptoTaxSDK({
    apiKey: process.env.AWAKEN_API_KEY!,
  });

  // Prepare wallet data
  const request: CreateLinkRequest = {
    wallets: [
      {
        address: '0x1234567890123456789012345678901234567890',
        name: 'My Main Wallet'
      }
    ]
  };

  try {
    // Create the link
    const { url, code } = await cryptotax.createLink(request);
    
    // Open the link (browser example)
    window.location.href = url;
    
    // Or redirect users to the tax calculation page
    // window.open(url, '_blank');
  } catch (error) {
    console.error('Failed to create link:', error);
  }
}
```

## 看起来像什么

![Screenshot 2025-12-13 at 12 58 43 AM](https://github.com/user-attachments/assets/b7d09c69-0076-4753-bbd2-4b49eb533629)

当你打开我们为您生成的URL, 它会看起来像这样。 如果用户没有Awaken账户,它会促使他们创建一个账户,然后为他们自动添加钱包. 如果他们已经有一个账户,它会是一个一点击 添加他们将这些钱包链接到他们现有的Awaken账户.

## 替代品:使用cURL(不含SDK)

如果您不愿使用SDK,可以使用cURL直接拨打API:

### 创建伙伴账户链接

```bash
curl -X POST https://api.link.awaken.tax/api/links \
  -H "Content-Type: application/json" \
  -H "x-api-key: your-api-key-here" \
  -d '{
    "wallets": [
      {
        "address": "0x1234567890123456789012345678901234567890",
        "name": "My Wallet"
      },
      {
        "address": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"
      }
    ]
  }'
```

**请求正文 :**

-   `wallets` (所需阵列): 钱包对象矩阵
    -   `address` (字符串,要求): 钱包地址
    -   `name` (弦,可选): 钱包名称

**回应:**

-   成功(201):回归 `code` 财务报告和审定财务报表 `url` 对于创建的链接
-   成功 (200): 如果钱包散列已经存在, 返回已有链接
-   错误 (400): 有细节的校验错误
-   错误(404):未找到伙伴关系
-   错误 (500): 内部服务器出错

**示例答复:**

```json
{
  "code": "abc123xyz",
  "url": "https://awaken.tax/link?code=abc123xyz"
}
```

## API 参考

### `CryptoTaxSDK`

#### 构造器

```typescript
new CryptoTaxSDK(options: SDKOptions)
```

**选项 :**

-   `apiKey` (字符串,要求): 您的 API 键
-   `baseUrl` (字符串,可选):API的基础URL. 默认为 `https://api.link.awaken.tax`

#### 方法

##### `createLink(request: CreateLinkRequest): Promise<CreateLinkResponse>`

创建新的税收计算链接.

**参数:**

-   `request.wallets`: 钱包对象矩阵 `address` (必需)和可选 `name`

**回返情况:**

-   `code`: 链接的独特代码
-   `url`: 访问税收计算界面的完整 URL

## 常见问题

### @awakentax/crypto-tax 是什么？

对 Awaken 征税 SDK

### 如何安装 @awakentax/crypto-tax？

在项目目录运行 npm install @awakentax/crypto-tax，或使用 pnpm add / yarn add / bun add。

### @awakentax/crypto-tax 支持 TypeScript 吗？

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

### @awakentax/crypto-tax 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @awakentax/crypto-tax 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @awakentax/crypto-tax 可以商用吗？

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

### @awakentax/crypto-tax 的下载量有多少？

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

### @awakentax/crypto-tax 还在维护吗？

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