📥Installation

Node Version

Node Version Requirement

ETransfer SDK requires Node.js version 18 or above (v20 recommended). You can manage multiple versions of Node.js on the same machine with n, nvm.

Install

@etransfer/core

If you want to use the packaged authorization and withdrawal functions directly, please install the package as follows.

Commands

To install the package, use one of the following commands.

npm install @etransfer/core
# OR
yarn add @etransfer/core

Project Dependencies

@etransfer/core's peer dependencies are listed below, they need to be installed together.

{
  "@portkey/types": "2.4.0",
  "aelf-sdk": "^3.4.7",
  "bignumber.js": "^9.1.0",
  "query-string": "^7.1.1"
}

@etransfer/utils

If you want to use common methods, such as operating contracts, formatting error messages, etc, please install the package as follows.

Commands

To install the package, use one of the following commands.

npm install @etransfer/utils
# OR
yarn add @etransfer/utils

Project Dependencies

@etransfer/utils's peer dependencies are listed below, they need to be installed together.

{
  "@portkey/contracts": "^2.4.0",
  "@portkey/types": "^2.4.0",
  "@portkey/utils": "^2.4.0",
  "aelf-sdk": "^3.4.7",
  "bignumber.js": "^9.1.0",
  "query-string": "^7.1.1"
}

@etransfer/ui-react

If you want to use common methods, such as operating contracts, formatting error messages, etc, please install the package as follows.

Commands

To install the package, use one of the following commands.

npm install @etransfer/ui-react
# OR
yarn add @etransfer/ui-react

Project Dependencies

@etransfer/ui-react's peer dependencies are listed below, they need to be installed together.

{
  "aelf-sdk": "^3.4.8",
  "react": "^18.2.0",
  "react-dom": "^18.2.0"
}

@etransfer/socket

If you want to use WebSocket technology, such as listening to message notifications, please install this package as follows.

Commands

To install the package, use one of the following commands.

npm install @etransfer/socket
# OR
yarn add @etransfer/socket