waas-echooo v1.0.30
**Preparation: nodejs v18+ required**
**Send email verification code**
**Basic Information**
Method name: initAuth
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
loginName | be | " zhangsan@gmail.com " | E-mail address |
authWay | be | "32" | 32:Email Verification Code, 34:Mobile Verification Code |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | in t | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value | ||||
authWay | string | be | 32:Email Verification Code, 34:Mobile Verification Code |
**Mailbox \ Google Login**
**Basic Information**
Method name: verifyCode
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
loginName | be | " zhangsan@gmail.com " | Email address, Google id |
authWay | be | "32" | Sending method, 32:Email CAPTCHA, 4:Google |
code | be | Email Captcha \ Google credentials |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | int | be | 0:Success | ||
message | be | Description of information | |||
data | return value | ||||
username | string | non-essential | user ID | ||
nickname | string | non-essential | user nickname | ||
nicknameSetTimes | string | non-essential | Number of nickname changes | ||
initPassword | boolean | non-essential | Whether to set a password | ||
string | non-essential | inbox | |||
phoneNumber | string | non-essential | cell phone | ||
backupEmail | string | non-essential | spare tank | ||
backupPhoneNumber | string | non-essential | spare cell phone | ||
hasOTPSecret | boolean | non-essential | Availability of totp | ||
hasPayPassword | boolean | non-essential | Whether there is a payment password | ||
signUpType | string | non-essential | Registration Methods | ||
accessToken | string | non-essential | |||
refreshToken | string | non-essential | |||
expiresIn | number | non-essential | |||
idToken | string | non-essential | |||
tokenType | string | non-essential | |||
remainTimes | number | non-essential | The password is also retried with the number of | ||
lockTime | number | non-essential | How long until it's unlocked? | ||
loginStatus | number | non-essential | Locked or not | ||
success | boolean | non-essential | Whether the login is successful or not | ||
newUser | boolean | non-essential | New user or not |
**Generate key with TSS**
**Basic Information**
Method name: createKey
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
Key | Array | be | Generate key2 and key3 |
**Send Transaction**
**Basic Information**
Method name: sendTransaction
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
walletAddress | be | Sender's wallet address | |
to | be | Recipient's wallet address | |
value | be | Amount sent | |
key2 | be | Value of key2 | |
chainId | be | chain id | |
type | be | Transaction type 0:non-1559, 2:1559 | |
tokenMsg | non-essential | {tokenAddress: token address, decimals: token decimal places} | eoa transactions are null, erc20 transactions need to pass relevant parameters |
gasLimitPrice | non-essential | {maxPriorityFeePerGas: "1275",maxFeePerGas: "9181",gasLimit: "23100"} | gas limit, gas price |
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
type | in t | non-essential | Is it a 1559 transaction | ||
nonce | in t | non-essential | Nonce | ||
chainId | int | non-essential | chain id | ||
maxPriorityFeePerGas | string | non-essential | |||
maxFeePerGas | bigNumber | non-essential | |||
gasPrice | bigNumber | non-essential | |||
gasLimit | bigNumber | non-essential | |||
to | string | non-essential | |||
value | bigNumber | non-essential | Amount sent | ||
data | string | non-essential | |||
accessList | array | non-essential | |||
hash (computing) | string | non-essential | Transaction hash | ||
v | Int | non-essential | |||
r | string | non-essential | |||
s | string | non-essential | |||
from | string | non-essential | Sender's wallet address | ||
confirmations | non-essential |
**signature message**
**Basic Information**
Method name: signMessage
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
sideId | be | key type | |
walletAddress | be | Wallet Address | |
message | be | signature message | |
key2 | be | key2 | |
signType | be | Whether to verify the signature. true: yes, false: not required | |
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
signatured | String | be | Signed message |
**Transaction reporting**
**Basic Information**
Method name: recordOrder
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
chainId | be | chain id | |
tokenValueList | be | "0.1" | Transaction amount (eth) |
tokenSymbolList | "ETH" | Currency abbreviation | |
type | 2 | Order type, 1 vip, 2 eoa, 3 wallet-connect | |
gmtCreate | User creation time | ||
transactionType | 0 | 0: Normal transaction, 1: Accelerated transaction, 2: Canceled transaction | |
toAddress | target address | ||
transactionHash | Transaction Hash | ||
subType | 1 | Order Subtypes 1. transfer, 2. swap 3. deposit, 4. withdraw, 5. stake, 6. create_vault, 7. add_guardian, 8. revoke_guardian, 9. add_whitelist, 10. remove_whitelist, 11 recovery 12 approve whitelist, 11. recovery 12 approve, 13. wc Wallet Connect, 14. wc Approve Spend Limit, 15. wc Approve Tx 16. Batch Transfer, 17. Receive 18. nft make offer, 19. nft accept offer, 20. nft approve sale, 21. fix price sale, 22. fix price buy, 23. dutch auction sale, 24. ductch auction buy, 25. english auction sale, 27. 26. ductch auction buy, 27. deposit, 28. cancel nft offer, 29. cancel pending nft, 30. cancel auction nft, 31. cancel auction nft, 32. subscribe, 33. redeem, 34. receive reward | |
wallet | Wallet Address | ||
tokenAddressList | The token_address of the incoming and outgoing amounts, separated by ";", e.g., "0xxxxx;0x..." | ||
accessToken | access token | ||
partnerId | partner id | ||
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | int | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value | ||||
orderId | string | be | Order id |
**Transaction Details**
**Basic Information**
Method name: activityDetail
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
accessToken | be | access token | |
orderId | be | "32" | Order id |
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | in t | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value | ||||
baseFeePerGas | number | non-essential | Transaction baseFeePerGas | format: biginteger | |
chainId | integer | non-essential | Chain Id | format: int32 | |
data | string | non-essential | Transaction data | ||
detail | string | non-essential | Order details data, client-side custom management, structured json strings | ||
failReason | string | non-essential | Reasons for transaction failure, L2 only | ||
from | string | non-essential | Transactions from | ||
gasFee | number | non-essential | Trading gasFee | format: biginteger | |
gasLimit | number | non-essential | Trading gasLimit | format: biginteger | |
gasPrice | number | non-essential | Trade gasPrice, tx cancel must be reversed | format: biginteger | |
gasTokenAddress | string | non-essential | The address of the gas payment token, which is not passed by default is the native token | ||
gmtCreate | integer | non-essential | Creation Time, Timestamp | format: int64 | |
gmtFinish | integer | non-essential | Completion time, timestamp | format: int64 | |
gmtSubmit | integer | non-essential | Submission Time, Timestamp | format: int64 | |
id | string | non-essential | Order Id | ||
maxFeePerGas | number | non-essential | Trading maxFeePerGas | format: biginteger | |
maxPriorityFeePerGas | number | non-essential | Transaction maxPriorityFeePerGas | format: biginteger | |
nonce | number | non-essential | Transaction nonce | format: biginteger | |
notice | string | non-essential | Server-side transaction alerts, such as estimated time | ||
relateTransactionList | object [] | non-essential | Associative hash, accelerated or canceled, in order | item Type: object | |
baseFeePerGas | number | non-essential | Transaction baseFeePerGas | format: biginteger | |
gasFee | number | non-essential | Consumed gas, tx Cancel must be reversed | format: biginteger | |
gasLimit | number | non-essential | Trade gasLimit, tx cancel must reverse | format: biginteger | |
gasPrice | number | non-essential | Trade gasPrice, tx cancel must be reversed | format: biginteger | |
gmtCreate | integer | non-essential | Creation time, Timestamp | format: int64 | |
gmtFinish | integer | non-essential | Completion time, timestamp | format: int64 | |
gmtSubmit | integer | non-essential | Submission Time, Timestamp | format: int64 | |
maxFeePerGas | number | non-essential | Trading maxFeePerGas | format: biginteger | |
maxPriorityFeePerGas | number | non-essential | Transaction maxPriorityFeePerGas | format: biginteger | |
remark | string | non-essential | Remarks on sub-transactions | ||
status | integer | non-essential | order status, 1: Submitted, 2: Fail, 3: Success, 4: Cancel | format: int32 | |
transactionHash | string | non-essential | transactionHash | ||
type | integer | non-essential | 0 Ordinary transaction 1 Accelerated, 2 Canceled | format: int32 | |
remark | string | non-essential | note | ||
status | integer | non-essential | Order status, 1: Submited, 2: Fail, 3: Success, 4: Cancel, 5: Confirmation in progress | format: int32 | |
subType | integer | non-essential | Order Subtypes 1. transfer, 2. swap 3. deposit, 4. withdraw, 5. stake, 6. create_vault, 7. add_guardian, 8. revoke_guardian, 9. add_whitelist, 10. remove_whitelist, 11 recovery 12 approve whitelist, 11. recovery 12 approve, 13. wc Wallet Connect, 14. wc Approve Spend Limit, 15. wc Approve Tx 16. Batch Transfer, 17. Receive 18. nft make offer, 19. nft accept offer, 20. nft approve sale, 21. fix price sale, 22. fix price buy, 23. dutch auction sale, 24. ductch auction buy, 25. english auction sale, 27. 26. english auction buy, 27. ramp, 28. cancel make offer, 29. cancel fix price sale, 30. cancel ductch auction sale, 31. cancel english auction sale, 32. subscription , 33. redeem, 34. collect reward | format: int32 | |
to | string | non-essential | Trading to | ||
toAddress | string | non-essential | target address | ||
tokenAddressList | string | non-essential | The token_address of the incoming and outgoing amounts, separated by ";", e.g. "0xxxxx", "0x..." | ||
tokenSymbolList | string | non-essential | The token symbol for the amount of money coming in and going out, separated by ";", e.g.: eth,dai,usdt | ||
tokenValueList | string | non-essential | The number of incoming and outgoing amounts, separated by ";", with negative numbers being expenditures and positive numbers being income, e.g. -2,500,+1500 | ||
transactionHash | string | non-essential | Master transaction hash on the uplink | ||
txDetail | object | non-essential | TxRecodDetailDTO | Remarks: TxRecodDetailDTO | |
txId | string | non-essential | vip tx trading id | ||
type | integer | non-essential | Order type, 1 vip, 2 eoa, 3 wallet-connect | format: int32 | |
value | number | non-essential | Transaction value | format: biginteger | |
wallet | string | non-essential | Trading wallets, reporting | ||
walletName | string | non-essential | Name of the trading wallet | ||
wcAppName | string | non-essential | Name of the wallet-connect authorization Dapp | ||
wcData | string | non-essential | wallet-connect authorization dapp data | ||
wcMessage | string | non-essential | wallet-connect Authorization Dapp's message | ||
wcUrl | string | non-essential | The url of the wallet-connect authorization dapp. | ||
currentBlock | number | non-essential | Trading Current Blocks | ||
nftMessage | object | non-essential | nft related information | Remarks: nft-related information | |
nftMetadata | string | non-essential | nft's metadata information in json format | ||
nftOfferAmount | string | non-essential | quoted price | ||
nftOfferDeadline | string | non-essential | Deadline for the quotation, time stamp | ||
nftSaleAmount | string | non-essential | list price | ||
nftSaleDeadline | string | non-essential | Deadline of validity of the listing, timestamp | ||
nftStartAuctionAmount | string | non-essential | starting price | ||
nftEndAuctionAmount | string | non-essential | closing price | ||
nftTokenSymbol | string | non-essential | nft price token symbol | ||
nftTokenAddress | string | non-essential | nft price token address | ||
nftOrderStatus | number | non-essential | nft order status, 1: pending, 2: timeout, 3: finish, 4: cancel | ||
batchTransferTargetAddressList | string | non-essential | Destination address for batch transfer, separated by ";", "0xxxxx"; "0x..." | ||
batchTransferAmountList | string | non-essential | Batch transfer the corresponding quantity of the target address, separated by ";", e.g.: -2,500,+1500 | ||
rampSource | string | non-essential | Deposit Order Source | ||
rampOrderId | string | non-essential | Deposit Order Source ID | ||
defiProtocol | string | non-essential | |||
message | string | non-essential | Message | ||
traceId | string | non-essential | invocation link trace code |
**Get token details**
**Basic Information**
Method name: tokenDetail
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
addresses | be | "0x000... .00000,0xdb2... .beae3," | Token addresses, separated by commas |
chainId | be | "5" | 32:Email Verification Code, 34:Mobile Verification Code |
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | in t | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value | ||||
id | number | necessarily | |||
coingeckoId | string | necessarily | coingeckoId | ||
symbol | string | necessarily | token symbol | ||
chainId | number | necessarily | cable length (= 1 | ||
address | string | necessarily | |||
name | string | necessarily | token name | ||
balance | string | necessarily | |||
decimals | string | necessarily | |||
logo | string | necessarily | icon (computing) | ||
high | string | necessarily | 24h Highest price | ||
low | string | necessarily | 24h Lowest Price | ||
price24hChangePercent | string | necessarily | 24h increase | ||
price | string | necessarily | current price | ||
totalAmount | string | necessarily | |||
isAdded | string | necessarily | |||
addedTime | string | necessarily | |||
lastUpdatedTime | string | necessarily | |||
traceId | null | necessarily |
**Get gas limit ,gas price**
**Basic Information**
Method name: getGasPriceLimit
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
chainId | be | chain id | |
from | be | Send wallet address | |
to | be | target address | |
data | be | Transaction data | |
value | be | Transaction amount | |
accessToken | be | access token | |
gasType | be | 1:gas limit, 2:gas price |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | int | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value | ||||
gasLimit | string | be | gas limit | Gets when gasType="1". | |
fast | object | necessarily | plain-spoken | Remarks: Fast | |
confirmationTime | string | necessarily | Unit Seconds | mock: 30 | |
minCost | string | necessarily | Minimum spend USD or rmb This field is deprecated and is calculated by the client based on currency units | mock: 0.5 | |
maxCost | string | necessarily | Max Spend $ or rmb This field is deprecated and is calculated by the client based on currency units | mock: 0.8 | |
minGas | string | necessarily | Spend gas Unit eth This field is deprecated and is calculated by the client according to PRD rules | mock: 0.000002 | |
maxGas | string | necessarily | Spend gas Unit eth This field is deprecated and is calculated by the client according to PRD rules | mock: 0.000002 | |
minGasPrice | string | necessarily | gas price unit wei This field represents the gasPrice of the Legacy transaction. | mock: 38000000000 | |
maxGasPrice | string | necessarily | gas price unit wei This field is deprecated and will not be used. | mock: 38000000000 | |
maxPriorityFeePerGas | string | necessarily | wei | mock: 70000000000 | |
maxFeePerGas | string | necessarily | wei | mock: 90000000000 | |
slow | object | necessarily | slowly | Remarks: Slow | |
confirmationTime | string | necessarily | Unit Seconds | mock: 30 | |
minCost | string | necessarily | Minimum spend USD or rmb This field is deprecated and is calculated by the client based on currency units | mock: 0.5 | |
maxCost | string | necessarily | Max Spend $ or rmb This field is deprecated and is calculated by the client based on currency units | mock: 0.8 | |
minGas | string | necessarily | Spend gas Unit eth This field is deprecated and is calculated by the client according to PRD rules | mock: 0.000002 | |
maxGas | string | necessarily | Spend gas Unit eth This field is deprecated and is calculated by the client according to PRD rules | mock: 0.000002 | |
minGasPrice | string | necessarily | gas price unit wei This field represents the gasPrice of the Legacy transaction. | mock: 38000000000 | |
maxGasPrice | string | necessarily | gas price unit wei This field is deprecated and will not be used. | mock: 38000000000 | |
maxPriorityFeePerGas | string | necessarily | |||
maxFeePerGas | string | necessarily | |||
propose | object | necessarily | (an official) standard | Remarks: Standard | |
confirmationTime | string | necessarily | Unit Seconds | mock: 30 | |
minCost | string | necessarily | Minimum spend USD or rmb This field is deprecated and is calculated by the client based on currency units | mock: 0.5 | |
maxCost | string | necessarily | Max Spend $ or rmb This field is deprecated and is calculated by the client based on currency units | mock: 0.8 | |
minGas | string | necessarily | Spend gas Unit eth This field is deprecated and is calculated by the client according to PRD rules | mock: 0.000002 | |
maxGas | string | necessarily | Spend gas Unit eth This field is deprecated and is calculated by the client according to PRD rules | mock: 0.000002 | |
minGasPrice | string | necessarily | gas price unit wei This field represents the gasPrice of the Legacy transaction. | mock: 38000000000 | |
maxGasPrice | string | necessarily | gas price unit wei This field is deprecated and will not be used. | mock: 38000000000 | |
maxPriorityFeePerGas | string | necessarily | |||
maxFeePerGas | string | necessarily | |||
suggestBaseFee | string | necessarily | base cost | mock: 16 | |
gasLimit | string | necessarily | gaslimit | mock: 21000 | |
exchangeRate | string | necessarily | Exchange rate eth against the United States dollar | mock: 1250 | |
transferAllRemainRate | number | necessarily | Percentage of all remaining transfers |
**Getting a list of transactions**
**Basic Information**
Method name: getActivitiesList
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
current | be | pagination | |
pageSize | be | Number of articles per page | |
wallet | be | Wallet Address | |
chainId | be | chain id | |
partnerId | be | partner id | |
tokenAddress | non-essential | Token address | |
accessToken | be | access token |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | in t | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value | ||||
count | string | inessential | total number of articles | ||
hash (computing) | string | inessential | hash (computing) | ||
partner_id | string | inessential | partner id | ||
order_id | string | inessential | order id | ||
chain_id | Int | inessential | chain id | ||
value | string | inessential | Transaction amount | ||
from | string | inessential | Send wallet address | ||
to | string | inessential | target address | ||
gmt_create | string | inessential | Transaction creation time |
**Add user-defined token**
**Basic Information**
Method name: addUserToken
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
tokenAddresses | be | Token address (array) | |
walletAddress | be | User wallet address | |
chainId | be | 5 | chain id |
partnerId | be | partner id | Partner id |
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | in t | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value |
**Query the user's default token**
**Basic Information**
Method name: userTokenDetail
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
walletAddress | be | User wallet address | |
chainId | be | chain id | |
partnerId | be | partner id | partner id |
current | non-essential | pagination | |
pageSize | non-essential | Number of items per page | |
inputSymbol | non-essential | Keywords for fuzzy queries | |
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | in t | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value | ||||
logo | string | non-essential | The token's logo address | ||
wallet | string | be | User wallet address | ||
partner_id | string | be | partner id | ||
token_addr | string | be | Token address | ||
chain_id | int | be | chain id | ||
is_deleted | int | be | Delete or not. 0: not required, 1: yes | ||
symbol | string | be | Token abbreviation |
**Query system default popular currencies**
**Basic Information**
Method name: tokenAll
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
chainId | be | chain id | |
addresses | non-essential | Array of tokens | |
hot | non-essential | Is it a popular currency. 0: not required, 1: yes | |
isDefault | non-essential | Default or not. 0:not required, 1:yes | |
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | in t | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value | ||||
symbol | string | be | 32:Email Verification Code, 34:Mobile Verification Code | ||
chain_id | Int | be | chain id | ||
name | string | be | Token name | ||
address | string | be | Token address | ||
decimals | int | be | number of decimal places | ||
logo | string | be | logo | ||
hot | int | be | Popular or not. 0:not required, 1:yes |
**Query user-defined token**
**Basic Information**
Method name: customTokenList
**parameters**
**Parameter name** | **compulsory** | **typical example** | **note** |
---|---|---|---|
wallet | be | User wallet address | |
chainId | be | chain id | |
partnerId | be | partner id | partner id |
current | non-essential | pagination | |
pageSize | non-essential | Number of items per page | |
accessToken | be | The accessToken returned by verifyCode. |
**Return data**
**name (of a thing)** | **typology** | **compulsory** | **default value** | **note** | **Other information** |
---|---|---|---|---|---|
code | in t | be | 0: Success, other failures | ||
message | string | be | Description of information | ||
data | return value | ||||
logo | string | non-essential | The token's logo address | ||
wallet | string | be | User wallet address | ||
partner_id | string | be | partner id | ||
address | string | be | Token address | ||
chain_id | int | be | chain id | ||
symbol | string |
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago