• WEB3官网导航 / 隐形基建01期 | 与全球开发者共创,全面解析OKX Web3钱包API官网更新时间:2024年8月15日 15:16
  • 隐形基建01期 | 与全球开发者共创,全面解析OKX Web3钱包API

    bg

    在创新基因驱动下,OKX Web3钱包内外兼修:向内不断优化产品,向外广泛探索共创。

    OKX Web3钱包在广泛探索共创方面,一方面不断引领代码开源,另一方面日益加强建设 API。此举在Blockchain技术生态系统中具有重要意义,这不仅促进了技术创新和开发效率的提高,还增强了系统的透明性、互操作性和安全性,推动了Web3社区和生态系统的建设,增加用户体验,并促进行业标准化。

    此外,OKX Web3钱包通过开源代码和开放 API,降低了开发门槛与建立了广泛链接,从而实现与全球开发者联动、共同学习、进步和创造,从而推动加密行业基础设施建设。

    像 API 这些日常用户在使用产品不易察觉、或者不太显化出来的功能,就如同 OKX Web3钱包的「隐形基建」,尽管重要,但鲜少被广泛用户悉知。由于市面上暂未有关于 OKX Web3钱包 API 相关的介绍内容,本文的重点将放在 API 层面,通过全面解析 OKX Web3 API 功能,希望可以吸引并帮助更多地开发者,将想法实现、将创新落地。

    这是 OKX Web3隐形基建第 1 期内容,也是 OKX Web3 API 系列第 1 期内容,第 2 期将通过对话的形式,深入挖掘 OKX Web3团队建设 API 背后的故事。

    OKX Web3钱包 API 框架

    API,全称为应用程序编程接口(Application Programming Interface),是一组定义和协议,用于构建和集成应用程序软件。API 允许不同的软件系统之间进行通信和数据交换。通过 API,开发者可以利用现有的功能和数据,而无需从头开始编写代码。API 可以显著提高开发效率,促进系统互操作性,并推动技术创新。

    作为行业领先的一站式Web3入口,OKX Web3 提供了一套完整的 Web3 开发解决方案——OnchainOS。作为多链 Web3 开发引擎,OnchainOS 在链和服务的接入实现了标准化,极大地降低了开发周期和投入成本,包含了钱包、DEX 聚合器、Marketplace、DeFi 等主要模块、以及交易流动性到链上数据方案等应有尽有。如果开发者希望搭建自己的 Web3 服务,采用 OnchainOS 将是更高效、更经济的选择。

    为了更好地服务开发者,极大降低开发门槛以及提高效率,OKX Web3 提供了非常全面、细致、且图文结合的 API 文档 ,感兴趣的开发者可以随时点击查看,并且按照步骤使用。

    OKX Web3钱包现已支持超过 100+公链,并提供 App、插件和网页三端统一的使用体验,涵盖钱包、DEX 聚合器、DeFi、NFT 市场和 DApp 探索等五大板块,且已上线Bitcoin铭文和符文交易市场,致力于为用户提供全面的 Web3 服务。

    接下来,文章将以钱包、DEX 聚合器、Marketplace、DeFi 板块为例,介绍部分 API 相关的内容。

    Wallet API

    作为整个产品的核心,钱包板块 API 提供非托管钱包的底层技术方案,可以帮助开发者轻松构建链上服务和应用。比如,Web3 多链钱包、 DApp 内置钱包、多链 Web3 应用、交易所钱包服务等等。

    钱包 API ,在钱包服务中有以下三大核心功能: 1)多链地址聚合,提供百万级地址资产统计能力;2)多场景,轻松接入 60+ 网络,支持异构多链生态及各 BTC 资产协议;3)高可用性、高稳定性。实施接口和系统监测,确保顺畅接入。

    开发者使用钱包 API,仅需 3 步,就能高效安全地搭建钱包,轻松接入 60+ 网络,包括热门的 EVM、Solana、TRON、BTC 等,还支持铭文等前沿的生态。后续钱包 API 将逐步提供 MPC 钱包和 AA 智能钱包账户的能力和解决方案。通过强大的钱包服务,可以充分满足开发者的的 Web3 钱包开发需求,并简化 Web3 钱包入门流程。

    具体而言,钱包 API 涵盖了多个核心模块,满足了用户基本的资产管理和交易需求。比如:地址与钱包生成,链上资产与币价信息查询,交易管理,以及币种信息、Gas 价格和地址授权信息等其他常用数据查询。其中,交易管理模块提供构建、签名、广播、追踪交易查询交易历史、支持 EVM 等账户模型网络的交易、支持 BTC 等 UTXO 模型网络的交易等非常丰富的服务。总的来看,开发者可以通过钱包 API,进行账户管理、资产管理、交易管理、常用信息查询、以及 Webhook(实时订阅链上数据)等等。

    第一,在账户管理方面。区别于一般的单地址查询模式,钱包 API 提供了多地址的结构化的订阅查询,开发者可以将多个地址关联于一个账户,高效地进行多链场景下的资产状态和交易历史查询。 钱包 API 提供了两种账户类型:钱包账户、观察账户。其中, 1)钱包账户需要提供消息签名用于鉴权,可以自由添加自定义Tokens,可以发送交易。2)观察账户无需提供消息签名,默认展示所有 OKX 平台所收录的Tokens,不能发送交易。

    开发者可以通过账户管理 API,创建钱包账户及管理钱包账户下的地址、聚合观察账户地址、更新钱包账户、更新观察账户、删除账户、查询创建过的账户列表、查询账户下的地址等等。

    第二,在资产管理方面。包含为账户添加订阅币种、获取对应资产余额数量,查看总资产和删除不再关心的资产。值得注意的是,对于钱包账户,开发者可以添加和管理自定义币种。对于观察账户,则无法自定义添加或管理,只能获取当前钱包 API 已支持的币种的资产余额。

    开发者可以通过资产管理 API,添加币种、获取钱包账户Tokens余额、获取观察账户Tokens余额、获取指定币种余额、获取币种总资产、删除币种、查询币种列表等等。

    第三,在交易管理方面。包含如何发送交易,以及查询交易记录。开发者可以通过交易管理 API,获取签名所需数据、Gas price、Gas limit、Nonce 等,并进行地址校验、按照交易哈希查询交易详情、按照订单 Id 询交易详情、按照账户查询交易列表、按照地址查询交易列表等等。

    第四,在其他的方面。开发者还可通过 API 进行 UTXO、币种信息等链相关信息查询;或者通过 Webhook,订阅区块事件和交易事件的相关数据,每次最多可以批量创建 20 个订阅等等。

    DEX 聚合器 API

    OKX DEX 聚合是一个一站式多链、DEX 和跨链聚合器,现已聚合 25+跨链、 40+公链、 400 多个 DEX 等,通过 X Routing 智能路由实现一笔交易同时使用多个 DEX,为用户提供更优价格、更佳流动性且 0 交易服务费,并同时拥有 DEX 行情板块、限价单、KYT 安全检测等功能。

    其核心主要包括单链 Swap 和 Bridge,单链 Swap 和 Bridge 都需要链上数据解析来完成整个交易过程。单链 Swap 和 Bridge 根据兑换的币对组合成不同的交易模式,例如可以通过源链 Swap + Bridge 完成交易,或者通过 Bridge 一步完成交易,以及 源链 Swap + Bridge + 目标链 Swap 形式完成跨链交易。其中,OKX DEX 聚合器自研的 XBridge 合约是整个交易中的核心,它支持主流 EVM 链之间的跨链,异构链之间的跨链、以及 EVM 链和异构链之间的跨链。

    开发者或者专业用户可以通过 DEX 聚合器 API 文档,来构建需要的 Web3 交易服务及应用,比如 Web3 钱包、DApp 项目和 DeFi 项目等多种应用场景。

    OKX DEX 聚合器 API 具有多链支持、多条跨链桥和多家 DEX 支持、以及稳定性和高可用性等核心亮点,其响应时间在 100 毫秒以内,同时可以免费提供更优的询价路径。当前,OKX DEX 聚合器 API 主要涵盖:兑换 API、跨链 API、限价单 API,在接入使用上方便、易懂、安全。

    第一,兑换功能方面,OKX DEX 聚合器聚合了例如 Uniswap、Curve、Balancer 等各Decentralization交易所 的流动性来源,并能够将单笔交易拆分到多个 DEX,通过高效的路由为用户提供更优价格。OKX DEX 聚合器将自动找到链上具有更佳流动性深度的流动性池,综合计算价格、滑点和交易成本,并通过智能订单拆分算法,基于 DEX 和 PMM 报价的综合比较,为用户选择更佳报价的三个维度:更大流动性、更低滑点、更优价格。

    开发者可以通过兑换 API,获取 OKX DEX 聚合器支持兑换的链、币种列表、流动性列表、交易授权、兑换价格、交易数据等等。

    第二,跨链功能方面,OKX DEX 聚合器聚合了例如 circle CCTP、 Stargate、Across、Wormhole、SWFT 等目前市面上优质的跨链桥 向用户提供多条跨链路径选择,可以实现先源链兑换再进行跨链桥交易,然后在目标链兑换为用户想要的Tokens。OKX DEX 聚合器自主研发的超优算法 X Routing 可以在源链交易时自动寻找链上深度更佳的流动性池,综合计算价格、滑点和交易成本,并通过智能订单拆分算法获得更优兑换数量。之后会在多个优质跨链桥进行比价,综合计算跨出数量、跨链桥费、滑点和交易成本后获得更优跨链报价。

    开发者可以通过跨链 API,获取 OKX DEX 聚合器支持跨链兑换的链、币种列表、桥信息、路径信息、交易授权、交易数据、查询交易状态等等。

    第三,限价功能方面,OKX DEX 聚合器限价单 (Limit Order) 是一种用户以指定目标价格在Decentralization交易所中买入或卖出Tokens的业务流程。如果当前市价能够满足用户指定的目标价格,DEX 聚合器会将订单自动完成交易。通过 DEX 限价单 API,用户可以通过接口创建和查询限价单并将流动性聚合入 DEX 聚合器中,享有更优价格。

    OKX DEX 聚合器限价单 API 具有限价单成交需要等待 DEX 聚合器用户吃单、限价单创建者无滑点、以及支持部分订单成交等特点,开发者可以通过限价单 API ,可以获取 OKX DEX 聚合器支持的链列表、交易授权、币种列表、创建限价单、查询限价单等等。

    Marketplace API

    OKX Marketplace 涵盖 EVM NFT 市场、Runes 市场、Ordinals 市场以及发行市场,支持 Bitcoin、Ethereum 等共计 26 条主流热门公链。

    第一,EVM NFT 市场方面。OKX NFT 市场是一个一站式Decentralization NFT 聚合交易平台,已聚合 Opensea,Magic Eden,Looksrare 等平台,支持 NFT 持有者同时在多个市场上架其 NFT 作品并可以更低的交易成本获得更高的流动性。此外,支还持多链 NFT 创作与跨平台交易,可以为用户和开发者提供实时链上数据,致力于Decentralization、多链的 NFT 生态构建。当前,OKX NFT 市场汇集了多个主流市场和平台的订单深度、并收录了海量的 NFT 合集数据,能够为开发者及用户提供及时的订单数据,能够提供实时准确的链上数据。

    OKX NFT API 提供数据查询和交易 2 大部分功能,数据方面包含 NFT 和合集信息查询,交易数据查询;交易方面:支持一键挂单到多个市场,同时批量购买多个市场中更低价订单。开发者可以通过 NFT 市场 API,获取 NFT 详情和列表、获取合集详情和列表、获取已经接入的网络和市场、查询挂单、出价单、购买订单等等。

    第二,OKX Runes 市场方面。OKX Runes 市场是行业首个在 APP 端提供符文交易的平台,支持用户零平台费进行 Runes 资产批量扫货、蚀刻等功能。未来,OKX Runes 市场将不断根据用户反馈优化并增加更多新功能。

    开发者可以通过 OKX Runes 市场 API,获取合集信息、获取热门合集、获取交易历史、获取钱包资产、获取订单信息、提交挂单等等。

    第三,OKX Web3钱包 Ordinals 市场是第一大 BRC 20 铭文和 BTC NFT 交易市场。OKX Ordinals 市场完全Decentralization,交互免平台服务费,并支持一站式转移、交易、铭刻 BRC-20 和 BTC NFT 等多个功能。

    开发者可以通过 Ordinals 市场 API,创建 Ordinals 挂单、获取铭文资产列表、提交挂单、获取 Ordinals 合集列表、订单、交易历史和相关模型等等。

    DeFi API

    OKX Web3 DeFi 是市场上领先的 一站式 DeFi 交易聚合平台,从而方便用户快速精准地找到符合他们需求的教育产品。OKX Web3 DeFi 目前已接入 80 多项协议,包括 Aave、Compound、Curve、Yearn 和 Uniswap,并支持超过 15 个网络,如 Arbitrum、Ethereum 和 Polygon 等。

    OKX Web3 DeFi API 详细描述了用户交易过程的数据交互流程、包含申购流程、赎回流程、以及领取奖励流程等。开发者将 OKX Web3 DeFi Open API 集成到应用中,可以使用户轻松快速地访问所有 DeFi 协议,并在交易 DeFi 的过程中享受赚币乐趣。

    具体而言,开发者可以通过 OKX Web3 DeFi API 实现多种功能。第一,在查询信息方面,支持开发者查询协议列表、Tokens列表、产品列表、产品详细、网络列表等。第二,在计算方面,支持查询认购的预估计算信息、查询赎回的预估计算信息。第三,在交易方面,支持生成交易前授权的调用数据、生成申购交易的调用数据、生成赎回交易的调用数据、生成领取奖励金交易的调用数据。第四,在用户层面,支持查询用户的持仓列表、查询用户的余额列表、查询用户的赎回申请列表。

    创新为基,与全球开发者同行

    在当今迅速发展的Blockchain和Crypto领域,开源和开放 API 已经成为推动技术创新和行业发展的重要驱动力。OKX Web3钱包通过推动代码开源和开放 API,不仅为全球开发者提供了稳定和可靠的技术支持、丰富的资源和便捷的工具,还促进了整个行业的透明性、互操作性和社区合作。

    其中,OKX Web3钱包 API 的设计和实现,正是基于对创新的深刻理解和不断追求。OKX Web3钱包通过 API 建设为全球开发者提供了一个强大而灵活的平台,一个访问和利用其平台功能的标准化接口,允许开发者在现有基础上进行创新,快速开发和部署新的Decentralization应用(DApps)。例如,开发者可以利用 API 接口,构建创新性的 DeFi 协议、Decentralization交易所 DEX 和其他Blockchain应用。让他们能够在Blockchain和Crypto领域中尽情发挥创造力和技术实力,提出新的创意和解决方案,共同推动技术的边界。

    与此同时,开放 API 让开发者和用户可以清晰地了解和使用 OKX Web3钱包的各项功能。这种透明性有助于增强用户对平台的信任,推动平台的普及和使用。例如,开发者可以通过 API 文档,了解每个接口的具体功能和使用方法,从而更好地利用这些资源进行开发。通过开放 API,OKX Web3钱包向社区展示了其开放和透明的态度。这种姿态不仅提升了平台的公信力,还吸引了更多的开发者和用户参与到生态系统中来,丰富整个生态系统的应用场景,共同推动平台的发展。

    从长远来看,通过吸引更多开发者和项目的加入,OKX Web3钱包能够与其他Blockchain平台和服务提供商进行深度集成,形成一个互联互通的Blockchain生态系统,不仅促进了整个Blockchain行业的技术进步和应用扩展,为构建一个更加开放和协作的生态系统奠定了坚实的基础。也推动了自身平台的繁荣。

    总之,OKX Web3在 API 上的建设,展现出了更高的格局,“现在做的,都是为了将来”。

    免责声明

    本文仅供参考。本文仅代表作者观点,不代表 OKX 立场。本文无意提供 (i) 投资建议或投资推荐; (ii) 购买、出售或持有数字资产的要约或招揽; (iii)财务、会计、法律或税务建议。我们不保证该等信息的准确性、完整性或有用性。持有的数字资产(包括稳定币和 NFTs)涉及高风险,可能会大幅波动。您应该根据您的财务状况仔细考虑交易或持有数字资产是否适合您。有关您的具体情况,请咨询您的法律/税务/投资专业人士。请您自行负责了解和遵守当地的有关适用法律和法规。

    声明