Triển khai SDK

Việc gửi trực tiếp ABI cho các phòng ban ví dụ Frontend, Backend, Data Analysis để có thể tương tác với smartcontract một các thủ công sẽ dẫn đến nhiều bất tiện (Quản lý phiên bản không đồng nhất, các hàm side-effect không được chia sẻ,...). Vì vậy, việc phát triển một npm package sẽ tăng tốc quá trình hợp tác giữa các team.

npmjs.com

Cài đặt

Chúng ta sẽ thiết lập file tsconfig.json để hỗ trợ cả commonjs và esmodule.

commonjs giúp tương thích ngược với các phiên bản cũ, trong khi đó esmodule giúp tận dụng các cải tiến mới như tree-shaking, lazy import...

Thay dòng "main": "index.js", trong package.json thành

Đồng thời, thêm dist vào .gitignore.

Thiết kế SDK

Tạo file src/index.ts và cập nhật câu lệnh build

Chạy thử pnpm build ta sẽ được:

Xuất bản SDK

Chạy lệnh pnpm publish --access public

Lúc này ta sẽ được gói tin NPM cs01-2024.

Lưu ý vì tên gói tin cs01-2024 đã được sử dụng trong ví dụ này, các bạn cần sử dụng tên khác để tránh xung đột. Để đổi tên, các bạn có thể sử giá trị name trong package.json.

Phụ lục

Conventional Commitment