Wallet API (1.0.0)

Download OpenAPI specification:Download

A request/response interceptor is available at src/main/java/com/webapp/modules/interceptor/LightWalletInterceptor.java

This interceptor modifies the request such that all endpoints return with the following headers:

Access-Control-Allow-Origin: *
Access-Control-Allow-Method: *

(Source: LightWalletInterceptor.java#preHandle)

This interceptor also checks each request for the headers Company-ID and Partner-ID. If either of these values is invalid, an error payload is returned by the endpoints (using response code 200 OK).

All request handlers extend from the class BaseApiAct (/src/main/java/com/webapp/modules/common/action/BaseApiAct.java). This class contains two methods: success and error that are called by child classes to return responses. For successful responses, the payload always returns with three properties and the values "0" and "success":

{
  code: "0",
  message: "success",
  data: <any>
}

User Registration

Key exchange

This endpoint caches the user-supplied public RSA key in Redis. At the same time, it also creates a RSA keypair. The private key is cached in Redis along with the user-supplied public key. The public key is returned in the payload.

This endpoint has to be called first to perform the key exchange before the /api/light/register endpoint can be called.

Authorizations:

(CompanyAuthPartnerAuth)

header Parameters

Company-ID	integer Example: 2222
Partner-ID	string Example: 0f48c2ed-0a48-5c57-aeda-de224c92704a The ID of the partner.

Request Body schema: application/json

email	string The email address of the user registering.
publicKey	string The client-generated public RSA key. This key will be stored ephemerally in Redis.

Responses

Request samples

Payload

Content type

application/json

{"email": "hy@me3.io",
"publicKey": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCcxFxfqSgL5CMbeeCypAb4UdKnu4xzP0c6YrGaytuYlMJEjap9x51MVGEvxoash1LmJVZK6lQy7Qs188GUQV37d3QsXNmh9yfyDyFHRjblq7Jwq8iyFRhtobw2R7VtRBnAxDqE6jun7y5AIRJ+XD2GIS5jt4nztgasvF8yxGKfqwIDAQAB"
}

Response samples

200

Content type

application/json

{"code": "0",
"msg": "success",
"data": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCjvwgwgOiVKzLzlnrmi5TyVEHmv2L18Pf6eUOQxBWgdkJjkJLsH6Lei9qgHuGJ0TvFx0TdLjLTEEw9m+zmEcrGJTlinjKj4m6+rCPARvLF95t4D9IhOMKF+tBuO1nAPtFMY2MtOSWZYK507DQSgf8ABiIgY8u321wOpfnW5dXQBwIDAQAB"
}

User registration

The query parameter faceId is used to determine if the user is a new account or an existing one.

If the user is new, the Partner-ID value in the header is linked to the user during account creation. If the partner account is disabled, a 200 response is returned with the error code 100001.

If the user already exists, the partner account is checked if the partner status is suspended or not. If so, a 200 response is returned with the error code 100001.

(It also seems like the chains associated with the partner are then associated with the newly created user.)

This endpoint creates a LightToken for the user (BaseApiAct.java#getLightToken). This newly generated one replaces any existing token for the user in the database.

The LightToken is a MD5 hash of the concatenation of the following:

The database ID of the user.
The current time in milliseconds.
a randomly generated number.

This LightToken is associated with the user (uid) and company (company_id) in the database via the table light_token

Note: The faceId is passed as a query parameter for this POST endpoint instead of the body.

The return payload is encrypted using ChaCha20-Poly1305 cipher. The cipher is keyed using a random 32 bytes key (generated at the time of response). The encrypted payload is then base64-encoded and placed in the data field of the return JSON object.

The randomly generated key is RSA encrypted using the public RSA key associated with the user. This key is read from Redis (CipherV2Util.java#rsaReadKey). After the random (ChaCha) key is encrypted, it is passed along with the payload under the field secret.

The public RSA key associated with the user is registered at the endpoint /api/light/exchange/key.

Authorizations:

(CompanyAuthPartnerAuth)

query Parameters

faceId

string

Example: faceId=hy@me3.io

header Parameters

Company-ID	integer Example: 2222
Partner-ID	string Example: 0f48c2ed-0a48-5c57-aeda-de224c92704a The ID of the partner.

Responses

Response samples

200

Content type

application/json

{"code": "0",
"data": {"secret": "EJQLnLY/MZbdClCl2/B+01t3qqMPOH1YKmKccwo6ZOyKKufCVYbP2SdVoC097x8YM4kDmXRmzfZeBJr8yCCu9cGyRP3pizOWkCCmiaep/O3UGRMgy9XFASbC2FTKglc5nPA/+TZVKxWkH0/4bT00TUY029nxHN3RSn8or+7kzKw=",
"data": "4F3kP7k/VyyApS/sGgygjrzM+0y+uS0KEy6BzHa2nlJSrmRtF2yqD7yxbNusXK0jYkxawAEwgs3g3k2uGatpOBOg1UGjIqIl"
},
"msg": "success"
}

Registers the Google Drive file ID

This endpoint stores in the database the ID of the file that is created in Google Drive. This is so that the front-end library (Keysmith) knows which file to retrieve.

Authorizations:

(CompanyAuthPartnerAuth)

query Parameters

fileId

string

Example: fileId=123abc

If this parameter is not specified, this endpoint treats the request like a GET method and returns a payload with the key fileId that is the description field of the light_user table.

If this parameter is specified (and not empty), the value is saved in the description field of the light_user table.

header Parameters

Company-ID	integer Example: 2222
Partner-ID	string Example: 0f48c2ed-0a48-5c57-aeda-de224c92704a The ID of the partner.

Responses

Response samples

200

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"fileId": "1kY7wXiM2AF7Nn6Vri1qzlDnWdq_WsT9o5QoTyil4ipA"
}
}

Get User Information

Retrieves user information from the request context.

The return payload consists of mainly the fields from the light_user table but also the partnerId property which is not in the table but populated when the user is logged on.

Authorizations:

(CompanyAuthPartnerAuth)

header Parameters

Company-ID	integer Example: 2222
Partner-ID	string Example: 0f48c2ed-0a48-5c57-aeda-de224c92704a The ID of the partner.

Responses

Response samples

200

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"id": 115,
"faceId": "hy@me3.io",
"userName": "L1QV4D",
"profilePhoto": "",
"dynamicPwd": "",
"description": "1323",
"status": 0,
"limitStatus": 0,
"purchaseLimit": 0,
"partnerId": "0f48c2ed-0a48-5c57-aeda-de224c92704b",
"createTime": 1676999569000,
"updateTime": 1677235416000
}
}

Chain info

Company Main Chain List

Gets the information about chains with coins based on a specific currency.

The currency is specified in the header currency.

The payload returns mainly the entities from the table company_main_chain. The entities are decorated with rate associated with the currency and change over 24 hours.

Authorizations:

(CompanyAuthPartnerAuth)

header Parameters

currency	string Example: USD The currency with which chains are associated with. Case-sensitive. If not specified, the default value assumed is `USD`.
Company-ID	integer Example: 2222
Partner-ID	string Example: 0f48c2ed-0a48-5c57-aeda-de224c92704a The ID of the partner.

Responses

Response samples

200

Content type

application/json

{"code": "0",
"msg": "success",
"data": [{"id": 7,
"name": "BTCTest",
"symbol": "BTC",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220307/0b930a74c0ef4f86aef3b681de71255d.png",
"description": "TestBitcoin",
"chainId": null,
"node": "",
"series": "BTC",
"hdCoinId": 0,
"path": "",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220302/d98991b680e8418f99b4e3dbfa8ae81d.png",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220307/06907907faa548f89f19848f0bf287aa.png",
"sort": 1,
"state": 1,
"companyId": 2000,
"txUrl": "https://live.blockcypher.com/btc/tx/",
"supportNft": 0,
"supportDapp": 0,
"ctime": 1646191229000,
"mtime": 1653357082000,
"currency": "USD",
"symbolRate": 21421,
"change": "-0.56564"
},
{"id": 2,
"name": "ETH",
"symbol": "ETH",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20210930/fa2f1c8d81694848bff8d7e823dc82b1.png",
"description": "Ethereum\n",
"chainId": 1,
"node": "https://mainnet.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161",
"series": "ETH",
"hdCoinId": 60,
"path": "m/44'/60'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/1626847409064.png",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/1626847357176.png",
"sort": 2,
"state": 1,
"companyId": 2000,
"txUrl": "https://etherscan.io/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1626336341000,
"mtime": 1654482353000,
"currency": "USD",
"symbolRate": 1666.52,
"change": "-0.60501"
},
{"id": 1,
"name": "RINKEBY",
"symbol": "ETH",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20210930/17f50120501c4582adb8991d1e5caae2.png",
"description": "Rinkeby\n",
"chainId": 4,
"node": "https://rinkeby.infura.io/v3/0e142545524143b19834af1c2c9e44f8",
"series": "ETH",
"hdCoinId": 60,
"path": "m/44'/60'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/1626847409064.png",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/1626847357176.png",
"sort": 4,
"state": 1,
"companyId": 2000,
"txUrl": "https://rinkeby.etherscan.io/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1626248536000,
"mtime": 1653647610000,
"currency": "USD",
"symbolRate": 1666.52,
"change": "-0.60501"
},
{"id": 3,
"name": "Polygon",
"symbol": "MATIC",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20210930/df133b0f7402406f92d8a41bd257fcce.png",
"description": "Polygon",
"chainId": 137,
"node": "https://matic.getblock.io/mainnet/?api_key=8701d4cf-720e-40ec-ad9b-897743f29c75",
"series": "ETH",
"hdCoinId": null,
"path": "m/44'/60'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/1626847445207.png",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/1626847424111.png",
"sort": 4,
"state": 1,
"companyId": 2000,
"txUrl": "https://polygonscan.com/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1626744235000,
"mtime": 1660672218000,
"currency": "USD",
"symbolRate": 0.814506,
"change": "-0.50559"
},
{"id": 18,
"name": "BSC",
"symbol": "BNB",
"symbolIcon": "https://oss.metabazaar.vip/wallet/20220818/2bb69b5bb3af4722a3541a716dcd6e33.png",
"description": "BSC",
"chainId": 56,
"node": "https://bsc.getblock.io/mainnet/?api_key=03a76da0-c897-408c-a7bf-14d54ab19dc4",
"series": "ETH",
"hdCoinId": 60,
"path": "m/44'/60'/0'/0/",
"icon": "https://oss.metabazaar.vip/wallet/20220818/8a70022c3abe48c0b5411dc49951aa79.png",
"activeIcon": "https://oss.metabazaar.vip/wallet/20220818/eaa0f85ae0674e2981bb9479fa7a081f.png",
"sort": 4,
"state": 1,
"companyId": 2000,
"txUrl": "https://mainnet.bscscan.com/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1660776026000,
"mtime": 1660776026000,
"currency": "USD",
"symbolRate": 296.63,
"change": "-0.30542"
},
{"id": 4,
"name": "PolygonTest",
"symbol": "MATIC",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/f5e3df4bbd3f4d9281d62ddc7e742535.png",
"description": "Polygon Test",
"chainId": 80001,
"node": "https://matic.getblock.io/testnet/?api_key=4aca02ac-fd8d-4a1d-aeee-d94033be4f33",
"series": "ETH",
"hdCoinId": 60,
"path": "m/44'/60'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/c05d9d8fba9f4b0e95827de85beb14bb.png",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/d3bf400b6cab41b6b8ccaa95f288c5de.png",
"sort": 7,
"state": 1,
"companyId": 2000,
"txUrl": "https://mumbai.polygonscan.com/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1626744476000,
"mtime": 1653644329000,
"currency": "USD",
"symbolRate": 0.814506,
"change": "-0.50559"
},
{"id": 8,
"name": "BSCTest",
"symbol": "BNB",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/3704b1802f494cf0b45902a798042f26.png",
"description": "BSCTest",
"chainId": 97,
"node": "https://bsc.getblock.io/testnet/?api_key=03a76da0-c897-408c-a7bf-14d54ab19dc4",
"series": "ETH",
"hdCoinId": 60,
"path": "m/44'/60'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/ee5c14f1e5ad41b08ba1259e67363db7.png",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/b1a3624efe6942eebdc32e6cba7d41bb.png",
"sort": 10,
"state": 1,
"companyId": 2000,
"txUrl": "https://testnet.bscscan.com/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1647072143000,
"mtime": 1653701948000,
"currency": "USD",
"symbolRate": 296.63,
"change": "-0.30542"
},
{"id": 9,
"name": "HECOTest",
"symbol": "HT",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/b777ba48b4514a99982c9ba9f1fe3e02.png",
"description": "HECOTest",
"chainId": 256,
"node": "https://http-testnet.hecochain.com",
"series": "ETH",
"hdCoinId": 60,
"path": "m/44'/60'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/8d1ce1d8aa6e4afe84ea0e25313ef493.png",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/9dd3d9a3ed624267b1e497585775f91d.png",
"sort": 11,
"state": 1,
"companyId": 2000,
"txUrl": "https://testnet.hecoinfo.com/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1647072416000,
"mtime": 1653718385000,
"currency": "USD",
"symbolRate": 4.75,
"change": "0.63944"
},
{"id": 16,
"name": "Fuji",
"symbol": "AVAX",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220525/b558e7116d6c4d2d9f5a502ea25bcf89.svg",
"description": "AVAXTest\n",
"chainId": 43113,
"node": "https://api.avax-test.network/ext/bc/C/rpc",
"series": "ETH",
"hdCoinId": null,
"path": "m/44'/60'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220525/0d2368417e234df2b1549039ed52fbdf.svg",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220525/25acfcaf517a4141a67a5cee26629840.svg",
"sort": 18,
"state": 1,
"companyId": 2000,
"txUrl": "https://testnet.snowtrace.io/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1653471985000,
"mtime": 1653991808000,
"currency": "USD",
"symbolRate": 22.71,
"change": "-2.06752"
},
{"id": 17,
"name": "Avax",
"symbol": "AVAX",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220525/b558e7116d6c4d2d9f5a502ea25bcf89.svg",
"description": "AVAX\n",
"chainId": 43114,
"node": "https://avax.getblock.io/mainnet/ext/bc/C/rpc?api_key=8701d4cf-720e-40ec-ad9b-897743f29c75",
"series": "ETH",
"hdCoinId": null,
"path": "m/44'/60'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220525/0d2368417e234df2b1549039ed52fbdf.svg",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220525/25acfcaf517a4141a67a5cee26629840.svg",
"sort": 18,
"state": 1,
"companyId": 2000,
"txUrl": "https://testnet.snowtrace.io/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1653471985000,
"mtime": 1660687441000,
"currency": "USD",
"symbolRate": 22.71,
"change": "-2.06752"
},
{"id": 11,
"name": "FILTest",
"symbol": "FIL",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220401/53e0e61d3c8845c4a0b15da2c8809ac2.png",
"description": "FileCoinTest",
"chainId": null,
"node": "https://api.calibration.node.glif.io/rpc/v0",
"series": "FIL",
"hdCoinId": 461,
"path": "m/44'/461'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220401/e141a6370f244ebbb5f388e0a9caaba0.png",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220401/c434dc8d4b8b40d2ad933363f63e5ff6.png",
"sort": 22,
"state": 1,
"companyId": 2000,
"txUrl": "https://calibration.filscan.io/tipset/pool-message-detail?cid=",
"supportNft": 0,
"supportDapp": 0,
"ctime": 1648795029000,
"mtime": 1660608170000,
"currency": "USD",
"symbolRate": 6.22,
"change": "-2.59405"
},
{"id": 12,
"name": "Westend",
"symbol": "WND",
"symbolIcon": "https://oss.metabazaar.vip/wallet/20220409/79376c937284479dae2c01c7107b4d70.png",
"description": "Westend",
"chainId": 42,
"node": "wss://westend-rpc.polkadot.io",
"series": "DOT",
"hdCoinId": null,
"path": "",
"icon": "https://oss.metabazaar.vip/wallet/20220409/9d631ef670a5406b9dfd0ccf4abd345d.png",
"activeIcon": "https://oss.metabazaar.vip/wallet/20220409/c4567f57bbc94a85b3d12d6025e12de8.png",
"sort": 30,
"state": 1,
"companyId": 2000,
"txUrl": "https://westend.subscan.io/extrinsic/",
"supportNft": 0,
"supportDapp": 0,
"ctime": 1649483001000,
"mtime": 1653357292000,
"currency": "USD",
"symbolRate": 0.204689,
"change": "1.33796"
},
{"id": 13,
"name": "BCH",
"symbol": "BCH",
"symbolIcon": "https://oss.metabazaar.vip/wallet/20220414/841a0019277f4365b864e9b9bb6fadec.png",
"description": "BCH",
"chainId": null,
"node": "",
"series": "BCH",
"hdCoinId": null,
"path": "",
"icon": "https://oss.metabazaar.vip/wallet/20220414/4767408329d847bda0f980c8aa5ac73a.png",
"activeIcon": "https://oss.metabazaar.vip/wallet/20220414/1e7ff7660ba2499eb2de11ba6e77406c.png",
"sort": 33,
"state": 1,
"companyId": 2000,
"txUrl": "https://blockexplorer.one/bitcoin-cash/mainnet/tx/",
"supportNft": 0,
"supportDapp": 0,
"ctime": 1649907970000,
"mtime": 1653883953000,
"currency": "USD",
"symbolRate": 128.11,
"change": "-1.61606"
},
{"id": 14,
"name": "LTC",
"symbol": "LTC",
"symbolIcon": "https://oss.metabazaar.vip/wallet/20220420/e60c4d2533a64466b268211522b129f2.png",
"description": "Litcoin",
"chainId": null,
"node": "",
"series": "LTC",
"hdCoinId": null,
"path": "",
"icon": "https://oss.metabazaar.vip/wallet/20220420/d91ae7272b1246da82fdb7f85b9c1242.png",
"activeIcon": "https://oss.metabazaar.vip/wallet/20220420/326dc5b6c6704b1b9eff75734e4d4b2b.png",
"sort": 55,
"state": 1,
"companyId": 2000,
"txUrl": "https://blockexplorer.one/litecoin/mainnet/tx/",
"supportNft": 0,
"supportDapp": 0,
"ctime": 1650449910000,
"mtime": 1653884007000,
"currency": "USD",
"symbolRate": 55.48,
"change": "-1.81334"
},
{"id": 15,
"name": "ETCTest",
"symbol": "KOT",
"symbolIcon": "https://oss.metabazaar.vip/wallet/20220420/f6de5a8bd4c942d3b2e82e2718cd91a7.png",
"description": "ETH Class Test",
"chainId": 6,
"node": "https://www.ethercluster.com/kotti",
"series": "ETH",
"hdCoinId": null,
"path": "m/44'/60'/0'/0/",
"icon": "https://oss.metabazaar.vip/wallet/20220420/8830a27269754f4d88afc8055d232542.png",
"activeIcon": "https://oss.metabazaar.vip/wallet/20220420/97aaa34ba95e41838f6e8c36cc5ba32a.png",
"sort": 66,
"state": 1,
"companyId": 2000,
"txUrl": "https://blockscout.com/etc/kotti/tx/",
"supportNft": 0,
"supportDapp": 1,
"ctime": 1650452588000,
"mtime": 1653359884000,
"currency": "USD",
"symbolRate": 0.01735767,
"change": "-4.16546"
}
]
}

User-subscribed Chain List

Authorizations:

(CompanyAuthPartnerAuthLightToken)

query Parameters

chainName	string Example: chainName=BSCTest
sort	integer Example: sort=1 Whether to sort the results (`1`, default) or not (`0`).

header Parameters

Company-ID	integer Example: 2222
Partner-ID	string Example: 0f48c2ed-0a48-5c57-aeda-de224c92704a The ID of the partner.

Responses

Response samples

200

Content type

application/json

{"code": "0",
"msg": "success",
"data": [{"id": 1540,
"uid": 115,
"chainName": "BSCTest",
"sort": 10,
"ping": 0,
"createTime": 1676999569000,
"updateTime": 1676999569000,
"balance": null,
"currencyBalance": null,
"mainChainInfo": {"id": 8,
"name": "BSCTest",
"symbol": "BNB",
"symbolIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/3704b1802f494cf0b45902a798042f26.png",
"description": "BSCTest",
"chainId": 97,
"node": "https://bsc.getblock.io/testnet/?api_key=03a76da0-c897-408c-a7bf-14d54ab19dc4",
"series": "ETH",
"hdCoinId": 60,
"path": "m/44'/60'/0'/0/",
"icon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/ee5c14f1e5ad41b08ba1259e67363db7.png",
"activeIcon": "https://hicoinvip.oss-cn-beijing.aliyuncs.com/saas/20220312/b1a3624efe6942eebdc32e6cba7d41bb.png",
"sort": 10,
"state": 1,
"companyId": 2000,
"txUrl": "https://testnet.bscscan.com/tx/",
"supportNft": 1,
"supportDapp": 1,
"ctime": 1647072143000,
"mtime": 1653701948000,
"currency": null,
"symbolRate": null,
"change": null
},
"chainDescription": "BSCTest"
}
]
}

Transactions

List Transactions History

This endpoint returns the list of transactions for a user.

The actual fetching from the database is done in the file com/webapp/modules/lightwallet/service/impl/LightAddressTransactionLogServiceImpl.java, line 63 txHistory. After retrieving the data from the database, the data is mapped into the LightTxRes entity.

The transactions (from the table light_address_transaction_log) retrieved from the database in descending order of tx_time. The trade_type of the field is used to determine if it is an outgoing transaction (value 1) or incoming one (value 2).

An outgoing transaction is translated into a TRANSFER_TYPE LightTxRes with the address set to the recipient of the transaction.

Conversely, an incoming transaction is translated into a COLLECT_TYPE LightTxRes with the address set to the sender of the transaction.

Authorizations:

(CompanyAuthPartnerAuth)

query Parameters

page required	integer Example: page=1
pageSize required	integer Example: pageSize=5
type required	integer Example: type=1 1 -> Transfer Type Transaction 2 -> Collect Type Transaction 3 -> Error Type Transaction
address	string Example: address=0x55959f0D5e1b7DC57fe4079e596b8BBafFF123B1 Wallet Address
symbolType required	string Example: symbolType=RINKEBY Symbol Type

header Parameters

Company-ID	integer Example: 2222
Partner-ID	string Example: 0f48c2ed-0a48-5c57-aeda-de224c92704a The ID of the partner.

Responses

Response samples

200

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"pageCount": 34,
"lightTxResList": [{"type": 1,
"address": "0x1ab8ffcb47f31efa7b12758c6ef94af7d59572fd",
"amount": "0.01",
"dateTime": "2022-08-16",
"confirmations": 3,
"confirmation_all": 3,
"txid": "0x7fb51497b2d396163f54b989160d9b1275ab60e2f3d811155e2af100ea58b233",
"tx_status": "1",
"txTime": 1660638222000,
"symbol": "ETH"
},
{"type": 1,
"address": "0x28aa8b3ee50e8e6fea7b9926b1ef0477c10d12a1",
"amount": "999",
"dateTime": "2022-08-15",
"confirmations": 1,
"confirmation_all": 3,
"txid": "0x61dd3cedd60e46206d3e172ea8bddd68f1a15098b35a40a98dbda11ee50d44bc",
"tx_status": "1",
"txTime": 1660559820000,
"symbol": "KBKC"
},
{"type": 1,
"address": "0x28aa8b3ee50e8e6fea7b9926b1ef0477c10d12a1",
"amount": "100",
"dateTime": "2022-08-15",
"confirmations": 1,
"confirmation_all": 3,
"txid": "0x110beb2f62cbc048feb4a6ce8a8d95da039184f36f5ba94b65de6ce675e82f6b",
"tx_status": "1",
"txTime": 1660559592000,
"symbol": "KBKC"
},
{"type": 1,
"address": "0x4a3541f269fe03fde790b2ae81b7042cf08745c7",
"amount": "0",
"dateTime": "2022-08-15",
"confirmations": 1,
"confirmation_all": 3,
"txid": "0xb908780dd6ee2c799f436273d8c2e43fae78a6b1459c7ea33f1f781e6145d538",
"tx_status": "1",
"txTime": 1660548646000,
"symbol": "ETH"
},
{"type": 1,
"address": "0x4a3541f269fe03fde790b2ae81b7042cf08745c7",
"amount": "0",
"dateTime": "2022-08-15",
"confirmations": 1,
"confirmation_all": 3,
"txid": "0x759d7f37f46141b922d7845862c1051223c08012639e46623e1d097397966192",
"tx_status": "1",
"txTime": 1660548644000,
"symbol": "ETH"
}
]
}
}

Get Transaction History

Authorizations:

(CompanyAuthPartnerAuth)

query Parameters

symbol	string Example: symbol=ETH The coin symbol for the chain in which the transaction is retrieved for.
address	string Example: address=0x55959f0D5e1b7DC57fe4079e596b8BBafFF123B1 The wallet address.
txid	string Example: txid=0x7fb51497b2d396163f54b989160d9b1275ab60e2f3d811155e2af100ea58b233 The transaction ID.
symbolType	string Example: symbolType=RINKEBY Symbol Type is an internal representation of the supported chains.
coinType	integer Example: coinType=1 Indicates whether is native to the chain?

header Parameters

Company-ID	integer Example: 2222
Partner-ID	string Example: 0f48c2ed-0a48-5c57-aeda-de224c92704a The ID of the partner.

Responses

Response samples

200

Content type

application/json

Example

success-api_lightaddresstransactionlog_txinfo

{"code": "string",
"msg": "string",
"data": {"symbol_txid": "https://cn.etherscan.com/tx/0x7fb51497b2d396163f54b989160d9b1275ab60e2f3d811155e2af100ea58b233",
"symbol": "string",
"tx_status": "string",
"confirmations": 0,
"confirmations_all": 3,
"amount": "string",
"tx_time": "string",
"fees": "string",
"remarks": "string",
"txid": "string",
"to_address": "string",
"from_address": "string",
"trade_type": "string"
}
}

Kyberswap

Sync Kyberswap Tokens/Assets to DB

Makes a request to the URL https://api.github.com/repos/KyberNetwork/ks-assets/git/trees/main. From the result, the tree value is parsed to get the url value of the tree value containing path: tokenLists. This URL value is used to get the list of supported chains by Kyberswap.

From the list of supported chains, this endpoint then gets the list of supported tokens (from URls starting with https://raw.githubusercontent.com/KyberNetwork/ks-assets/main/tokenLists/) from each of the chains.

These tokens are then transformed into light_wallet_coin to be saved or updated in the database.

Authorizations:

(CompanyAuthPartnerAuth)

header Parameters

Company-ID	integer Example: 2222
Partner-ID	string Example: 0f48c2ed-0a48-5c57-aeda-de224c92704a The ID of the partner.

Responses

Response samples

200

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"updates": 259,
"inserts": 0
}
}