-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
369 lines (362 loc) · 12.1 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
---
openapi: 3.0.0
info:
title: Liquality Wallet API/SDK
description: |
A wallet API and SDK provides the necessary tools and resources that crypto companies need to develop their own customized wallet application. It allows them to integrate their wallet into their existing product or platform, giving them the opportunity to securely store, send, and receive digital assets. The SDK simplifies the setup process, provides detailed documentation and tutorials, and offers a secure and robust framework for building custom wallets. This way, crypto companies can create innovative products and services that meet the needs of their customers.
---
## Supported functions:
* **Wallet:** auth, create, import, account
* **Tokens:** balance, send, receive, swap
* **Collectibles:** hold, send, receive, mint
* Reading the chain (balances, blocks, transactions)
* Wallet address retrieval
* Signing messages
* Sending transactions
* Getting recommended fees
* Updating a transaction's fees
---
version: 1.0.0
servers:
- url: https://virtserver.swaggerhub.com/ADRINA0002/WalletAPI/1.0.0
description: SwaggerHub API Auto Mocking
paths:
/v1/nft/accountNftCollection/{accountId}:
get:
tags:
- Wallet API Endpoints
operationId: accountNftCollections
description: This function is designed to retrieve the Non-Fungible Token (NFT) details for a specified account. It will take in the accountId as a parameter and return the NFT details associated with that account. This data can then be used to gain insights into the account’s ownership of NFTs, the composition of their NFT collection, and any associated market trends.
parameters:
- name: accountId
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: accountNftCollections
content:
application/json:
schema:
$ref: "#/components/schemas/NftAsset"
/v1/nft/allNftCollections:
get:
tags:
- Wallet API Endpoints
operationId: allNftCollections
description: This function is designed to get all of the user's Non-Fungible Tokens (NFTs) from the blockchain. It will return an array of objects containing all of the user's tokenized assets. The objects will contain all of the relevant information about each NFT, including the token's name, address, ID, and more. This function provides an easy way to quickly access all of the user's NFTs in one call.
responses:
"200":
description: NftAsset
content:
application/json:
schema:
$ref: "#/components/schemas/NftAsset"
/v1/nft/sendNFTTransaction:
post:
tags:
- Wallet API Endpoints
operationId: sendNFTTransaction
description: This function allows users to easily and securely send a Non-Fungible Token (NFT) to another user. It can be used to transfer ownership of a digital asset such as artwork, music, or a collectible token.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SendNftRequestBody"
responses:
"200":
description: successfully registered device
/v1/nft/mintNFT:
post:
tags:
- Wallet API Endpoints
operationId: mintNFT
description: This function mints an NFT (Non-Fungible Token). It is a powerful tool for creating unique digital assets that can be traded, sold, and collected securely on the blockchain. By using this function, users can create their own digital assets and mint them as NFTs. The minted NFTs are cryptographically secured and are guaranteed to be unique, making them perfect for collecting, trading, and selling as digital assets.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/MintNftRequestBody"
responses:
"200":
description: successfully registered device
/v1/token/accountsWithBalance/{walletId}:
get:
tags:
- Wallet API Endpoints
operationId: accountsWithBalance
description: Returns a list of objects of all accounts that currently are holding any balance.
parameters:
- name: walletId
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: accountsWithBalance
content:
application/json:
schema:
$ref: "#/components/schemas/Account"
/v1/token/totalFiatBalance/{walletId}:
get:
tags:
- Wallet API Endpoints
operationId: totalFiatBalance
description: Returns the total amount of fiat balance in a wallet.
parameters:
- name: walletId
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: totalFiatBalance
content:
application/json:
schema:
$ref: "#/components/schemas/TotalFiatAmount"
/v1/token/swap:
post:
tags:
- Wallet API Endpoints
operationId: swap
description: This function facilitates the transfer of tokens between different blockchain networks. It simplifies the process of exchanging tokens, allowing users to quickly and easily switch between different blockchains. The function is secure and reliable, ensuring that token swaps are completed without any issues or delays.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SwapRequestBody"
responses:
"200":
description: Swap between tokens
/v1/token/send:
post:
tags:
- Wallet API Endpoints
operationId: send
description: This function is designed to make sending cryptocurrency incredibly simple and secure. It also provides a range of features such as instant transaction confirmation, low transaction fees, and support for multiple cryptocurrencies.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SendRequestBody"
responses:
"200":
description: Send tokens
/v1/fee/getSendTxFees/{accountId}/{asset}/{amount}/{customFee}:
get:
tags:
- Wallet API Endpoints
operationId: getSendTxFees
description: This function retrieves all transaction fees associated with a send cryptocurrency transaction. It includes the network fee, which is the fee paid to the network for processing the transaction, as well as any additional fees that may be required by the sender or receiver. The function will calculate the total fee for the transaction and return it to the user.
parameters:
- name: accountId
in: path
required: true
style: simple
explode: false
schema:
type: string
- name: asset
in: path
required: true
style: simple
explode: false
schema:
type: string
- name: amount
in: path
required: true
style: simple
explode: false
schema:
type: number
- name: customFee
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: getSendTxFees
content:
application/json:
schema:
$ref: "#/components/schemas/SendFees"
components:
schemas:
NftAsset:
type: object
properties:
length:
type: integer
format: int64
token_id:
type: string
asset_contract:
$ref: "#/components/schemas/NftAsset_asset_contract"
collection:
$ref: "#/components/schemas/NftAsset_collection"
id:
type: number
description:
type: string
external_link:
type: string
image_original_url:
type: string
image_preview_url:
type: string
image_thumbnail_url:
type: string
name:
type: string
amount:
type: string
standard:
type: string
Account:
type: object
properties:
id:
type: string
walletId:
type: string
createdAt:
type: number
enabled:
type: boolean
derivationPath:
type: string
chainCode:
type: string
publicKey:
type: string
nfts:
type: array
items:
type: object
TotalFiatAmount:
type: number
SendFees:
type: number
SendNftRequestBody:
type: object
properties:
network:
type: string
example: mainnet
accountId:
type: string
example: 0729a580-2240-11e6-9eb5-0002a5d5c51b
walletId:
type: string
example: 0729a580-2240-11e6-9eb5-0002a5d5c51b
receiver:
type: string
example: 0x1234567890123456789012345678901234567890
values:
type: array
example:
- 1
- 5
- 7
items:
type: number
fee:
type: number
example: 0.004
feeLabel:
type: string
example: Average
MintNftRequestBody:
type: object
properties:
walletAddress:
type: string
example: 0x1234567890123456789012345678901234567890
tokenUri:
type: string
example: 0729a580-2240-11e6-9eb5-0002a5d5c51b
SwapRequestBody:
type: object
properties:
srcChainId:
type: number
example: 1
srcChainTokenIn:
type: string
example: 0xdAC17F958D2ee523a2206206994597C13D831ec7
srcChainTokenInAmount:
type: number
example: 5000000
dstChainId:
type: number
example: 137
dstChainTokenOut:
type: string
example: 0x0000000000000000000000000000000000000000
SendRequestBody:
type: object
properties:
activeNetwork:
type: string
example: mainnet
asset:
type: string
example: ETH
to:
type: string
example: 0xdAC17F958D2ee523a2206206994597C13D831ec7
value:
type: number
example: 30000
fee:
type: number
example: 0.004
feeLabel:
type: string
example: Average
memo:
type: string
example: 0x54e3f31b0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee000000000000000000000000c2132d05d31c914a87c6611c10748aeb04b58e8f0000000000000000000000000000000000000000000000001bc16d674ec8000000000000000000000000000000000000000000000000000000000000001cecc100000000000000000000000000000000000000000000000000000000001d11c800000000000000000000000000000000000000000000000000000000000001e000000000000000000000000000000000000000000000000000000000000002200000000000000000
Weather:
type: object
properties:
summary:
type: string
description:
type: string
icon:
type: string
NftAsset_asset_contract:
type: object
properties:
address:
type: string
name:
type: string
symbol:
type: string
image_url:
type: string
external_url:
type: string
NftAsset_collection:
type: object
properties:
name:
type: string