@consensys/on-ramp-sdk

中文文档
2.1.14发布于 2026/07/02ISCTypeScriptCommonJS近 30 天下载 12.9万

开始

此软件包已被标记为弃用

This package is deprecated. Use @metamask/money-mvmt-sdk instead.

中文使用文档
文档目录8 节
  1. 开始
  2. 打开 SDK
  3. 带有 MetaMask 组合的本地开发
  4. 1. 更新SDK配置
  5. 2. 将SDK与组合链接
  6. 3. 安装依赖
  7. 4. 更新虚拟配置
  8. 5. SDK 更改后重建

打开 SDK

开始

  • 请确定是否有 OnRamp API 服务, 或是您正在本地运行 .
  • 从归档中安装 SDK 包 .
  • 用此代码导入斜坡 sdk : import {OnRampSdk} from '@codefi/on-ramp-sdk'

打开 SDK

为了方便后端交互,可以使用SDK.

你可以这样使用:

const sdk: IOnRampSdk = await OnRampSdk.getSDK(
  Environment.Staging,
  Context.Mobile,
  {
    verbose: true,
    maxInstanceCount: 1,
  },
)

带有 MetaMask 组合的本地开发

要将本地的 SDK 实例连接到本地的 MetaMask 组合客户端, 请遵循这些步骤 :

1. 更新SDK配置

  1. 打开 tsconfig.json sDK 项目中的文件.
  2. 修改 module 财务报告和审定财务报表 moduleResolution 属性如下:
    {
      "compilerOptions": {
        "module": "esnext",
        "moduleResolution": "node"
        // other configurations
      }
    }
    
  1. 在 SDK 项目目录中,运行以下命令以创建符号链接:

    yarn link
    
  2. 在组合项目目录中,通过运行链接 SDK :

    yarn link @consensys/on-ramp-sdk
    
  3. 删除缓存以确保更改生效 :

    rm -rf node_modules/.cache
    

3. 安装依赖

  1. 在组合项目目录中,安装必要的软件包:
    yarn install
    

4. 更新虚拟配置

  1. 打开 vite.config.js 组合工程中的文件.
  2. 添加以下配置,将SDK排除在依赖优化之外:
    export default {
      // other configurations
      optimizeDeps: {
        exclude: ['@consensys/on-ramp-sdk'],
      },
    }
    

5. SDK 更改后重建

当您对 SDK 进行更改时, 请记住要重建项目, 以反映组合客户端中的这些更改 :

yarn build

版本与发布记录

@consensys/on-ramp-sdk 共发布 247 个版本,首次发布于 2022/04/06;过去 12 个月发布了 2 个版本。

版本发布日期距今
2.1.14latest2026/07/024 个月前
2.1.132026/06/045 个月前
2.1.122025/10/301 年前
2.1.112025/09/131.2 年前
2.1.102025/05/291.5 年前
2.1.92025/05/291.5 年前

其他发布通道:beta → 1.28.7-beta.2。

关于 @consensys/on-ramp-sdk 的常见问题

@consensys/on-ramp-sdk 是什么?

开始注意:该包已被作者标记为弃用——This package is deprecated. Use @metamask/money-mvmt-sdk instead.

如何安装 @consensys/on-ramp-sdk?

在项目目录运行 npm install @consensys/on-ramp-sdk,或使用 pnpm add / yarn add / bun add。

@consensys/on-ramp-sdk 支持 TypeScript 吗?

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

@consensys/on-ramp-sdk 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@consensys/on-ramp-sdk 可以商用吗?

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

@consensys/on-ramp-sdk 的下载量有多少?

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

@consensys/on-ramp-sdk 还在维护吗?

最新版本 2.1.14 发布于 2026/07/02(4 个月前);至今共发布 247 个版本,其中过去 12 个月发布了 2 个;首次发布于 2022/04/06。作者已将其标记为弃用,新项目建议寻找替代方案。