1.0.30 • Published 10 months ago

waas-echooo v1.0.30

Weekly downloads
-
License
ISC
Repository
-
Last release
10 months ago

**Preparation: nodejs v18+ required**

**Send email verification code**

**Basic Information**

Method name: initAuth

**parameters**

**Parameter name****compulsory****typical example****note**
loginNamebe" zhangsan@gmail.com "E-mail address
authWaybe"32"32:Email Verification Code, 34:Mobile Verification Code

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codein tbe0: Success, other failures
messagestringbeDescription of information
datareturn value
authWaystringbe32:Email Verification Code, 34:Mobile Verification Code

**Mailbox \ Google Login**

**Basic Information**

Method name: verifyCode

**parameters**

**Parameter name****compulsory****typical example****note**
loginNamebe" zhangsan@gmail.com "Email address, Google id
authWaybe"32"Sending method, 32:Email CAPTCHA, 4:Google
codebeEmail Captcha \ Google credentials

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codeintbe0:Success
messagebeDescription of information
datareturn value
usernamestringnon-essentialuser ID
nicknamestringnon-essentialuser nickname
nicknameSetTimesstringnon-essentialNumber of nickname changes
initPasswordbooleannon-essentialWhether to set a password
emailstringnon-essentialinbox
phoneNumberstringnon-essentialcell phone
backupEmailstringnon-essentialspare tank
backupPhoneNumberstringnon-essentialspare cell phone
hasOTPSecretbooleannon-essentialAvailability of totp
hasPayPasswordbooleannon-essentialWhether there is a payment password
signUpTypestringnon-essentialRegistration Methods
accessTokenstringnon-essential
refreshTokenstringnon-essential
expiresInnumbernon-essential
idTokenstringnon-essential
tokenTypestringnon-essential
remainTimesnumbernon-essentialThe password is also retried with the number of
lockTimenumbernon-essentialHow long until it's unlocked?
loginStatusnumbernon-essentialLocked or not
successbooleannon-essentialWhether the login is successful or not
newUserbooleannon-essentialNew user or not

**Generate key with TSS**

**Basic Information**

Method name: createKey

**parameters**

**Parameter name****compulsory****typical example****note**
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
KeyArraybeGenerate key2 and key3

**Send Transaction**

**Basic Information**

Method name: sendTransaction

**parameters**

**Parameter name****compulsory****typical example****note**
walletAddressbeSender's wallet address
tobeRecipient's wallet address
valuebeAmount sent
key2beValue of key2
chainIdbechain id
typebeTransaction type 0:non-1559, 2:1559
tokenMsgnon-essential{tokenAddress: token address, decimals: token decimal places}eoa transactions are null, erc20 transactions need to pass relevant parameters
gasLimitPricenon-essential{maxPriorityFeePerGas: "1275",maxFeePerGas: "9181",gasLimit: "23100"}gas limit, gas price
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
typein tnon-essentialIs it a 1559 transaction
noncein tnon-essentialNonce
chainIdintnon-essentialchain id
maxPriorityFeePerGasstringnon-essential
maxFeePerGasbigNumbernon-essential
gasPricebigNumbernon-essential
gasLimitbigNumbernon-essential
tostringnon-essential
valuebigNumbernon-essentialAmount sent
datastringnon-essential
accessListarraynon-essential
hash (computing)stringnon-essentialTransaction hash
vIntnon-essential
rstringnon-essential
sstringnon-essential
fromstringnon-essentialSender's wallet address
confirmationsnon-essential

**signature message**

**Basic Information**

Method name: signMessage

**parameters**

**Parameter name****compulsory****typical example****note**
sideIdbekey type
walletAddressbeWallet Address
messagebesignature message
key2bekey2
signTypebeWhether to verify the signature. true: yes, false: not required
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
signaturedStringbeSigned message

**Transaction reporting**

**Basic Information**

Method name: recordOrder

**parameters**

**Parameter name****compulsory****typical example****note**
chainIdbechain id
tokenValueListbe"0.1"Transaction amount (eth)
tokenSymbolList"ETH"Currency abbreviation
type2Order type, 1 vip, 2 eoa, 3 wallet-connect
gmtCreateUser creation time
transactionType00: Normal transaction, 1: Accelerated transaction, 2: Canceled transaction
toAddresstarget address
transactionHashTransaction Hash
subType1Order 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
walletWallet Address
tokenAddressListThe token_address of the incoming and outgoing amounts, separated by ";", e.g., "0xxxxx;0x..."
accessTokenaccess token
partnerIdpartner id
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codeintbe0: Success, other failures
messagestringbeDescription of information
datareturn value
orderIdstringbeOrder id

**Transaction Details**

**Basic Information**

Method name: activityDetail

**parameters**

**Parameter name****compulsory****typical example****note**
accessTokenbeaccess token
orderIdbe"32"Order id
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codein tbe0: Success, other failures
messagestringbeDescription of information
datareturn value
baseFeePerGasnumbernon-essentialTransaction baseFeePerGasformat: biginteger
chainIdintegernon-essentialChain Idformat: int32
datastringnon-essentialTransaction data
detailstringnon-essentialOrder details data, client-side custom management, structured json strings
failReasonstringnon-essentialReasons for transaction failure, L2 only
fromstringnon-essentialTransactions from
gasFeenumbernon-essentialTrading gasFeeformat: biginteger
gasLimitnumbernon-essentialTrading gasLimitformat: biginteger
gasPricenumbernon-essentialTrade gasPrice, tx cancel must be reversedformat: biginteger
gasTokenAddressstringnon-essentialThe address of the gas payment token, which is not passed by default is the native token
gmtCreateintegernon-essentialCreation Time, Timestampformat: int64
gmtFinishintegernon-essentialCompletion time, timestampformat: int64
gmtSubmitintegernon-essentialSubmission Time, Timestampformat: int64
idstringnon-essentialOrder Id
maxFeePerGasnumbernon-essentialTrading maxFeePerGasformat: biginteger
maxPriorityFeePerGasnumbernon-essentialTransaction maxPriorityFeePerGasformat: biginteger
noncenumbernon-essentialTransaction nonceformat: biginteger
noticestringnon-essentialServer-side transaction alerts, such as estimated time
relateTransactionListobject []non-essentialAssociative hash, accelerated or canceled, in orderitem Type: object
baseFeePerGasnumbernon-essentialTransaction baseFeePerGasformat: biginteger
gasFeenumbernon-essentialConsumed gas, tx Cancel must be reversedformat: biginteger
gasLimitnumbernon-essentialTrade gasLimit, tx cancel must reverseformat: biginteger
gasPricenumbernon-essentialTrade gasPrice, tx cancel must be reversedformat: biginteger
gmtCreateintegernon-essentialCreation time, Timestampformat: int64
gmtFinishintegernon-essentialCompletion time, timestampformat: int64
gmtSubmitintegernon-essentialSubmission Time, Timestampformat: int64
maxFeePerGasnumbernon-essentialTrading maxFeePerGasformat: biginteger
maxPriorityFeePerGasnumbernon-essentialTransaction maxPriorityFeePerGasformat: biginteger
remarkstringnon-essentialRemarks on sub-transactions
statusintegernon-essentialorder status, 1: Submitted, 2: Fail, 3: Success, 4: Cancelformat: int32
transactionHashstringnon-essentialtransactionHash
typeintegernon-essential0 Ordinary transaction 1 Accelerated, 2 Canceledformat: int32
remarkstringnon-essentialnote
statusintegernon-essentialOrder status, 1: Submited, 2: Fail, 3: Success, 4: Cancel, 5: Confirmation in progressformat: int32
subTypeintegernon-essentialOrder 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 rewardformat: int32
tostringnon-essentialTrading to
toAddressstringnon-essentialtarget address
tokenAddressListstringnon-essentialThe token_address of the incoming and outgoing amounts, separated by ";", e.g. "0xxxxx", "0x..."
tokenSymbolListstringnon-essentialThe token symbol for the amount of money coming in and going out, separated by ";", e.g.: eth,dai,usdt
tokenValueListstringnon-essentialThe number of incoming and outgoing amounts, separated by ";", with negative numbers being expenditures and positive numbers being income, e.g. -2,500,+1500
transactionHashstringnon-essentialMaster transaction hash on the uplink
txDetailobjectnon-essentialTxRecodDetailDTORemarks: TxRecodDetailDTO
txIdstringnon-essentialvip tx trading id
typeintegernon-essentialOrder type, 1 vip, 2 eoa, 3 wallet-connectformat: int32
valuenumbernon-essentialTransaction valueformat: biginteger
walletstringnon-essentialTrading wallets, reporting
walletNamestringnon-essentialName of the trading wallet
wcAppNamestringnon-essentialName of the wallet-connect authorization Dapp
wcDatastringnon-essentialwallet-connect authorization dapp data
wcMessagestringnon-essentialwallet-connect Authorization Dapp's message
wcUrlstringnon-essentialThe url of the wallet-connect authorization dapp.
currentBlocknumbernon-essentialTrading Current Blocks
nftMessageobjectnon-essentialnft related informationRemarks: nft-related information
nftMetadatastringnon-essentialnft's metadata information in json format
nftOfferAmountstringnon-essentialquoted price
nftOfferDeadlinestringnon-essentialDeadline for the quotation, time stamp
nftSaleAmountstringnon-essentiallist price
nftSaleDeadlinestringnon-essentialDeadline of validity of the listing, timestamp
nftStartAuctionAmountstringnon-essentialstarting price
nftEndAuctionAmountstringnon-essentialclosing price
nftTokenSymbolstringnon-essentialnft price token symbol
nftTokenAddressstringnon-essentialnft price token address
nftOrderStatusnumbernon-essentialnft order status, 1: pending, 2: timeout, 3: finish, 4: cancel
batchTransferTargetAddressListstringnon-essentialDestination address for batch transfer, separated by ";", "0xxxxx"; "0x..."
batchTransferAmountListstringnon-essentialBatch transfer the corresponding quantity of the target address, separated by ";", e.g.: -2,500,+1500
rampSourcestringnon-essentialDeposit Order Source
rampOrderIdstringnon-essentialDeposit Order Source ID
defiProtocolstringnon-essential
messagestringnon-essentialMessage
traceIdstringnon-essentialinvocation link trace code

**Get token details**

**Basic Information**

Method name: tokenDetail

**parameters**

**Parameter name****compulsory****typical example****note**
addressesbe"0x000... .00000,0xdb2... .beae3,"Token addresses, separated by commas
chainIdbe"5"32:Email Verification Code, 34:Mobile Verification Code
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codein tbe0: Success, other failures
messagestringbeDescription of information
datareturn value
idnumbernecessarily
coingeckoIdstringnecessarilycoingeckoId
symbolstringnecessarilytoken symbol
chainIdnumbernecessarilycable length (= 1
addressstringnecessarily
namestringnecessarilytoken name
balancestringnecessarily
decimalsstringnecessarily
logostringnecessarilyicon (computing)
highstringnecessarily24h Highest price
lowstringnecessarily24h Lowest Price
price24hChangePercentstringnecessarily24h increase
pricestringnecessarilycurrent price
totalAmountstringnecessarily
isAddedstringnecessarily
addedTimestringnecessarily
lastUpdatedTimestringnecessarily
traceIdnullnecessarily

**Get gas limit ,gas price**

**Basic Information**

Method name: getGasPriceLimit

**parameters**

**Parameter name****compulsory****typical example****note**
chainIdbechain id
frombeSend wallet address
tobetarget address
databeTransaction data
valuebeTransaction amount
accessTokenbeaccess token
gasTypebe1:gas limit, 2:gas price

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codeintbe0: Success, other failures
messagestringbeDescription of information
datareturn value
gasLimitstringbegas limitGets when gasType="1".
fastobjectnecessarilyplain-spokenRemarks: Fast
confirmationTimestringnecessarilyUnit Secondsmock: 30
minCoststringnecessarilyMinimum spend USD or rmb This field is deprecated and is calculated by the client based on currency unitsmock: 0.5
maxCoststringnecessarilyMax Spend $ or rmb This field is deprecated and is calculated by the client based on currency unitsmock: 0.8
minGasstringnecessarilySpend gas Unit eth This field is deprecated and is calculated by the client according to PRD rulesmock: 0.000002
maxGasstringnecessarilySpend gas Unit eth This field is deprecated and is calculated by the client according to PRD rulesmock: 0.000002
minGasPricestringnecessarilygas price unit wei This field represents the gasPrice of the Legacy transaction.mock: 38000000000
maxGasPricestringnecessarilygas price unit wei This field is deprecated and will not be used.mock: 38000000000
maxPriorityFeePerGasstringnecessarilyweimock: 70000000000
maxFeePerGasstringnecessarilyweimock: 90000000000
slowobjectnecessarilyslowlyRemarks: Slow
confirmationTimestringnecessarilyUnit Secondsmock: 30
minCoststringnecessarilyMinimum spend USD or rmb This field is deprecated and is calculated by the client based on currency unitsmock: 0.5
maxCoststringnecessarilyMax Spend $ or rmb This field is deprecated and is calculated by the client based on currency unitsmock: 0.8
minGasstringnecessarilySpend gas Unit eth This field is deprecated and is calculated by the client according to PRD rulesmock: 0.000002
maxGasstringnecessarilySpend gas Unit eth This field is deprecated and is calculated by the client according to PRD rulesmock: 0.000002
minGasPricestringnecessarilygas price unit wei This field represents the gasPrice of the Legacy transaction.mock: 38000000000
maxGasPricestringnecessarilygas price unit wei This field is deprecated and will not be used.mock: 38000000000
maxPriorityFeePerGasstringnecessarily
maxFeePerGasstringnecessarily
proposeobjectnecessarily(an official) standardRemarks: Standard
confirmationTimestringnecessarilyUnit Secondsmock: 30
minCoststringnecessarilyMinimum spend USD or rmb This field is deprecated and is calculated by the client based on currency unitsmock: 0.5
maxCoststringnecessarilyMax Spend $ or rmb This field is deprecated and is calculated by the client based on currency unitsmock: 0.8
minGasstringnecessarilySpend gas Unit eth This field is deprecated and is calculated by the client according to PRD rulesmock: 0.000002
maxGasstringnecessarilySpend gas Unit eth This field is deprecated and is calculated by the client according to PRD rulesmock: 0.000002
minGasPricestringnecessarilygas price unit wei This field represents the gasPrice of the Legacy transaction.mock: 38000000000
maxGasPricestringnecessarilygas price unit wei This field is deprecated and will not be used.mock: 38000000000
maxPriorityFeePerGasstringnecessarily
maxFeePerGasstringnecessarily
suggestBaseFeestringnecessarilybase costmock: 16
gasLimitstringnecessarilygaslimitmock: 21000
exchangeRatestringnecessarilyExchange rate eth against the United States dollarmock: 1250
transferAllRemainRatenumbernecessarilyPercentage of all remaining transfers

**Getting a list of transactions**

**Basic Information**

Method name: getActivitiesList

**parameters**

**Parameter name****compulsory****typical example****note**
currentbepagination
pageSizebeNumber of articles per page
walletbeWallet Address
chainIdbechain id
partnerIdbepartner id
tokenAddressnon-essentialToken address
accessTokenbeaccess token

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codein tbe0: Success, other failures
messagestringbeDescription of information
datareturn value
countstringinessentialtotal number of articles
hash (computing)stringinessentialhash (computing)
partner_idstringinessentialpartner id
order_idstringinessentialorder id
chain_idIntinessentialchain id
valuestringinessentialTransaction amount
fromstringinessentialSend wallet address
tostringinessentialtarget address
gmt_createstringinessentialTransaction creation time

**Add user-defined token**

**Basic Information**

Method name: addUserToken

**parameters**

**Parameter name****compulsory****typical example****note**
tokenAddressesbeToken address (array)
walletAddressbeUser wallet address
chainIdbe5chain id
partnerIdbepartner idPartner id
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codein tbe0: Success, other failures
messagestringbeDescription of information
datareturn value

**Query the user's default token**

**Basic Information**

Method name: userTokenDetail

**parameters**

**Parameter name****compulsory****typical example****note**
walletAddressbeUser wallet address
chainIdbechain id
partnerIdbepartner idpartner id
currentnon-essentialpagination
pageSizenon-essentialNumber of items per page
inputSymbolnon-essentialKeywords for fuzzy queries
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codein tbe0: Success, other failures
messagestringbeDescription of information
datareturn value
logostringnon-essentialThe token's logo address
walletstringbeUser wallet address
partner_idstringbepartner id
token_addrstringbeToken address
chain_idintbechain id
is_deletedintbeDelete or not. 0: not required, 1: yes
symbolstringbeToken abbreviation

**Query system default popular currencies**

**Basic Information**

Method name: tokenAll

**parameters**

**Parameter name****compulsory****typical example****note**
chainIdbechain id
addressesnon-essentialArray of tokens
hotnon-essentialIs it a popular currency. 0: not required, 1: yes
isDefaultnon-essentialDefault or not. 0:not required, 1:yes
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codein tbe0: Success, other failures
messagestringbeDescription of information
datareturn value
symbolstringbe32:Email Verification Code, 34:Mobile Verification Code
chain_idIntbechain id
namestringbeToken name
addressstringbeToken address
decimalsintbenumber of decimal places
logostringbelogo
hotintbePopular or not. 0:not required, 1:yes

**Query user-defined token**

**Basic Information**

Method name: customTokenList

**parameters**

**Parameter name****compulsory****typical example****note**
walletbeUser wallet address
chainIdbechain id
partnerIdbepartner idpartner id
currentnon-essentialpagination
pageSizenon-essentialNumber of items per page
accessTokenbeThe accessToken returned by verifyCode.

**Return data**

**name (of a thing)****typology****compulsory****default value****note****Other information**
codein tbe0: Success, other failures
messagestringbeDescription of information
datareturn value
logostringnon-essentialThe token's logo address
walletstringbeUser wallet address
partner_idstringbepartner id
addressstringbeToken address
chain_idintbechain id
symbolstring
1.0.30

10 months ago

1.0.29

10 months ago

1.0.28

10 months ago

1.0.27

10 months ago

1.0.26

10 months ago

1.0.25

10 months ago

1.0.24

10 months ago

1.0.23

10 months ago

1.0.22

10 months ago

1.0.21

10 months ago

1.0.20

10 months ago

1.0.19

10 months ago

1.0.18

10 months ago

1.0.17

10 months ago

1.0.16

10 months ago

1.0.15

10 months ago

1.0.14

10 months ago

1.0.13

10 months ago

1.0.12

10 months ago

1.0.11

10 months ago

1.0.10

10 months ago

1.0.9

10 months ago

1.0.8

10 months ago

1.0.7

10 months ago

1.0.6

10 months ago

1.0.5

10 months ago

1.0.4

10 months ago

1.0.3

10 months ago

1.0.2

10 months ago

1.0.1

10 months ago

1.0.0

10 months ago