Skip to content

Releases: weisyn/contract-sdk-js

contract-sdk-js v0.1.1-alpha - 文档改进和类型定义优化

25 Nov 08:38

Choose a tag to compare

WES Smart Contract SDK for TypeScript/AssemblyScript v0.1.1-alpha

🔄 小版本更新

这是 WES Smart Contract SDK for TypeScript/AssemblyScript 的第二个 Alpha 版本,主要包含文档改进、TypeScript 类型定义优化和合约模板优化。


✨ 主要变更

📚 文档改进

  • ✅ 更新了 README 文档,完善了快速开始指南
  • ✅ 改进了 API 文档的结构和可读性
  • ✅ 更新了文档中的时间戳和版本信息
  • ✅ 完善了架构文档和设计说明
  • ✅ 改进了合约模板的文档和示例
  • ✅ 完善了 AssemblyScript 兼容性指南

🔷 TypeScript 改进

  • ✅ 优化了类型定义的完整性和准确性
  • ✅ 改进了类型推断,提供更好的 IDE 智能提示
  • ✅ 增强了类型安全性,减少运行时错误
  • ✅ 完善了泛型类型定义
  • ✅ 改进了 AssemblyScript 类型映射

📦 合约模板优化

  • ✅ 优化了标准合约模板的结构和代码质量
  • ✅ 改进了模板的注释和文档
  • ✅ 更新了模板的元数据和 ABI 定义
  • ✅ 完善了学习模板的示例代码
  • ✅ 改进了模板的构建脚本

🔧 Framework 改进

  • ✅ 改进了错误处理机制,提供更清晰的错误信息
  • ✅ 优化了交易构建器的 API
  • ✅ 增强了 Runtime 层的稳定性
  • ✅ 改进了合约基础结构的类型定义

🛠️ Helpers 改进

  • ✅ 优化了业务语义层的错误处理
  • ✅ 改进了 Token、NFT、Staking、Governance 等模块的 API
  • ✅ 增强了 External 模块的稳定性
  • ✅ 完善了 RWA 模块的功能

🛠️ 代码质量

  • ✅ 代码格式化和风格统一(ESLint、Prettier)
  • ✅ 改进了代码注释和 JSDoc 文档
  • ✅ 优化了部分函数的性能
  • ✅ 增强了类型安全性

🐛 Bug 修复

  • ✅ 修复了部分边界情况下的错误处理问题
  • ✅ 修复了文档中的时间戳显示问题
  • ✅ 修复了部分模板中的小错误
  • ✅ 修复了部分示例代码中的小错误
  • ✅ 修复了类型定义中的小问题

📦 安装

npm install @weisyn/contract-sdk-js@0.1.1-alpha
#
yarn add @weisyn/contract-sdk-js@0.1.1-alpha
#
pnpm add @weisyn/contract-sdk-js@0.1.1-alpha

🔄 从 v0.1.0-alpha 升级

兼容性

  • 无破坏性变更 - 本版本完全向后兼容 v0.1.0-alpha
  • ✅ 所有现有合约代码无需修改即可使用新版本
  • ✅ API 接口保持稳定
  • ✅ TypeScript 类型定义保持兼容
  • ✅ 合约模板保持兼容

升级步骤

  1. 更新 package.json 中的版本号:

    {
      "dependencies": {
        "@weisyn/contract-sdk-js": "0.1.1-alpha"
      }
    }
  2. 运行安装命令:

    npm install
    #
    yarn install
    #
    pnpm install
  3. 重新编译你的合约:

    npm run build:contract
    # 或使用 AssemblyScript 编译器
    asc contract.ts --target release --outFile contract.wasm

📚 文档


⚠️ 重要说明

这是 Alpha 版本,主要用于:

  • 功能验证和测试
  • 开发者反馈收集
  • API 稳定性验证
  • TypeScript 类型定义验证
  • 与 Go SDK 的功能对齐验证

不建议在生产环境使用


🔗 相关资源


📝 变更日志

改进

  • 文档结构和内容优化
  • TypeScript 类型定义优化
  • 合约模板优化
  • Framework 和 Helpers API 改进
  • 代码质量和性能优化

修复

  • 修复文档时间戳问题
  • 修复部分边界情况下的错误处理
  • 修复模板和示例代码中的小错误
  • 修复类型定义中的小问题

✅ 发布检查清单

  • 版本号已更新(package.json)
  • CHANGELOG.md 已更新
  • 所有测试通过
  • 文档已更新
  • Release 文档已填写完整
  • 代码已同步到发布仓库
  • GitHub Tag 已创建
  • GitHub Release 已创建
  • NPM 发布已完成

📝 发布备注

这是 WES Smart Contract SDK for TypeScript/AssemblyScript 的第二个 Alpha 版本,主要关注文档改进和 TypeScript 类型定义优化。所有变更都是向后兼容的,现有合约代码无需修改即可升级。


最后更新: 2025-11-25