@oumla/sdk 0.0.5 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +266 -9
- package/dist/index.cjs +4091 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +2228 -446
- package/dist/index.js +3819 -3807
- package/dist/index.js.map +1 -0
- package/package.json +57 -22
- package/.changeset/README.md +0 -8
- package/.changeset/config.json +0 -11
- package/.prettierrc +0 -7
- package/dist/index.mjs +0 -4047
- package/tsconfig.json +0 -12
package/dist/index.d.ts
CHANGED
|
@@ -1,473 +1,2255 @@
|
|
|
1
|
-
|
|
1
|
+
declare const GetDeployedContractsRequestNetwork: {
|
|
2
|
+
readonly TBtc: "tBTC";
|
|
3
|
+
readonly TEth: "tETH";
|
|
4
|
+
};
|
|
5
|
+
type GetDeployedContractsRequestNetwork = (typeof GetDeployedContractsRequestNetwork)[keyof typeof GetDeployedContractsRequestNetwork];
|
|
2
6
|
|
|
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
|
-
baseUrl: string;
|
|
99
|
-
apiKey: string;
|
|
100
|
-
}, {
|
|
101
|
-
baseUrl: string;
|
|
102
|
-
apiKey: string;
|
|
103
|
-
}>;
|
|
104
|
-
declare const GetProfileAddressesSchema: z.ZodObject<{
|
|
105
|
-
reference: z.ZodString;
|
|
106
|
-
}, "strip", z.ZodTypeAny, {
|
|
107
|
-
reference: string;
|
|
108
|
-
}, {
|
|
109
|
-
reference: string;
|
|
110
|
-
}>;
|
|
111
|
-
declare const GetAddressSchema: z.ZodObject<{
|
|
112
|
-
reference: z.ZodString;
|
|
113
|
-
}, "strip", z.ZodTypeAny, {
|
|
114
|
-
reference: string;
|
|
115
|
-
}, {
|
|
7
|
+
/**
|
|
8
|
+
* @example
|
|
9
|
+
* {
|
|
10
|
+
* skip: 1,
|
|
11
|
+
* take: 1,
|
|
12
|
+
* contractAddress: "contractAddress",
|
|
13
|
+
* network: "BTC",
|
|
14
|
+
* contractTemplateId: "contractTemplateId"
|
|
15
|
+
* }
|
|
16
|
+
*/
|
|
17
|
+
interface GetDeployedContractsRequest {
|
|
18
|
+
/** Number of records to skip */
|
|
19
|
+
skip?: number;
|
|
20
|
+
/** Number of records to take */
|
|
21
|
+
take?: number;
|
|
22
|
+
/** Filter by contract address */
|
|
23
|
+
contractAddress?: string;
|
|
24
|
+
/** Filter by blockchain network */
|
|
25
|
+
network?: GetDeployedContractsRequestNetwork;
|
|
26
|
+
/** Filter by contract template ID */
|
|
27
|
+
contractTemplateId?: string;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* @example
|
|
32
|
+
* {
|
|
33
|
+
* network: "network",
|
|
34
|
+
* contractAddress: "contractAddress"
|
|
35
|
+
* }
|
|
36
|
+
*/
|
|
37
|
+
interface FetchContractAbiRequest {
|
|
38
|
+
/** Blockchain network */
|
|
39
|
+
network: string;
|
|
40
|
+
/** Contract address */
|
|
41
|
+
contractAddress: string;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* @example
|
|
46
|
+
* {
|
|
47
|
+
* network: "network",
|
|
48
|
+
* contractAddress: "contractAddress",
|
|
49
|
+
* name: "name",
|
|
50
|
+
* abi: [{
|
|
51
|
+
* "key": "value"
|
|
52
|
+
* }]
|
|
53
|
+
* }
|
|
54
|
+
*/
|
|
55
|
+
interface AddContractAbiRequest {
|
|
56
|
+
/** Blockchain network */
|
|
57
|
+
network: string;
|
|
58
|
+
/** Contract address */
|
|
59
|
+
contractAddress: string;
|
|
60
|
+
/** Contract name */
|
|
61
|
+
name: string;
|
|
62
|
+
/** Contract ABI */
|
|
63
|
+
abi: Record<string, unknown>[];
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
type index$a_AddContractAbiRequest = AddContractAbiRequest;
|
|
67
|
+
type index$a_FetchContractAbiRequest = FetchContractAbiRequest;
|
|
68
|
+
type index$a_GetDeployedContractsRequest = GetDeployedContractsRequest;
|
|
69
|
+
type index$a_GetDeployedContractsRequestNetwork = GetDeployedContractsRequestNetwork;
|
|
70
|
+
declare namespace index$a {
|
|
71
|
+
export {
|
|
72
|
+
index$a_AddContractAbiRequest as AddContractAbiRequest,
|
|
73
|
+
index$a_FetchContractAbiRequest as FetchContractAbiRequest,
|
|
74
|
+
index$a_GetDeployedContractsRequest as GetDeployedContractsRequest,
|
|
75
|
+
index$a_GetDeployedContractsRequestNetwork as GetDeployedContractsRequestNetwork,
|
|
76
|
+
};
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* @example
|
|
81
|
+
* {
|
|
82
|
+
* skip: 1,
|
|
83
|
+
* take: 1
|
|
84
|
+
* }
|
|
85
|
+
*/
|
|
86
|
+
interface GetProfilesRequest {
|
|
87
|
+
/** Number of records to skip */
|
|
88
|
+
skip?: number;
|
|
89
|
+
/** Number of records to take */
|
|
90
|
+
take?: number;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* @example
|
|
95
|
+
* {
|
|
96
|
+
* reference: "reference",
|
|
97
|
+
* type: "User"
|
|
98
|
+
* }
|
|
99
|
+
*/
|
|
100
|
+
interface CreateProfileRequest {
|
|
101
|
+
/** Profile reference identifier */
|
|
116
102
|
reference: string;
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
103
|
+
/** Profile type */
|
|
104
|
+
type: CreateProfileRequest.Type;
|
|
105
|
+
}
|
|
106
|
+
declare namespace CreateProfileRequest {
|
|
107
|
+
/** Profile type */
|
|
108
|
+
const Type: {
|
|
109
|
+
readonly User: "User";
|
|
110
|
+
readonly Department: "Department";
|
|
111
|
+
readonly Merchant: "Merchant";
|
|
112
|
+
};
|
|
113
|
+
type Type = (typeof Type)[keyof typeof Type];
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
declare const index$9_CreateProfileRequest: typeof CreateProfileRequest;
|
|
117
|
+
type index$9_GetProfilesRequest = GetProfilesRequest;
|
|
118
|
+
declare namespace index$9 {
|
|
119
|
+
export {
|
|
120
|
+
index$9_CreateProfileRequest as CreateProfileRequest,
|
|
121
|
+
index$9_GetProfilesRequest as GetProfilesRequest,
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* @example
|
|
127
|
+
* {
|
|
128
|
+
* skip: 1,
|
|
129
|
+
* take: 1
|
|
130
|
+
* }
|
|
131
|
+
*/
|
|
132
|
+
interface GetOrganizationWalletsRequest {
|
|
133
|
+
/** Number of records to skip */
|
|
134
|
+
skip?: number;
|
|
135
|
+
/** Number of records to take */
|
|
136
|
+
take?: number;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* @example
|
|
141
|
+
* {
|
|
142
|
+
* skip: 1,
|
|
143
|
+
* take: 1
|
|
144
|
+
* }
|
|
145
|
+
*/
|
|
146
|
+
interface GetProfileWalletsRequest {
|
|
147
|
+
/** Number of records to skip */
|
|
148
|
+
skip?: number;
|
|
149
|
+
/** Number of records to take */
|
|
150
|
+
take?: number;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* @example
|
|
155
|
+
* {
|
|
156
|
+
* reference: "reference",
|
|
157
|
+
* network: "BTC"
|
|
158
|
+
* }
|
|
159
|
+
*/
|
|
160
|
+
interface CreateWalletRequest {
|
|
161
|
+
/** Profile reference */
|
|
122
162
|
reference: string;
|
|
123
|
-
|
|
124
|
-
|
|
163
|
+
/** Blockchain network */
|
|
164
|
+
network: CreateWalletRequest.Network;
|
|
165
|
+
}
|
|
166
|
+
declare namespace CreateWalletRequest {
|
|
167
|
+
/** Blockchain network */
|
|
168
|
+
const Network: {
|
|
169
|
+
readonly TBtc: "tBTC";
|
|
170
|
+
readonly TEth: "tETH";
|
|
171
|
+
};
|
|
172
|
+
type Network = (typeof Network)[keyof typeof Network];
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
declare const index$8_CreateWalletRequest: typeof CreateWalletRequest;
|
|
176
|
+
type index$8_GetOrganizationWalletsRequest = GetOrganizationWalletsRequest;
|
|
177
|
+
type index$8_GetProfileWalletsRequest = GetProfileWalletsRequest;
|
|
178
|
+
declare namespace index$8 {
|
|
179
|
+
export {
|
|
180
|
+
index$8_CreateWalletRequest as CreateWalletRequest,
|
|
181
|
+
index$8_GetOrganizationWalletsRequest as GetOrganizationWalletsRequest,
|
|
182
|
+
index$8_GetProfileWalletsRequest as GetProfileWalletsRequest,
|
|
183
|
+
};
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
/**
|
|
187
|
+
* @example
|
|
188
|
+
* {
|
|
189
|
+
* skip: 1,
|
|
190
|
+
* take: 1
|
|
191
|
+
* }
|
|
192
|
+
*/
|
|
193
|
+
interface GetOrganizationAddressesRequest {
|
|
194
|
+
/** Number of records to skip */
|
|
195
|
+
skip?: number;
|
|
196
|
+
/** Number of records to take */
|
|
197
|
+
take?: number;
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
/**
|
|
201
|
+
* @example
|
|
202
|
+
* {
|
|
203
|
+
* skip: 1,
|
|
204
|
+
* take: 1
|
|
205
|
+
* }
|
|
206
|
+
*/
|
|
207
|
+
interface GetProfileAddressesRequest {
|
|
208
|
+
/** Number of records to skip */
|
|
209
|
+
skip?: number;
|
|
210
|
+
/** Number of records to take */
|
|
211
|
+
take?: number;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* @example
|
|
216
|
+
* {
|
|
217
|
+
* reference: "reference",
|
|
218
|
+
* network: "BTC",
|
|
219
|
+
* clientShare: "clientShare"
|
|
220
|
+
* }
|
|
221
|
+
*/
|
|
222
|
+
interface CreateAddressRequest {
|
|
223
|
+
/** Profile reference */
|
|
125
224
|
reference: string;
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
baseUrl: z.ZodString;
|
|
130
|
-
apiKey: z.ZodString;
|
|
131
|
-
}, "strip", z.ZodTypeAny, {
|
|
132
|
-
baseUrl: string;
|
|
133
|
-
apiKey: string;
|
|
134
|
-
}, {
|
|
135
|
-
baseUrl: string;
|
|
136
|
-
apiKey: string;
|
|
137
|
-
}>;
|
|
138
|
-
declare const GetVolumeSchema: z.ZodObject<{
|
|
139
|
-
baseUrl: z.ZodString;
|
|
140
|
-
apiKey: z.ZodString;
|
|
141
|
-
}, "strip", z.ZodTypeAny, {
|
|
142
|
-
baseUrl: string;
|
|
143
|
-
apiKey: string;
|
|
144
|
-
}, {
|
|
145
|
-
baseUrl: string;
|
|
146
|
-
apiKey: string;
|
|
147
|
-
}>;
|
|
148
|
-
declare const GetInsightsSchema: z.ZodObject<{
|
|
149
|
-
baseUrl: z.ZodString;
|
|
150
|
-
apiKey: z.ZodString;
|
|
151
|
-
}, "strip", z.ZodTypeAny, {
|
|
152
|
-
baseUrl: string;
|
|
153
|
-
apiKey: string;
|
|
154
|
-
}, {
|
|
155
|
-
baseUrl: string;
|
|
156
|
-
apiKey: string;
|
|
157
|
-
}>;
|
|
158
|
-
declare const CreateTransactionSchema: z.ZodObject<{
|
|
159
|
-
to: z.ZodString;
|
|
160
|
-
amount: z.ZodString;
|
|
161
|
-
from: z.ZodArray<z.ZodString, "many">;
|
|
162
|
-
network: z.ZodEnum<["BTC", "ETH", "tBTC", "tETH"]>;
|
|
163
|
-
clientShare: z.ZodString;
|
|
164
|
-
}, "strip", z.ZodTypeAny, {
|
|
165
|
-
network: "BTC" | "ETH" | "tBTC" | "tETH";
|
|
225
|
+
/** Blockchain network */
|
|
226
|
+
network: CreateAddressRequest.Network;
|
|
227
|
+
/** Client share for signing */
|
|
166
228
|
clientShare: string;
|
|
229
|
+
}
|
|
230
|
+
declare namespace CreateAddressRequest {
|
|
231
|
+
/** Blockchain network */
|
|
232
|
+
const Network: {
|
|
233
|
+
readonly TBtc: "tBTC";
|
|
234
|
+
readonly TEth: "tETH";
|
|
235
|
+
};
|
|
236
|
+
type Network = (typeof Network)[keyof typeof Network];
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
declare const index$7_CreateAddressRequest: typeof CreateAddressRequest;
|
|
240
|
+
type index$7_GetOrganizationAddressesRequest = GetOrganizationAddressesRequest;
|
|
241
|
+
type index$7_GetProfileAddressesRequest = GetProfileAddressesRequest;
|
|
242
|
+
declare namespace index$7 {
|
|
243
|
+
export {
|
|
244
|
+
index$7_CreateAddressRequest as CreateAddressRequest,
|
|
245
|
+
index$7_GetOrganizationAddressesRequest as GetOrganizationAddressesRequest,
|
|
246
|
+
index$7_GetProfileAddressesRequest as GetProfileAddressesRequest,
|
|
247
|
+
};
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
/**
|
|
251
|
+
* @example
|
|
252
|
+
* {
|
|
253
|
+
* skip: 1,
|
|
254
|
+
* take: 1
|
|
255
|
+
* }
|
|
256
|
+
*/
|
|
257
|
+
interface GetTransactionsByAddressRequest {
|
|
258
|
+
/** Number of records to skip */
|
|
259
|
+
skip?: number;
|
|
260
|
+
/** Number of records to take */
|
|
261
|
+
take?: number;
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* @example
|
|
266
|
+
* {
|
|
267
|
+
* skip: 1,
|
|
268
|
+
* take: 1
|
|
269
|
+
* }
|
|
270
|
+
*/
|
|
271
|
+
interface GetTransactionsByWalletRequest {
|
|
272
|
+
/** Number of records to skip */
|
|
273
|
+
skip?: number;
|
|
274
|
+
/** Number of records to take */
|
|
275
|
+
take?: number;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* @example
|
|
280
|
+
* {
|
|
281
|
+
* skip: 1,
|
|
282
|
+
* take: 1
|
|
283
|
+
* }
|
|
284
|
+
*/
|
|
285
|
+
interface GetOrganizationTransactionsRequest {
|
|
286
|
+
/** Number of records to skip */
|
|
287
|
+
skip?: number;
|
|
288
|
+
/** Number of records to take */
|
|
289
|
+
take?: number;
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
/**
|
|
293
|
+
* @example
|
|
294
|
+
* {
|
|
295
|
+
* skip: 1,
|
|
296
|
+
* take: 1
|
|
297
|
+
* }
|
|
298
|
+
*/
|
|
299
|
+
interface GetProfileTransactionsRequest {
|
|
300
|
+
/** Number of records to skip */
|
|
301
|
+
skip?: number;
|
|
302
|
+
/** Number of records to take */
|
|
303
|
+
take?: number;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
type index$6_GetOrganizationTransactionsRequest = GetOrganizationTransactionsRequest;
|
|
307
|
+
type index$6_GetProfileTransactionsRequest = GetProfileTransactionsRequest;
|
|
308
|
+
type index$6_GetTransactionsByAddressRequest = GetTransactionsByAddressRequest;
|
|
309
|
+
type index$6_GetTransactionsByWalletRequest = GetTransactionsByWalletRequest;
|
|
310
|
+
declare namespace index$6 {
|
|
311
|
+
export {
|
|
312
|
+
index$6_GetOrganizationTransactionsRequest as GetOrganizationTransactionsRequest,
|
|
313
|
+
index$6_GetProfileTransactionsRequest as GetProfileTransactionsRequest,
|
|
314
|
+
index$6_GetTransactionsByAddressRequest as GetTransactionsByAddressRequest,
|
|
315
|
+
index$6_GetTransactionsByWalletRequest as GetTransactionsByWalletRequest,
|
|
316
|
+
};
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* @example
|
|
321
|
+
* {
|
|
322
|
+
* skip: 1,
|
|
323
|
+
* take: 1
|
|
324
|
+
* }
|
|
325
|
+
*/
|
|
326
|
+
interface GetAssetsByAddressRequest {
|
|
327
|
+
/** Number of records to skip */
|
|
328
|
+
skip?: number;
|
|
329
|
+
/** Number of records to take */
|
|
330
|
+
take?: number;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* @example
|
|
335
|
+
* {
|
|
336
|
+
* skip: 1,
|
|
337
|
+
* take: 1
|
|
338
|
+
* }
|
|
339
|
+
*/
|
|
340
|
+
interface GetAssetsByWalletRequest {
|
|
341
|
+
/** Number of records to skip */
|
|
342
|
+
skip?: number;
|
|
343
|
+
/** Number of records to take */
|
|
344
|
+
take?: number;
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
type index$5_GetAssetsByAddressRequest = GetAssetsByAddressRequest;
|
|
348
|
+
type index$5_GetAssetsByWalletRequest = GetAssetsByWalletRequest;
|
|
349
|
+
declare namespace index$5 {
|
|
350
|
+
export {
|
|
351
|
+
index$5_GetAssetsByAddressRequest as GetAssetsByAddressRequest,
|
|
352
|
+
index$5_GetAssetsByWalletRequest as GetAssetsByWalletRequest,
|
|
353
|
+
};
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
/**
|
|
357
|
+
* @example
|
|
358
|
+
* {
|
|
359
|
+
* to: "to",
|
|
360
|
+
* amount: "amount",
|
|
361
|
+
* from: ["from"],
|
|
362
|
+
* network: "BTC",
|
|
363
|
+
* clientShare: "clientShare"
|
|
364
|
+
* }
|
|
365
|
+
*/
|
|
366
|
+
interface CreateWithdrawalRequest {
|
|
367
|
+
/** Recipient address for withdrawal */
|
|
167
368
|
to: string;
|
|
369
|
+
/** Withdrawal amount */
|
|
168
370
|
amount: string;
|
|
371
|
+
/** Array of source addresses for withdrawal */
|
|
169
372
|
from: string[];
|
|
170
|
-
|
|
171
|
-
network:
|
|
373
|
+
/** Blockchain network */
|
|
374
|
+
network: CreateWithdrawalRequest.Network;
|
|
375
|
+
/** Client share for signing */
|
|
172
376
|
clientShare: string;
|
|
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
|
-
apiKey: string;
|
|
200
|
-
baseUrl?: string;
|
|
201
|
-
env?: EnvType;
|
|
202
|
-
};
|
|
203
|
-
type THttpRequestArgs = {
|
|
204
|
-
path: string;
|
|
205
|
-
method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
|
|
206
|
-
body?: Record<string, unknown>;
|
|
207
|
-
schema?: z.Schema<unknown>;
|
|
208
|
-
pagination?: TPagination;
|
|
209
|
-
headers?: Record<string, string>;
|
|
210
|
-
};
|
|
211
|
-
type TPagination = {
|
|
212
|
-
totalElements?: number;
|
|
213
|
-
totalPages?: number;
|
|
377
|
+
}
|
|
378
|
+
declare namespace CreateWithdrawalRequest {
|
|
379
|
+
/** Blockchain network */
|
|
380
|
+
const Network: {
|
|
381
|
+
readonly TBtc: "tBTC";
|
|
382
|
+
readonly TEth: "tETH";
|
|
383
|
+
};
|
|
384
|
+
type Network = (typeof Network)[keyof typeof Network];
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
declare const index$4_CreateWithdrawalRequest: typeof CreateWithdrawalRequest;
|
|
388
|
+
declare namespace index$4 {
|
|
389
|
+
export {
|
|
390
|
+
index$4_CreateWithdrawalRequest as CreateWithdrawalRequest,
|
|
391
|
+
};
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
/**
|
|
395
|
+
* @example
|
|
396
|
+
* {
|
|
397
|
+
* skip: 1,
|
|
398
|
+
* take: 1
|
|
399
|
+
* }
|
|
400
|
+
*/
|
|
401
|
+
interface GetContractTemplatesRequest {
|
|
402
|
+
/** Number of records to skip */
|
|
214
403
|
skip?: number;
|
|
404
|
+
/** Number of records to take */
|
|
215
405
|
take?: number;
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
}
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
}
|
|
232
|
-
type PaymentType = 'Withdraw' | 'Deposit';
|
|
233
|
-
type PaymentStatus = 'Pending' | 'Confirmed';
|
|
234
|
-
type AssetType = 'Token' | 'NFT';
|
|
235
|
-
type TransactionType = 'withdraw' | 'deposit';
|
|
236
|
-
type TransactionStatus = 'pending' | 'confirmed';
|
|
237
|
-
type Tags = {
|
|
238
|
-
name: string;
|
|
239
|
-
address: Address[];
|
|
240
|
-
};
|
|
241
|
-
type Organization = {
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
/**
|
|
409
|
+
* @example
|
|
410
|
+
* {
|
|
411
|
+
* name: "name",
|
|
412
|
+
* description: "description",
|
|
413
|
+
* abi: [{
|
|
414
|
+
* "key": "value"
|
|
415
|
+
* }],
|
|
416
|
+
* bytecode: "bytecode"
|
|
417
|
+
* }
|
|
418
|
+
*/
|
|
419
|
+
interface CreateContractTemplateRequest {
|
|
420
|
+
/** Contract template name */
|
|
242
421
|
name: string;
|
|
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
|
-
|
|
422
|
+
/** Contract template description */
|
|
423
|
+
description: string;
|
|
424
|
+
/** Contract ABI */
|
|
425
|
+
abi: Record<string, unknown>[];
|
|
426
|
+
/** Contract bytecode */
|
|
427
|
+
bytecode: string;
|
|
428
|
+
/** Long description of the contract */
|
|
429
|
+
longDescription?: string;
|
|
430
|
+
/** Contract source code */
|
|
431
|
+
sourceCode?: string;
|
|
432
|
+
/** Contract type */
|
|
433
|
+
type?: string;
|
|
434
|
+
/** Contract documentation */
|
|
435
|
+
docs?: CreateContractTemplateRequest.Docs;
|
|
436
|
+
/** Contract attributes */
|
|
437
|
+
attributes?: CreateContractTemplateRequest.Attributes;
|
|
438
|
+
}
|
|
439
|
+
declare namespace CreateContractTemplateRequest {
|
|
440
|
+
/**
|
|
441
|
+
* Contract documentation
|
|
442
|
+
*/
|
|
443
|
+
interface Docs {
|
|
444
|
+
details?: string;
|
|
445
|
+
events?: string;
|
|
446
|
+
kind?: Docs.Kind;
|
|
447
|
+
methods?: Docs.Methods.Item[];
|
|
448
|
+
version?: string;
|
|
449
|
+
}
|
|
450
|
+
namespace Docs {
|
|
451
|
+
const Kind: {
|
|
452
|
+
readonly Dev: "dev";
|
|
453
|
+
readonly User: "user";
|
|
454
|
+
};
|
|
455
|
+
type Kind = (typeof Kind)[keyof typeof Kind];
|
|
456
|
+
type Methods = Methods.Item[];
|
|
457
|
+
namespace Methods {
|
|
458
|
+
interface Item {
|
|
459
|
+
name?: string;
|
|
460
|
+
description?: string;
|
|
461
|
+
params?: Record<string, unknown>;
|
|
462
|
+
returns?: Record<string, unknown>;
|
|
463
|
+
}
|
|
464
|
+
}
|
|
465
|
+
}
|
|
466
|
+
/**
|
|
467
|
+
* Contract attributes
|
|
468
|
+
*/
|
|
469
|
+
interface Attributes {
|
|
470
|
+
useCases?: string[];
|
|
471
|
+
standards?: string[];
|
|
472
|
+
auditor?: Attributes.Auditor;
|
|
473
|
+
}
|
|
474
|
+
namespace Attributes {
|
|
475
|
+
interface Auditor {
|
|
476
|
+
name?: string;
|
|
477
|
+
imageURL?: string;
|
|
478
|
+
link?: string;
|
|
479
|
+
}
|
|
480
|
+
}
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* @example
|
|
485
|
+
* {
|
|
486
|
+
* functionSignature: "functionSignature"
|
|
487
|
+
* }
|
|
488
|
+
*/
|
|
489
|
+
interface GetTemplateFunctionsRequest {
|
|
490
|
+
/** Function signature to filter by */
|
|
491
|
+
functionSignature?: string;
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
/**
|
|
495
|
+
* @example
|
|
496
|
+
* {
|
|
497
|
+
* network: "network",
|
|
498
|
+
* addressId: "addressId",
|
|
499
|
+
* clientShare: "clientShare"
|
|
500
|
+
* }
|
|
501
|
+
*/
|
|
502
|
+
interface DeployContractRequest {
|
|
503
|
+
/** Target network */
|
|
504
|
+
network: string;
|
|
505
|
+
/** Address ID for deployment */
|
|
286
506
|
addressId: string;
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
type
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
}
|
|
309
|
-
|
|
507
|
+
/** Client share for signing */
|
|
508
|
+
clientShare: string;
|
|
509
|
+
/** Constructor parameters */
|
|
510
|
+
constructorParameters?: DeployContractRequest.ConstructorParameters.Item[];
|
|
511
|
+
}
|
|
512
|
+
declare namespace DeployContractRequest {
|
|
513
|
+
type ConstructorParameters = ConstructorParameters.Item[];
|
|
514
|
+
namespace ConstructorParameters {
|
|
515
|
+
interface Item {
|
|
516
|
+
/** Parameter name */
|
|
517
|
+
name: string;
|
|
518
|
+
/** Parameter description */
|
|
519
|
+
description?: string;
|
|
520
|
+
/** Internal parameter type */
|
|
521
|
+
internalType?: string;
|
|
522
|
+
/** Parameter type */
|
|
523
|
+
type: string;
|
|
524
|
+
/** Parameter components */
|
|
525
|
+
components?: Record<string, unknown>[];
|
|
526
|
+
/** Parameter value */
|
|
527
|
+
value?: string;
|
|
528
|
+
}
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
declare const index$3_CreateContractTemplateRequest: typeof CreateContractTemplateRequest;
|
|
533
|
+
declare const index$3_DeployContractRequest: typeof DeployContractRequest;
|
|
534
|
+
type index$3_GetContractTemplatesRequest = GetContractTemplatesRequest;
|
|
535
|
+
type index$3_GetTemplateFunctionsRequest = GetTemplateFunctionsRequest;
|
|
536
|
+
declare namespace index$3 {
|
|
537
|
+
export {
|
|
538
|
+
index$3_CreateContractTemplateRequest as CreateContractTemplateRequest,
|
|
539
|
+
index$3_DeployContractRequest as DeployContractRequest,
|
|
540
|
+
index$3_GetContractTemplatesRequest as GetContractTemplatesRequest,
|
|
541
|
+
index$3_GetTemplateFunctionsRequest as GetTemplateFunctionsRequest,
|
|
542
|
+
};
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* @example
|
|
547
|
+
* {
|
|
548
|
+
* abiFunction: {
|
|
549
|
+
* name: "name",
|
|
550
|
+
* inputs: [{}],
|
|
551
|
+
* outputs: [{}],
|
|
552
|
+
* type: "type"
|
|
553
|
+
* }
|
|
554
|
+
* }
|
|
555
|
+
*/
|
|
556
|
+
interface ReadFunctionRequest {
|
|
557
|
+
/** ABI function definition */
|
|
558
|
+
abiFunction: ReadFunctionRequest.AbiFunction;
|
|
559
|
+
}
|
|
560
|
+
declare namespace ReadFunctionRequest {
|
|
561
|
+
/**
|
|
562
|
+
* ABI function definition
|
|
563
|
+
*/
|
|
564
|
+
interface AbiFunction {
|
|
565
|
+
/** Function name */
|
|
566
|
+
name: string;
|
|
567
|
+
/** Function input parameters */
|
|
568
|
+
inputs: AbiFunction.Inputs.Item[];
|
|
569
|
+
/** Function output parameters */
|
|
570
|
+
outputs: AbiFunction.Outputs.Item[];
|
|
571
|
+
stateMutability?: string;
|
|
572
|
+
type: string;
|
|
573
|
+
}
|
|
574
|
+
namespace AbiFunction {
|
|
575
|
+
type Inputs = Inputs.Item[];
|
|
576
|
+
namespace Inputs {
|
|
577
|
+
interface Item {
|
|
578
|
+
name?: string;
|
|
579
|
+
type?: string;
|
|
580
|
+
internalType?: string;
|
|
581
|
+
}
|
|
582
|
+
}
|
|
583
|
+
type Outputs = Outputs.Item[];
|
|
584
|
+
namespace Outputs {
|
|
585
|
+
interface Item {
|
|
586
|
+
name?: string;
|
|
587
|
+
type?: string;
|
|
588
|
+
internalType?: string;
|
|
589
|
+
}
|
|
590
|
+
}
|
|
591
|
+
}
|
|
592
|
+
}
|
|
593
|
+
|
|
594
|
+
/**
|
|
595
|
+
* @example
|
|
596
|
+
* {
|
|
597
|
+
* addressId: "addressId",
|
|
598
|
+
* clientShare: "clientShare",
|
|
599
|
+
* abiFunction: {
|
|
600
|
+
* name: "name",
|
|
601
|
+
* inputs: [{}],
|
|
602
|
+
* outputs: [{}],
|
|
603
|
+
* type: "type"
|
|
604
|
+
* }
|
|
605
|
+
* }
|
|
606
|
+
*/
|
|
607
|
+
interface WriteFunctionRequest {
|
|
608
|
+
/** Address ID for transaction */
|
|
609
|
+
addressId: string;
|
|
610
|
+
/** Client share for signing */
|
|
611
|
+
clientShare: string;
|
|
612
|
+
/** ABI function definition */
|
|
613
|
+
abiFunction: WriteFunctionRequest.AbiFunction;
|
|
614
|
+
/** ETH value to send */
|
|
615
|
+
amount?: string;
|
|
616
|
+
/** Fee level for transaction */
|
|
617
|
+
feeLevel?: WriteFunctionRequest.FeeLevel;
|
|
618
|
+
}
|
|
619
|
+
declare namespace WriteFunctionRequest {
|
|
620
|
+
/**
|
|
621
|
+
* ABI function definition
|
|
622
|
+
*/
|
|
623
|
+
interface AbiFunction {
|
|
624
|
+
/** Function name */
|
|
625
|
+
name: string;
|
|
626
|
+
/** Function input parameters */
|
|
627
|
+
inputs: AbiFunction.Inputs.Item[];
|
|
628
|
+
/** Function output parameters */
|
|
629
|
+
outputs: AbiFunction.Outputs.Item[];
|
|
630
|
+
stateMutability?: string;
|
|
631
|
+
type: string;
|
|
632
|
+
}
|
|
633
|
+
namespace AbiFunction {
|
|
634
|
+
type Inputs = Inputs.Item[];
|
|
635
|
+
namespace Inputs {
|
|
636
|
+
interface Item {
|
|
637
|
+
name?: string;
|
|
638
|
+
type?: string;
|
|
639
|
+
internalType?: string;
|
|
640
|
+
}
|
|
641
|
+
}
|
|
642
|
+
type Outputs = Outputs.Item[];
|
|
643
|
+
namespace Outputs {
|
|
644
|
+
interface Item {
|
|
645
|
+
name?: string;
|
|
646
|
+
type?: string;
|
|
647
|
+
internalType?: string;
|
|
648
|
+
}
|
|
649
|
+
}
|
|
650
|
+
}
|
|
651
|
+
/** Fee level for transaction */
|
|
652
|
+
const FeeLevel: {
|
|
653
|
+
readonly Low: "LOW";
|
|
654
|
+
readonly Medium: "MEDIUM";
|
|
655
|
+
readonly High: "HIGH";
|
|
656
|
+
};
|
|
657
|
+
type FeeLevel = (typeof FeeLevel)[keyof typeof FeeLevel];
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
declare const index$2_ReadFunctionRequest: typeof ReadFunctionRequest;
|
|
661
|
+
declare const index$2_WriteFunctionRequest: typeof WriteFunctionRequest;
|
|
662
|
+
declare namespace index$2 {
|
|
663
|
+
export {
|
|
664
|
+
index$2_ReadFunctionRequest as ReadFunctionRequest,
|
|
665
|
+
index$2_WriteFunctionRequest as WriteFunctionRequest,
|
|
666
|
+
};
|
|
667
|
+
}
|
|
668
|
+
|
|
669
|
+
/**
|
|
670
|
+
* @example
|
|
671
|
+
* {
|
|
672
|
+
* skip: 1,
|
|
673
|
+
* take: 1
|
|
674
|
+
* }
|
|
675
|
+
*/
|
|
676
|
+
interface GetTokensRequest {
|
|
677
|
+
/** Number of records to skip */
|
|
678
|
+
skip?: number;
|
|
679
|
+
/** Number of records to take */
|
|
680
|
+
take?: number;
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
/**
|
|
684
|
+
* @example
|
|
685
|
+
* {
|
|
686
|
+
* addressId: "addressId",
|
|
687
|
+
* clientShare: "clientShare",
|
|
688
|
+
* deploymentId: "deploymentId",
|
|
689
|
+
* createParams: {
|
|
690
|
+
* initializeParams: [{
|
|
691
|
+
* name: "name",
|
|
692
|
+
* type: "type",
|
|
693
|
+
* value: "value"
|
|
694
|
+
* }]
|
|
695
|
+
* }
|
|
696
|
+
* }
|
|
697
|
+
*/
|
|
698
|
+
interface IssueNewTokenRequest {
|
|
699
|
+
/** Blockchain network */
|
|
700
|
+
network?: string;
|
|
701
|
+
/** Address ID for token creation */
|
|
702
|
+
addressId: string;
|
|
703
|
+
/** Client share for signing */
|
|
704
|
+
clientShare: string;
|
|
705
|
+
/** Deployed contract ID */
|
|
706
|
+
deploymentId: string;
|
|
707
|
+
createParams: IssueNewTokenRequest.CreateParams;
|
|
708
|
+
/** Token display name */
|
|
709
|
+
displayName?: string;
|
|
710
|
+
/** Use gasless transaction */
|
|
711
|
+
useGasless?: boolean;
|
|
712
|
+
/** Transaction fee */
|
|
713
|
+
fee?: string;
|
|
714
|
+
/** Fee level */
|
|
715
|
+
feeLevel?: string;
|
|
716
|
+
}
|
|
717
|
+
declare namespace IssueNewTokenRequest {
|
|
718
|
+
interface CreateParams {
|
|
719
|
+
/** Initialize parameters */
|
|
720
|
+
initializeParams: CreateParams.InitializeParams.Item[];
|
|
721
|
+
}
|
|
722
|
+
namespace CreateParams {
|
|
723
|
+
type InitializeParams = InitializeParams.Item[];
|
|
724
|
+
namespace InitializeParams {
|
|
725
|
+
interface Item {
|
|
726
|
+
/** Parameter name */
|
|
727
|
+
name: string;
|
|
728
|
+
/** Parameter type */
|
|
729
|
+
type: string;
|
|
730
|
+
/** Parameter value */
|
|
731
|
+
value: string;
|
|
732
|
+
}
|
|
733
|
+
}
|
|
734
|
+
}
|
|
735
|
+
}
|
|
736
|
+
|
|
737
|
+
/**
|
|
738
|
+
* @example
|
|
739
|
+
* {
|
|
740
|
+
* contractAddress: "contractAddress"
|
|
741
|
+
* }
|
|
742
|
+
*/
|
|
743
|
+
interface LinkContractRequest {
|
|
744
|
+
/** Contract type */
|
|
745
|
+
type?: string;
|
|
746
|
+
/** Reference ID */
|
|
747
|
+
refId?: string;
|
|
748
|
+
/** Display name */
|
|
749
|
+
displayName?: string;
|
|
750
|
+
/** Blockchain network */
|
|
751
|
+
network?: string;
|
|
752
|
+
/** Contract address */
|
|
753
|
+
contractAddress: string;
|
|
754
|
+
}
|
|
755
|
+
|
|
756
|
+
/**
|
|
757
|
+
* @example
|
|
758
|
+
* {
|
|
759
|
+
* skip: 1,
|
|
760
|
+
* take: 1
|
|
761
|
+
* }
|
|
762
|
+
*/
|
|
763
|
+
interface GetCollectionsRequest {
|
|
764
|
+
/** Number of records to skip */
|
|
765
|
+
skip?: number;
|
|
766
|
+
/** Number of records to take */
|
|
767
|
+
take?: number;
|
|
768
|
+
}
|
|
769
|
+
|
|
770
|
+
/**
|
|
771
|
+
* @example
|
|
772
|
+
* {
|
|
773
|
+
* type: "NON_FUNGIBLE_TOKEN",
|
|
774
|
+
* addressId: "addressId",
|
|
775
|
+
* clientShare: "clientShare",
|
|
776
|
+
* createParams: {
|
|
777
|
+
* initializeParams: [{
|
|
778
|
+
* name: "name",
|
|
779
|
+
* type: "type",
|
|
780
|
+
* value: "value"
|
|
781
|
+
* }]
|
|
782
|
+
* }
|
|
783
|
+
* }
|
|
784
|
+
*/
|
|
785
|
+
interface CreateCollectionRequest {
|
|
786
|
+
/** Blockchain network */
|
|
787
|
+
network?: string;
|
|
788
|
+
/** Collection type */
|
|
789
|
+
type: CreateCollectionRequest.Type;
|
|
790
|
+
/** Address ID for collection creation */
|
|
791
|
+
addressId: string;
|
|
792
|
+
/** Client share for signing */
|
|
793
|
+
clientShare: string;
|
|
794
|
+
createParams: CreateCollectionRequest.CreateParams;
|
|
795
|
+
/** Collection description */
|
|
796
|
+
description?: string;
|
|
797
|
+
/** Collection display name */
|
|
798
|
+
displayName?: string;
|
|
799
|
+
/** Use gasless transaction */
|
|
800
|
+
useGasless?: boolean;
|
|
801
|
+
/** Transaction fee */
|
|
802
|
+
fee?: string;
|
|
803
|
+
/** Fee level */
|
|
804
|
+
feeLevel?: string;
|
|
805
|
+
}
|
|
806
|
+
declare namespace CreateCollectionRequest {
|
|
807
|
+
/** Collection type */
|
|
808
|
+
const Type: {
|
|
809
|
+
readonly NonFungibleToken: "NON_FUNGIBLE_TOKEN";
|
|
810
|
+
readonly SemiFungibleToken: "SEMI_FUNGIBLE_TOKEN";
|
|
811
|
+
};
|
|
812
|
+
type Type = (typeof Type)[keyof typeof Type];
|
|
813
|
+
interface CreateParams {
|
|
814
|
+
/** Initialize parameters */
|
|
815
|
+
initializeParams: CreateParams.InitializeParams.Item[];
|
|
816
|
+
}
|
|
817
|
+
namespace CreateParams {
|
|
818
|
+
type InitializeParams = InitializeParams.Item[];
|
|
819
|
+
namespace InitializeParams {
|
|
820
|
+
interface Item {
|
|
821
|
+
/** Parameter name */
|
|
822
|
+
name: string;
|
|
823
|
+
/** Parameter type */
|
|
824
|
+
type: string;
|
|
825
|
+
/** Parameter value */
|
|
826
|
+
value: string;
|
|
827
|
+
}
|
|
828
|
+
}
|
|
829
|
+
}
|
|
830
|
+
}
|
|
831
|
+
|
|
832
|
+
/**
|
|
833
|
+
* @example
|
|
834
|
+
* {
|
|
835
|
+
* addressId: "addressId",
|
|
836
|
+
* clientShare: "clientShare",
|
|
837
|
+
* to: "to",
|
|
838
|
+
* tokenId: "tokenId"
|
|
839
|
+
* }
|
|
840
|
+
*/
|
|
841
|
+
interface MintTokenRequest {
|
|
842
|
+
/** Address ID for minting */
|
|
843
|
+
addressId: string;
|
|
844
|
+
/** Client share for signing */
|
|
845
|
+
clientShare: string;
|
|
846
|
+
/** Recipient address */
|
|
847
|
+
to: string;
|
|
848
|
+
/** Token ID */
|
|
849
|
+
tokenId: string;
|
|
850
|
+
/** Token amount */
|
|
851
|
+
amount?: string;
|
|
852
|
+
/** Token metadata URI */
|
|
853
|
+
metadataURI?: string;
|
|
854
|
+
metadata?: MintTokenRequest.Metadata;
|
|
855
|
+
}
|
|
856
|
+
declare namespace MintTokenRequest {
|
|
857
|
+
interface Metadata {
|
|
858
|
+
/** Token name */
|
|
859
|
+
name: string;
|
|
860
|
+
/** Token description */
|
|
861
|
+
description: string;
|
|
862
|
+
/** Token image URL */
|
|
863
|
+
image?: string;
|
|
864
|
+
/** Token animation URL */
|
|
865
|
+
animation_url?: string;
|
|
866
|
+
/** External URL */
|
|
867
|
+
external_url?: string;
|
|
868
|
+
/** Token attributes */
|
|
869
|
+
attributes?: Metadata.Attributes.Item[];
|
|
870
|
+
}
|
|
871
|
+
namespace Metadata {
|
|
872
|
+
type Attributes = Attributes.Item[];
|
|
873
|
+
namespace Attributes {
|
|
874
|
+
interface Item {
|
|
875
|
+
/** Trait type */
|
|
876
|
+
trait_type: string;
|
|
877
|
+
/** Trait value */
|
|
878
|
+
value: string;
|
|
879
|
+
/** Display type */
|
|
880
|
+
display_type?: string;
|
|
881
|
+
}
|
|
882
|
+
}
|
|
883
|
+
}
|
|
884
|
+
}
|
|
885
|
+
|
|
886
|
+
/**
|
|
887
|
+
* @example
|
|
888
|
+
* {
|
|
889
|
+
* addressId: "addressId",
|
|
890
|
+
* clientShare: "clientShare",
|
|
891
|
+
* tokenId: "tokenId"
|
|
892
|
+
* }
|
|
893
|
+
*/
|
|
894
|
+
interface BurnTokenRequest {
|
|
895
|
+
/** Address ID for burning */
|
|
896
|
+
addressId: string;
|
|
897
|
+
/** Client share for signing */
|
|
898
|
+
clientShare: string;
|
|
899
|
+
/** Token ID */
|
|
900
|
+
tokenId: string;
|
|
901
|
+
/** Address to burn from */
|
|
902
|
+
from?: string;
|
|
903
|
+
/** Token amount to burn */
|
|
904
|
+
amount?: string;
|
|
905
|
+
}
|
|
906
|
+
|
|
907
|
+
type index$1_BurnTokenRequest = BurnTokenRequest;
|
|
908
|
+
declare const index$1_CreateCollectionRequest: typeof CreateCollectionRequest;
|
|
909
|
+
type index$1_GetCollectionsRequest = GetCollectionsRequest;
|
|
910
|
+
type index$1_GetTokensRequest = GetTokensRequest;
|
|
911
|
+
declare const index$1_IssueNewTokenRequest: typeof IssueNewTokenRequest;
|
|
912
|
+
type index$1_LinkContractRequest = LinkContractRequest;
|
|
913
|
+
declare const index$1_MintTokenRequest: typeof MintTokenRequest;
|
|
914
|
+
declare namespace index$1 {
|
|
915
|
+
export {
|
|
916
|
+
index$1_BurnTokenRequest as BurnTokenRequest,
|
|
917
|
+
index$1_CreateCollectionRequest as CreateCollectionRequest,
|
|
918
|
+
index$1_GetCollectionsRequest as GetCollectionsRequest,
|
|
919
|
+
index$1_GetTokensRequest as GetTokensRequest,
|
|
920
|
+
index$1_IssueNewTokenRequest as IssueNewTokenRequest,
|
|
921
|
+
index$1_LinkContractRequest as LinkContractRequest,
|
|
922
|
+
index$1_MintTokenRequest as MintTokenRequest,
|
|
923
|
+
};
|
|
924
|
+
}
|
|
925
|
+
|
|
926
|
+
interface LinkedTokenData {
|
|
310
927
|
id: string;
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
createdAt: Date;
|
|
319
|
-
updatedAt: Date;
|
|
320
|
-
};
|
|
321
|
-
type TGetProfileWalletsResponse = {
|
|
322
|
-
reference: string;
|
|
323
|
-
};
|
|
324
|
-
type TGenerateAddressResponse = {
|
|
325
|
-
data: string;
|
|
928
|
+
linked: boolean;
|
|
929
|
+
collectionId?: string;
|
|
930
|
+
}
|
|
931
|
+
|
|
932
|
+
interface LinkedTokenResponse {
|
|
933
|
+
data: LinkedTokenData;
|
|
934
|
+
/** Response message */
|
|
326
935
|
message: string;
|
|
936
|
+
/** Indicates successful response */
|
|
327
937
|
success: boolean;
|
|
938
|
+
/** HTTP status code */
|
|
328
939
|
status: number;
|
|
329
|
-
}
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
reference: string;
|
|
338
|
-
}[];
|
|
339
|
-
type TGetOrganizationResponse = {
|
|
340
|
-
id: string;
|
|
341
|
-
name: string;
|
|
342
|
-
email: string;
|
|
343
|
-
};
|
|
344
|
-
type TGetOumlaResponse<T> = {
|
|
345
|
-
data: T;
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
interface SuccessResponse {
|
|
943
|
+
/** Response message */
|
|
944
|
+
message: string;
|
|
945
|
+
/** Response data */
|
|
946
|
+
data?: Record<string, unknown>;
|
|
947
|
+
/** Indicates successful response */
|
|
346
948
|
success: boolean;
|
|
949
|
+
/** HTTP status code */
|
|
347
950
|
status: number;
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
951
|
+
}
|
|
952
|
+
|
|
953
|
+
interface ErrorResponse {
|
|
954
|
+
/** Error message */
|
|
351
955
|
message: string;
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
};
|
|
956
|
+
/** Array of field-specific errors */
|
|
957
|
+
errors?: ErrorResponse.Errors.Item[];
|
|
958
|
+
/** Indicates failed response */
|
|
356
959
|
success: boolean;
|
|
960
|
+
/** HTTP status code */
|
|
357
961
|
status: number;
|
|
962
|
+
}
|
|
963
|
+
declare namespace ErrorResponse {
|
|
964
|
+
type Errors = Errors.Item[];
|
|
965
|
+
namespace Errors {
|
|
966
|
+
interface Item {
|
|
967
|
+
/** Field name that caused the error */
|
|
968
|
+
field?: string;
|
|
969
|
+
/** Error message for the field */
|
|
970
|
+
message?: string;
|
|
971
|
+
}
|
|
972
|
+
}
|
|
973
|
+
}
|
|
974
|
+
|
|
975
|
+
interface PaginatedResponse extends SuccessResponse {
|
|
976
|
+
pagination?: PaginatedResponse.Pagination;
|
|
977
|
+
}
|
|
978
|
+
declare namespace PaginatedResponse {
|
|
979
|
+
interface Pagination {
|
|
980
|
+
/** Number of records skipped */
|
|
981
|
+
skip: number;
|
|
982
|
+
/** Number of records taken */
|
|
983
|
+
take: number;
|
|
984
|
+
/** Total number of elements */
|
|
985
|
+
totalElements: number;
|
|
986
|
+
/** Total number of pages */
|
|
987
|
+
totalPages: number;
|
|
988
|
+
}
|
|
989
|
+
}
|
|
990
|
+
|
|
991
|
+
/**
|
|
992
|
+
* The raw response from the fetch call excluding the body.
|
|
993
|
+
*/
|
|
994
|
+
type RawResponse = Omit<{
|
|
995
|
+
[K in keyof Response as Response[K] extends Function ? never : K]: Response[K];
|
|
996
|
+
}, "ok" | "body" | "bodyUsed">;
|
|
997
|
+
/**
|
|
998
|
+
* Creates a `RawResponse` from a standard `Response` object.
|
|
999
|
+
*/
|
|
1000
|
+
interface WithRawResponse<T> {
|
|
1001
|
+
readonly data: T;
|
|
1002
|
+
readonly rawResponse: RawResponse;
|
|
1003
|
+
}
|
|
1004
|
+
|
|
1005
|
+
type Supplier<T> = T | Promise<T> | (() => T | Promise<T>);
|
|
1006
|
+
declare const Supplier: {
|
|
1007
|
+
get: <T>(supplier: Supplier<T>) => Promise<T>;
|
|
358
1008
|
};
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
1009
|
+
|
|
1010
|
+
/**
|
|
1011
|
+
* A promise that returns the parsed response and lets you retrieve the raw response too.
|
|
1012
|
+
*/
|
|
1013
|
+
declare class HttpResponsePromise<T> extends Promise<T> {
|
|
1014
|
+
private innerPromise;
|
|
1015
|
+
private unwrappedPromise;
|
|
1016
|
+
private constructor();
|
|
1017
|
+
/**
|
|
1018
|
+
* Creates an `HttpResponsePromise` from a function that returns a promise.
|
|
1019
|
+
*
|
|
1020
|
+
* @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
|
|
1021
|
+
* @param args - Arguments to pass to the function.
|
|
1022
|
+
* @returns An `HttpResponsePromise` instance.
|
|
1023
|
+
*/
|
|
1024
|
+
static fromFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T>(fn: F, ...args: Parameters<F>): HttpResponsePromise<T>;
|
|
1025
|
+
/**
|
|
1026
|
+
* Creates a function that returns an `HttpResponsePromise` from a function that returns a promise.
|
|
1027
|
+
*
|
|
1028
|
+
* @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
|
|
1029
|
+
* @returns A function that returns an `HttpResponsePromise` instance.
|
|
1030
|
+
*/
|
|
1031
|
+
static interceptFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T = Awaited<ReturnType<F>>["data"]>(fn: F): (...args: Parameters<F>) => HttpResponsePromise<T>;
|
|
1032
|
+
/**
|
|
1033
|
+
* Creates an `HttpResponsePromise` from an existing promise.
|
|
1034
|
+
*
|
|
1035
|
+
* @param promise - A promise resolving to a `WithRawResponse` object.
|
|
1036
|
+
* @returns An `HttpResponsePromise` instance.
|
|
1037
|
+
*/
|
|
1038
|
+
static fromPromise<T>(promise: Promise<WithRawResponse<T>>): HttpResponsePromise<T>;
|
|
1039
|
+
/**
|
|
1040
|
+
* Creates an `HttpResponsePromise` from an executor function.
|
|
1041
|
+
*
|
|
1042
|
+
* @param executor - A function that takes resolve and reject callbacks to create a promise.
|
|
1043
|
+
* @returns An `HttpResponsePromise` instance.
|
|
1044
|
+
*/
|
|
1045
|
+
static fromExecutor<T>(executor: (resolve: (value: WithRawResponse<T>) => void, reject: (reason?: unknown) => void) => void): HttpResponsePromise<T>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Creates an `HttpResponsePromise` from a resolved result.
|
|
1048
|
+
*
|
|
1049
|
+
* @param result - A `WithRawResponse` object to resolve immediately.
|
|
1050
|
+
* @returns An `HttpResponsePromise` instance.
|
|
1051
|
+
*/
|
|
1052
|
+
static fromResult<T>(result: WithRawResponse<T>): HttpResponsePromise<T>;
|
|
1053
|
+
private unwrap;
|
|
1054
|
+
/** @inheritdoc */
|
|
1055
|
+
then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
|
|
1056
|
+
/** @inheritdoc */
|
|
1057
|
+
catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
|
|
1058
|
+
/** @inheritdoc */
|
|
1059
|
+
finally(onfinally?: (() => void) | null): Promise<T>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Retrieves the data and raw response.
|
|
1062
|
+
*
|
|
1063
|
+
* @returns A promise resolving to a `WithRawResponse` object.
|
|
1064
|
+
*/
|
|
1065
|
+
withRawResponse(): Promise<WithRawResponse<T>>;
|
|
1066
|
+
}
|
|
1067
|
+
|
|
1068
|
+
type BearerToken = string;
|
|
1069
|
+
declare const BearerToken: {
|
|
1070
|
+
toAuthorizationHeader: (token: BearerToken | undefined) => string | undefined;
|
|
1071
|
+
fromAuthorizationHeader: (header: string) => BearerToken;
|
|
404
1072
|
};
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
1073
|
+
|
|
1074
|
+
declare class OumlaSdkApiError extends Error {
|
|
1075
|
+
readonly statusCode?: number;
|
|
1076
|
+
readonly body?: unknown;
|
|
1077
|
+
readonly rawResponse?: RawResponse;
|
|
1078
|
+
constructor({ message, statusCode, body, rawResponse, }: {
|
|
1079
|
+
message?: string;
|
|
1080
|
+
statusCode?: number;
|
|
1081
|
+
body?: unknown;
|
|
1082
|
+
rawResponse?: RawResponse;
|
|
1083
|
+
});
|
|
1084
|
+
}
|
|
1085
|
+
|
|
1086
|
+
declare class OumlaSdkApiTimeoutError extends Error {
|
|
1087
|
+
constructor(message: string);
|
|
1088
|
+
}
|
|
1089
|
+
|
|
1090
|
+
declare class BadRequestError extends OumlaSdkApiError {
|
|
1091
|
+
constructor(body: ErrorResponse, rawResponse?: RawResponse);
|
|
1092
|
+
}
|
|
1093
|
+
|
|
1094
|
+
type index_AddContractAbiRequest = AddContractAbiRequest;
|
|
1095
|
+
type index_BadRequestError = BadRequestError;
|
|
1096
|
+
declare const index_BadRequestError: typeof BadRequestError;
|
|
1097
|
+
type index_BurnTokenRequest = BurnTokenRequest;
|
|
1098
|
+
declare const index_CreateAddressRequest: typeof CreateAddressRequest;
|
|
1099
|
+
declare const index_CreateCollectionRequest: typeof CreateCollectionRequest;
|
|
1100
|
+
declare const index_CreateContractTemplateRequest: typeof CreateContractTemplateRequest;
|
|
1101
|
+
declare const index_CreateProfileRequest: typeof CreateProfileRequest;
|
|
1102
|
+
declare const index_CreateWalletRequest: typeof CreateWalletRequest;
|
|
1103
|
+
declare const index_CreateWithdrawalRequest: typeof CreateWithdrawalRequest;
|
|
1104
|
+
declare const index_DeployContractRequest: typeof DeployContractRequest;
|
|
1105
|
+
declare const index_ErrorResponse: typeof ErrorResponse;
|
|
1106
|
+
type index_FetchContractAbiRequest = FetchContractAbiRequest;
|
|
1107
|
+
type index_GetAssetsByAddressRequest = GetAssetsByAddressRequest;
|
|
1108
|
+
type index_GetAssetsByWalletRequest = GetAssetsByWalletRequest;
|
|
1109
|
+
type index_GetCollectionsRequest = GetCollectionsRequest;
|
|
1110
|
+
type index_GetContractTemplatesRequest = GetContractTemplatesRequest;
|
|
1111
|
+
type index_GetDeployedContractsRequest = GetDeployedContractsRequest;
|
|
1112
|
+
type index_GetDeployedContractsRequestNetwork = GetDeployedContractsRequestNetwork;
|
|
1113
|
+
type index_GetOrganizationAddressesRequest = GetOrganizationAddressesRequest;
|
|
1114
|
+
type index_GetOrganizationTransactionsRequest = GetOrganizationTransactionsRequest;
|
|
1115
|
+
type index_GetOrganizationWalletsRequest = GetOrganizationWalletsRequest;
|
|
1116
|
+
type index_GetProfileAddressesRequest = GetProfileAddressesRequest;
|
|
1117
|
+
type index_GetProfileTransactionsRequest = GetProfileTransactionsRequest;
|
|
1118
|
+
type index_GetProfileWalletsRequest = GetProfileWalletsRequest;
|
|
1119
|
+
type index_GetProfilesRequest = GetProfilesRequest;
|
|
1120
|
+
type index_GetTemplateFunctionsRequest = GetTemplateFunctionsRequest;
|
|
1121
|
+
type index_GetTokensRequest = GetTokensRequest;
|
|
1122
|
+
type index_GetTransactionsByAddressRequest = GetTransactionsByAddressRequest;
|
|
1123
|
+
type index_GetTransactionsByWalletRequest = GetTransactionsByWalletRequest;
|
|
1124
|
+
declare const index_IssueNewTokenRequest: typeof IssueNewTokenRequest;
|
|
1125
|
+
type index_LinkContractRequest = LinkContractRequest;
|
|
1126
|
+
type index_LinkedTokenData = LinkedTokenData;
|
|
1127
|
+
type index_LinkedTokenResponse = LinkedTokenResponse;
|
|
1128
|
+
declare const index_MintTokenRequest: typeof MintTokenRequest;
|
|
1129
|
+
declare const index_PaginatedResponse: typeof PaginatedResponse;
|
|
1130
|
+
declare const index_ReadFunctionRequest: typeof ReadFunctionRequest;
|
|
1131
|
+
type index_SuccessResponse = SuccessResponse;
|
|
1132
|
+
declare const index_WriteFunctionRequest: typeof WriteFunctionRequest;
|
|
1133
|
+
declare namespace index {
|
|
1134
|
+
export {
|
|
1135
|
+
index_AddContractAbiRequest as AddContractAbiRequest,
|
|
1136
|
+
index_BadRequestError as BadRequestError,
|
|
1137
|
+
index_BurnTokenRequest as BurnTokenRequest,
|
|
1138
|
+
index_CreateAddressRequest as CreateAddressRequest,
|
|
1139
|
+
index_CreateCollectionRequest as CreateCollectionRequest,
|
|
1140
|
+
index_CreateContractTemplateRequest as CreateContractTemplateRequest,
|
|
1141
|
+
index_CreateProfileRequest as CreateProfileRequest,
|
|
1142
|
+
index_CreateWalletRequest as CreateWalletRequest,
|
|
1143
|
+
index_CreateWithdrawalRequest as CreateWithdrawalRequest,
|
|
1144
|
+
index_DeployContractRequest as DeployContractRequest,
|
|
1145
|
+
index_ErrorResponse as ErrorResponse,
|
|
1146
|
+
index_FetchContractAbiRequest as FetchContractAbiRequest,
|
|
1147
|
+
index_GetAssetsByAddressRequest as GetAssetsByAddressRequest,
|
|
1148
|
+
index_GetAssetsByWalletRequest as GetAssetsByWalletRequest,
|
|
1149
|
+
index_GetCollectionsRequest as GetCollectionsRequest,
|
|
1150
|
+
index_GetContractTemplatesRequest as GetContractTemplatesRequest,
|
|
1151
|
+
index_GetDeployedContractsRequest as GetDeployedContractsRequest,
|
|
1152
|
+
index_GetDeployedContractsRequestNetwork as GetDeployedContractsRequestNetwork,
|
|
1153
|
+
index_GetOrganizationAddressesRequest as GetOrganizationAddressesRequest,
|
|
1154
|
+
index_GetOrganizationTransactionsRequest as GetOrganizationTransactionsRequest,
|
|
1155
|
+
index_GetOrganizationWalletsRequest as GetOrganizationWalletsRequest,
|
|
1156
|
+
index_GetProfileAddressesRequest as GetProfileAddressesRequest,
|
|
1157
|
+
index_GetProfileTransactionsRequest as GetProfileTransactionsRequest,
|
|
1158
|
+
index_GetProfileWalletsRequest as GetProfileWalletsRequest,
|
|
1159
|
+
index_GetProfilesRequest as GetProfilesRequest,
|
|
1160
|
+
index_GetTemplateFunctionsRequest as GetTemplateFunctionsRequest,
|
|
1161
|
+
index_GetTokensRequest as GetTokensRequest,
|
|
1162
|
+
index_GetTransactionsByAddressRequest as GetTransactionsByAddressRequest,
|
|
1163
|
+
index_GetTransactionsByWalletRequest as GetTransactionsByWalletRequest,
|
|
1164
|
+
index_IssueNewTokenRequest as IssueNewTokenRequest,
|
|
1165
|
+
index_LinkContractRequest as LinkContractRequest,
|
|
1166
|
+
index_LinkedTokenData as LinkedTokenData,
|
|
1167
|
+
index_LinkedTokenResponse as LinkedTokenResponse,
|
|
1168
|
+
index_MintTokenRequest as MintTokenRequest,
|
|
1169
|
+
index_PaginatedResponse as PaginatedResponse,
|
|
1170
|
+
index_ReadFunctionRequest as ReadFunctionRequest,
|
|
1171
|
+
index_SuccessResponse as SuccessResponse,
|
|
1172
|
+
index_WriteFunctionRequest as WriteFunctionRequest,
|
|
1173
|
+
index$7 as addresses,
|
|
1174
|
+
index$5 as assets,
|
|
1175
|
+
index$2 as contractInteractions,
|
|
1176
|
+
index$3 as contractTemplates,
|
|
1177
|
+
index$a as deployedContracts,
|
|
1178
|
+
index$9 as profiles,
|
|
1179
|
+
index$1 as tokenization,
|
|
1180
|
+
index$6 as transactions,
|
|
1181
|
+
index$8 as wallets,
|
|
1182
|
+
index$4 as withdrawals,
|
|
1183
|
+
};
|
|
1184
|
+
}
|
|
1185
|
+
|
|
1186
|
+
declare const OumlaSdkApiEnvironment: {
|
|
1187
|
+
readonly Production: "https://api.oumla.com";
|
|
441
1188
|
};
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
1189
|
+
type OumlaSdkApiEnvironment = typeof OumlaSdkApiEnvironment.Production;
|
|
1190
|
+
|
|
1191
|
+
declare namespace Profiles {
|
|
1192
|
+
interface Options {
|
|
1193
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
1194
|
+
/** Specify a custom URL to connect the client to. */
|
|
1195
|
+
baseUrl?: Supplier<string>;
|
|
1196
|
+
token?: Supplier<BearerToken | undefined>;
|
|
1197
|
+
/** Override the x-sdk-version header */
|
|
1198
|
+
sdkVersion?: "1.0.0";
|
|
1199
|
+
/** Override the x-api-key header */
|
|
1200
|
+
apiKey: Supplier<string>;
|
|
1201
|
+
/** Additional headers to include in requests. */
|
|
1202
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1203
|
+
}
|
|
1204
|
+
interface RequestOptions {
|
|
1205
|
+
/** The maximum time to wait for a response in seconds. */
|
|
1206
|
+
timeoutInSeconds?: number;
|
|
1207
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
1208
|
+
maxRetries?: number;
|
|
1209
|
+
/** A hook to abort the request. */
|
|
1210
|
+
abortSignal?: AbortSignal;
|
|
1211
|
+
/** Override the x-sdk-version header */
|
|
1212
|
+
sdkVersion?: "1.0.0";
|
|
1213
|
+
/** Override the x-api-key header */
|
|
1214
|
+
apiKey?: string;
|
|
1215
|
+
/** Additional query string parameters to include in the request. */
|
|
1216
|
+
queryParams?: Record<string, unknown>;
|
|
1217
|
+
/** Additional headers to include in the request. */
|
|
1218
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1219
|
+
}
|
|
1220
|
+
}
|
|
1221
|
+
/**
|
|
1222
|
+
* User profile management
|
|
1223
|
+
*/
|
|
1224
|
+
declare class Profiles {
|
|
1225
|
+
protected readonly _options: Profiles.Options;
|
|
1226
|
+
constructor(_options: Profiles.Options);
|
|
1227
|
+
/**
|
|
1228
|
+
* Retrieve a paginated list of profiles
|
|
1229
|
+
*
|
|
1230
|
+
* @param {OumlaSdkApi.GetProfilesRequest} request
|
|
1231
|
+
* @param {Profiles.RequestOptions} requestOptions - Request-specific configuration.
|
|
1232
|
+
*
|
|
1233
|
+
* @example
|
|
1234
|
+
* await client.profiles.getProfiles({
|
|
1235
|
+
* skip: 1,
|
|
1236
|
+
* take: 1
|
|
1237
|
+
* })
|
|
1238
|
+
*/
|
|
1239
|
+
getProfiles(request?: GetProfilesRequest, requestOptions?: Profiles.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1240
|
+
private __getProfiles;
|
|
1241
|
+
/**
|
|
1242
|
+
* Create a new user profile
|
|
1243
|
+
*
|
|
1244
|
+
* @param {OumlaSdkApi.CreateProfileRequest} request
|
|
1245
|
+
* @param {Profiles.RequestOptions} requestOptions - Request-specific configuration.
|
|
1246
|
+
*
|
|
1247
|
+
* @throws {@link OumlaSdkApi.BadRequestError}
|
|
1248
|
+
*
|
|
1249
|
+
* @example
|
|
1250
|
+
* await client.profiles.createProfile({
|
|
1251
|
+
* reference: "reference",
|
|
1252
|
+
* type: "User"
|
|
1253
|
+
* })
|
|
1254
|
+
*/
|
|
1255
|
+
createProfile(request: CreateProfileRequest, requestOptions?: Profiles.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1256
|
+
private __createProfile;
|
|
1257
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
1258
|
+
}
|
|
1259
|
+
|
|
1260
|
+
declare namespace Wallets {
|
|
1261
|
+
interface Options {
|
|
1262
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
1263
|
+
/** Specify a custom URL to connect the client to. */
|
|
1264
|
+
baseUrl?: Supplier<string>;
|
|
1265
|
+
token?: Supplier<BearerToken | undefined>;
|
|
1266
|
+
/** Override the x-sdk-version header */
|
|
1267
|
+
sdkVersion?: "1.0.0";
|
|
1268
|
+
/** Override the x-api-key header */
|
|
1269
|
+
apiKey: Supplier<string>;
|
|
1270
|
+
/** Additional headers to include in requests. */
|
|
1271
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1272
|
+
}
|
|
1273
|
+
interface RequestOptions {
|
|
1274
|
+
/** The maximum time to wait for a response in seconds. */
|
|
1275
|
+
timeoutInSeconds?: number;
|
|
1276
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
1277
|
+
maxRetries?: number;
|
|
1278
|
+
/** A hook to abort the request. */
|
|
1279
|
+
abortSignal?: AbortSignal;
|
|
1280
|
+
/** Override the x-sdk-version header */
|
|
1281
|
+
sdkVersion?: "1.0.0";
|
|
1282
|
+
/** Override the x-api-key header */
|
|
1283
|
+
apiKey?: string;
|
|
1284
|
+
/** Additional query string parameters to include in the request. */
|
|
1285
|
+
queryParams?: Record<string, unknown>;
|
|
1286
|
+
/** Additional headers to include in the request. */
|
|
1287
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1288
|
+
}
|
|
1289
|
+
}
|
|
1290
|
+
/**
|
|
1291
|
+
* Wallet creation and management
|
|
1292
|
+
*/
|
|
1293
|
+
declare class Wallets {
|
|
1294
|
+
protected readonly _options: Wallets.Options;
|
|
1295
|
+
constructor(_options: Wallets.Options);
|
|
1296
|
+
/**
|
|
1297
|
+
* Retrieve wallets for the organization
|
|
1298
|
+
*
|
|
1299
|
+
* @param {OumlaSdkApi.GetOrganizationWalletsRequest} request
|
|
1300
|
+
* @param {Wallets.RequestOptions} requestOptions - Request-specific configuration.
|
|
1301
|
+
*
|
|
1302
|
+
* @example
|
|
1303
|
+
* await client.wallets.getOrganizationWallets({
|
|
1304
|
+
* skip: 1,
|
|
1305
|
+
* take: 1
|
|
1306
|
+
* })
|
|
1307
|
+
*/
|
|
1308
|
+
getOrganizationWallets(request?: GetOrganizationWalletsRequest, requestOptions?: Wallets.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1309
|
+
private __getOrganizationWallets;
|
|
1310
|
+
/**
|
|
1311
|
+
* Retrieve wallets for a specific profile
|
|
1312
|
+
*
|
|
1313
|
+
* @param {string} reference - Profile reference
|
|
1314
|
+
* @param {OumlaSdkApi.GetProfileWalletsRequest} request
|
|
1315
|
+
* @param {Wallets.RequestOptions} requestOptions - Request-specific configuration.
|
|
1316
|
+
*
|
|
1317
|
+
* @example
|
|
1318
|
+
* await client.wallets.getProfileWallets("reference", {
|
|
1319
|
+
* skip: 1,
|
|
1320
|
+
* take: 1
|
|
1321
|
+
* })
|
|
1322
|
+
*/
|
|
1323
|
+
getProfileWallets(reference: string, request?: GetProfileWalletsRequest, requestOptions?: Wallets.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1324
|
+
private __getProfileWallets;
|
|
1325
|
+
/**
|
|
1326
|
+
* Generate a new wallet for a profile
|
|
1327
|
+
*
|
|
1328
|
+
* @param {OumlaSdkApi.CreateWalletRequest} request
|
|
1329
|
+
* @param {Wallets.RequestOptions} requestOptions - Request-specific configuration.
|
|
1330
|
+
*
|
|
1331
|
+
* @example
|
|
1332
|
+
* await client.wallets.generateWallet({
|
|
1333
|
+
* reference: "reference",
|
|
1334
|
+
* network: "BTC"
|
|
1335
|
+
* })
|
|
1336
|
+
*/
|
|
1337
|
+
generateWallet(request: CreateWalletRequest, requestOptions?: Wallets.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1338
|
+
private __generateWallet;
|
|
1339
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
1340
|
+
}
|
|
1341
|
+
|
|
1342
|
+
declare namespace Addresses {
|
|
1343
|
+
interface Options {
|
|
1344
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
1345
|
+
/** Specify a custom URL to connect the client to. */
|
|
1346
|
+
baseUrl?: Supplier<string>;
|
|
1347
|
+
token?: Supplier<BearerToken | undefined>;
|
|
1348
|
+
/** Override the x-sdk-version header */
|
|
1349
|
+
sdkVersion?: "1.0.0";
|
|
1350
|
+
/** Override the x-api-key header */
|
|
1351
|
+
apiKey: Supplier<string>;
|
|
1352
|
+
/** Additional headers to include in requests. */
|
|
1353
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1354
|
+
}
|
|
1355
|
+
interface RequestOptions {
|
|
1356
|
+
/** The maximum time to wait for a response in seconds. */
|
|
1357
|
+
timeoutInSeconds?: number;
|
|
1358
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
1359
|
+
maxRetries?: number;
|
|
1360
|
+
/** A hook to abort the request. */
|
|
1361
|
+
abortSignal?: AbortSignal;
|
|
1362
|
+
/** Override the x-sdk-version header */
|
|
1363
|
+
sdkVersion?: "1.0.0";
|
|
1364
|
+
/** Override the x-api-key header */
|
|
1365
|
+
apiKey?: string;
|
|
1366
|
+
/** Additional query string parameters to include in the request. */
|
|
1367
|
+
queryParams?: Record<string, unknown>;
|
|
1368
|
+
/** Additional headers to include in the request. */
|
|
1369
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1370
|
+
}
|
|
1371
|
+
}
|
|
1372
|
+
/**
|
|
1373
|
+
* Address generation and management
|
|
1374
|
+
*/
|
|
1375
|
+
declare class Addresses {
|
|
1376
|
+
protected readonly _options: Addresses.Options;
|
|
1377
|
+
constructor(_options: Addresses.Options);
|
|
1378
|
+
/**
|
|
1379
|
+
* Retrieve addresses for the organization
|
|
1380
|
+
*
|
|
1381
|
+
* @param {OumlaSdkApi.GetOrganizationAddressesRequest} request
|
|
1382
|
+
* @param {Addresses.RequestOptions} requestOptions - Request-specific configuration.
|
|
1383
|
+
*
|
|
1384
|
+
* @example
|
|
1385
|
+
* await client.addresses.getOrganizationAddresses({
|
|
1386
|
+
* skip: 1,
|
|
1387
|
+
* take: 1
|
|
1388
|
+
* })
|
|
1389
|
+
*/
|
|
1390
|
+
getOrganizationAddresses(request?: GetOrganizationAddressesRequest, requestOptions?: Addresses.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1391
|
+
private __getOrganizationAddresses;
|
|
1392
|
+
/**
|
|
1393
|
+
* Retrieve addresses for a specific profile
|
|
1394
|
+
*
|
|
1395
|
+
* @param {string} reference - Profile reference
|
|
1396
|
+
* @param {OumlaSdkApi.GetProfileAddressesRequest} request
|
|
1397
|
+
* @param {Addresses.RequestOptions} requestOptions - Request-specific configuration.
|
|
1398
|
+
*
|
|
1399
|
+
* @example
|
|
1400
|
+
* await client.addresses.getProfileAddresses("reference", {
|
|
1401
|
+
* skip: 1,
|
|
1402
|
+
* take: 1
|
|
1403
|
+
* })
|
|
1404
|
+
*/
|
|
1405
|
+
getProfileAddresses(reference: string, request?: GetProfileAddressesRequest, requestOptions?: Addresses.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1406
|
+
private __getProfileAddresses;
|
|
1407
|
+
/**
|
|
1408
|
+
* Generate a new address for a profile
|
|
1409
|
+
*
|
|
1410
|
+
* @param {OumlaSdkApi.CreateAddressRequest} request
|
|
1411
|
+
* @param {Addresses.RequestOptions} requestOptions - Request-specific configuration.
|
|
1412
|
+
*
|
|
1413
|
+
* @example
|
|
1414
|
+
* await client.addresses.generateAddress({
|
|
1415
|
+
* reference: "reference",
|
|
1416
|
+
* network: "BTC",
|
|
1417
|
+
* clientShare: "clientShare"
|
|
1418
|
+
* })
|
|
1419
|
+
*/
|
|
1420
|
+
generateAddress(request: CreateAddressRequest, requestOptions?: Addresses.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1421
|
+
private __generateAddress;
|
|
1422
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
1423
|
+
}
|
|
1424
|
+
|
|
1425
|
+
declare namespace Transactions {
|
|
1426
|
+
interface Options {
|
|
1427
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
1428
|
+
/** Specify a custom URL to connect the client to. */
|
|
1429
|
+
baseUrl?: Supplier<string>;
|
|
1430
|
+
token?: Supplier<BearerToken | undefined>;
|
|
1431
|
+
/** Override the x-sdk-version header */
|
|
1432
|
+
sdkVersion?: "1.0.0";
|
|
1433
|
+
/** Override the x-api-key header */
|
|
1434
|
+
apiKey: Supplier<string>;
|
|
1435
|
+
/** Additional headers to include in requests. */
|
|
1436
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1437
|
+
}
|
|
1438
|
+
interface RequestOptions {
|
|
1439
|
+
/** The maximum time to wait for a response in seconds. */
|
|
1440
|
+
timeoutInSeconds?: number;
|
|
1441
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
1442
|
+
maxRetries?: number;
|
|
1443
|
+
/** A hook to abort the request. */
|
|
1444
|
+
abortSignal?: AbortSignal;
|
|
1445
|
+
/** Override the x-sdk-version header */
|
|
1446
|
+
sdkVersion?: "1.0.0";
|
|
1447
|
+
/** Override the x-api-key header */
|
|
1448
|
+
apiKey?: string;
|
|
1449
|
+
/** Additional query string parameters to include in the request. */
|
|
1450
|
+
queryParams?: Record<string, unknown>;
|
|
1451
|
+
/** Additional headers to include in the request. */
|
|
1452
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1453
|
+
}
|
|
1454
|
+
}
|
|
1455
|
+
/**
|
|
1456
|
+
* Transaction history and tracking
|
|
1457
|
+
*/
|
|
1458
|
+
declare class Transactions {
|
|
1459
|
+
protected readonly _options: Transactions.Options;
|
|
1460
|
+
constructor(_options: Transactions.Options);
|
|
1461
|
+
/**
|
|
1462
|
+
* Retrieve transactions for a specific address
|
|
1463
|
+
*
|
|
1464
|
+
* @param {string} address - Blockchain address
|
|
1465
|
+
* @param {OumlaSdkApi.GetTransactionsByAddressRequest} request
|
|
1466
|
+
* @param {Transactions.RequestOptions} requestOptions - Request-specific configuration.
|
|
1467
|
+
*
|
|
1468
|
+
* @example
|
|
1469
|
+
* await client.transactions.getTransactionsByAddress("address", {
|
|
1470
|
+
* skip: 1,
|
|
1471
|
+
* take: 1
|
|
1472
|
+
* })
|
|
1473
|
+
*/
|
|
1474
|
+
getTransactionsByAddress(address: string, request?: GetTransactionsByAddressRequest, requestOptions?: Transactions.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1475
|
+
private __getTransactionsByAddress;
|
|
1476
|
+
/**
|
|
1477
|
+
* Retrieve transactions for a specific wallet
|
|
1478
|
+
*
|
|
1479
|
+
* @param {string} miniWalletId - Mini wallet ID
|
|
1480
|
+
* @param {OumlaSdkApi.GetTransactionsByWalletRequest} request
|
|
1481
|
+
* @param {Transactions.RequestOptions} requestOptions - Request-specific configuration.
|
|
1482
|
+
*
|
|
1483
|
+
* @example
|
|
1484
|
+
* await client.transactions.getTransactionsByWallet("miniWalletId", {
|
|
1485
|
+
* skip: 1,
|
|
1486
|
+
* take: 1
|
|
1487
|
+
* })
|
|
1488
|
+
*/
|
|
1489
|
+
getTransactionsByWallet(miniWalletId: string, request?: GetTransactionsByWalletRequest, requestOptions?: Transactions.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1490
|
+
private __getTransactionsByWallet;
|
|
1491
|
+
/**
|
|
1492
|
+
* Retrieve transactions for the organization
|
|
1493
|
+
*
|
|
1494
|
+
* @param {OumlaSdkApi.GetOrganizationTransactionsRequest} request
|
|
1495
|
+
* @param {Transactions.RequestOptions} requestOptions - Request-specific configuration.
|
|
1496
|
+
*
|
|
1497
|
+
* @example
|
|
1498
|
+
* await client.transactions.getOrganizationTransactions({
|
|
1499
|
+
* skip: 1,
|
|
1500
|
+
* take: 1
|
|
1501
|
+
* })
|
|
1502
|
+
*/
|
|
1503
|
+
getOrganizationTransactions(request?: GetOrganizationTransactionsRequest, requestOptions?: Transactions.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1504
|
+
private __getOrganizationTransactions;
|
|
1505
|
+
/**
|
|
1506
|
+
* Retrieve transactions for a specific profile
|
|
1507
|
+
*
|
|
1508
|
+
* @param {string} reference - Profile reference
|
|
1509
|
+
* @param {OumlaSdkApi.GetProfileTransactionsRequest} request
|
|
1510
|
+
* @param {Transactions.RequestOptions} requestOptions - Request-specific configuration.
|
|
1511
|
+
*
|
|
1512
|
+
* @example
|
|
1513
|
+
* await client.transactions.getProfileTransactions("reference", {
|
|
1514
|
+
* skip: 1,
|
|
1515
|
+
* take: 1
|
|
1516
|
+
* })
|
|
1517
|
+
*/
|
|
1518
|
+
getProfileTransactions(reference: string, request?: GetProfileTransactionsRequest, requestOptions?: Transactions.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1519
|
+
private __getProfileTransactions;
|
|
1520
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
1521
|
+
}
|
|
1522
|
+
|
|
1523
|
+
declare namespace Assets {
|
|
1524
|
+
interface Options {
|
|
1525
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
1526
|
+
/** Specify a custom URL to connect the client to. */
|
|
1527
|
+
baseUrl?: Supplier<string>;
|
|
1528
|
+
token?: Supplier<BearerToken | undefined>;
|
|
1529
|
+
/** Override the x-sdk-version header */
|
|
1530
|
+
sdkVersion?: "1.0.0";
|
|
1531
|
+
/** Override the x-api-key header */
|
|
1532
|
+
apiKey: Supplier<string>;
|
|
1533
|
+
/** Additional headers to include in requests. */
|
|
1534
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1535
|
+
}
|
|
1536
|
+
interface RequestOptions {
|
|
1537
|
+
/** The maximum time to wait for a response in seconds. */
|
|
1538
|
+
timeoutInSeconds?: number;
|
|
1539
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
1540
|
+
maxRetries?: number;
|
|
1541
|
+
/** A hook to abort the request. */
|
|
1542
|
+
abortSignal?: AbortSignal;
|
|
1543
|
+
/** Override the x-sdk-version header */
|
|
1544
|
+
sdkVersion?: "1.0.0";
|
|
1545
|
+
/** Override the x-api-key header */
|
|
1546
|
+
apiKey?: string;
|
|
1547
|
+
/** Additional query string parameters to include in the request. */
|
|
1548
|
+
queryParams?: Record<string, unknown>;
|
|
1549
|
+
/** Additional headers to include in the request. */
|
|
1550
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1551
|
+
}
|
|
1552
|
+
}
|
|
1553
|
+
/**
|
|
1554
|
+
* Asset management and tracking
|
|
1555
|
+
*/
|
|
1556
|
+
declare class Assets {
|
|
1557
|
+
protected readonly _options: Assets.Options;
|
|
1558
|
+
constructor(_options: Assets.Options);
|
|
1559
|
+
/**
|
|
1560
|
+
* Retrieve assets for a specific address
|
|
1561
|
+
*
|
|
1562
|
+
* @param {string} address - Blockchain address
|
|
1563
|
+
* @param {OumlaSdkApi.GetAssetsByAddressRequest} request
|
|
1564
|
+
* @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
|
|
1565
|
+
*
|
|
1566
|
+
* @example
|
|
1567
|
+
* await client.assets.getAssetsByAddress("address", {
|
|
1568
|
+
* skip: 1,
|
|
1569
|
+
* take: 1
|
|
1570
|
+
* })
|
|
1571
|
+
*/
|
|
1572
|
+
getAssetsByAddress(address: string, request?: GetAssetsByAddressRequest, requestOptions?: Assets.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1573
|
+
private __getAssetsByAddress;
|
|
1574
|
+
/**
|
|
1575
|
+
* Retrieve assets for a specific wallet
|
|
1576
|
+
*
|
|
1577
|
+
* @param {string} miniWalletId - Mini wallet ID
|
|
1578
|
+
* @param {OumlaSdkApi.GetAssetsByWalletRequest} request
|
|
1579
|
+
* @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
|
|
1580
|
+
*
|
|
1581
|
+
* @example
|
|
1582
|
+
* await client.assets.getAssetsByWallet("miniWalletId", {
|
|
1583
|
+
* skip: 1,
|
|
1584
|
+
* take: 1
|
|
1585
|
+
* })
|
|
1586
|
+
*/
|
|
1587
|
+
getAssetsByWallet(miniWalletId: string, request?: GetAssetsByWalletRequest, requestOptions?: Assets.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1588
|
+
private __getAssetsByWallet;
|
|
1589
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
1590
|
+
}
|
|
1591
|
+
|
|
1592
|
+
declare namespace Withdrawals {
|
|
1593
|
+
interface Options {
|
|
1594
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
1595
|
+
/** Specify a custom URL to connect the client to. */
|
|
1596
|
+
baseUrl?: Supplier<string>;
|
|
1597
|
+
token?: Supplier<BearerToken | undefined>;
|
|
1598
|
+
/** Override the x-sdk-version header */
|
|
1599
|
+
sdkVersion?: "1.0.0";
|
|
1600
|
+
/** Override the x-api-key header */
|
|
1601
|
+
apiKey: Supplier<string>;
|
|
1602
|
+
/** Additional headers to include in requests. */
|
|
1603
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1604
|
+
}
|
|
1605
|
+
interface RequestOptions {
|
|
1606
|
+
/** The maximum time to wait for a response in seconds. */
|
|
1607
|
+
timeoutInSeconds?: number;
|
|
1608
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
1609
|
+
maxRetries?: number;
|
|
1610
|
+
/** A hook to abort the request. */
|
|
1611
|
+
abortSignal?: AbortSignal;
|
|
1612
|
+
/** Override the x-sdk-version header */
|
|
1613
|
+
sdkVersion?: "1.0.0";
|
|
1614
|
+
/** Override the x-api-key header */
|
|
1615
|
+
apiKey?: string;
|
|
1616
|
+
/** Additional query string parameters to include in the request. */
|
|
1617
|
+
queryParams?: Record<string, unknown>;
|
|
1618
|
+
/** Additional headers to include in the request. */
|
|
1619
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1620
|
+
}
|
|
1621
|
+
}
|
|
1622
|
+
/**
|
|
1623
|
+
* Withdrawal operations
|
|
1624
|
+
*/
|
|
1625
|
+
declare class Withdrawals {
|
|
1626
|
+
protected readonly _options: Withdrawals.Options;
|
|
1627
|
+
constructor(_options: Withdrawals.Options);
|
|
1628
|
+
/**
|
|
1629
|
+
* Create a new withdrawal request
|
|
1630
|
+
*
|
|
1631
|
+
* @param {OumlaSdkApi.CreateWithdrawalRequest} request
|
|
1632
|
+
* @param {Withdrawals.RequestOptions} requestOptions - Request-specific configuration.
|
|
1633
|
+
*
|
|
1634
|
+
* @example
|
|
1635
|
+
* await client.withdrawals.createWithdrawal({
|
|
1636
|
+
* to: "to",
|
|
1637
|
+
* amount: "amount",
|
|
1638
|
+
* from: ["from"],
|
|
1639
|
+
* network: "BTC",
|
|
1640
|
+
* clientShare: "clientShare"
|
|
1641
|
+
* })
|
|
1642
|
+
*/
|
|
1643
|
+
createWithdrawal(request: CreateWithdrawalRequest, requestOptions?: Withdrawals.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1644
|
+
private __createWithdrawal;
|
|
1645
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
1646
|
+
}
|
|
1647
|
+
|
|
1648
|
+
declare namespace ContractTemplates {
|
|
1649
|
+
interface Options {
|
|
1650
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
1651
|
+
/** Specify a custom URL to connect the client to. */
|
|
1652
|
+
baseUrl?: Supplier<string>;
|
|
1653
|
+
token?: Supplier<BearerToken | undefined>;
|
|
1654
|
+
/** Override the x-sdk-version header */
|
|
1655
|
+
sdkVersion?: "1.0.0";
|
|
1656
|
+
/** Override the x-api-key header */
|
|
1657
|
+
apiKey: Supplier<string>;
|
|
1658
|
+
/** Additional headers to include in requests. */
|
|
1659
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1660
|
+
}
|
|
1661
|
+
interface RequestOptions {
|
|
1662
|
+
/** The maximum time to wait for a response in seconds. */
|
|
1663
|
+
timeoutInSeconds?: number;
|
|
1664
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
1665
|
+
maxRetries?: number;
|
|
1666
|
+
/** A hook to abort the request. */
|
|
1667
|
+
abortSignal?: AbortSignal;
|
|
1668
|
+
/** Override the x-sdk-version header */
|
|
1669
|
+
sdkVersion?: "1.0.0";
|
|
1670
|
+
/** Override the x-api-key header */
|
|
1671
|
+
apiKey?: string;
|
|
1672
|
+
/** Additional query string parameters to include in the request. */
|
|
1673
|
+
queryParams?: Record<string, unknown>;
|
|
1674
|
+
/** Additional headers to include in the request. */
|
|
1675
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1676
|
+
}
|
|
1677
|
+
}
|
|
1678
|
+
/**
|
|
1679
|
+
* Smart contract template management
|
|
1680
|
+
*/
|
|
1681
|
+
declare class ContractTemplates {
|
|
1682
|
+
protected readonly _options: ContractTemplates.Options;
|
|
1683
|
+
constructor(_options: ContractTemplates.Options);
|
|
1684
|
+
/**
|
|
1685
|
+
* Retrieve a paginated list of contract templates
|
|
1686
|
+
*
|
|
1687
|
+
* @param {OumlaSdkApi.GetContractTemplatesRequest} request
|
|
1688
|
+
* @param {ContractTemplates.RequestOptions} requestOptions - Request-specific configuration.
|
|
1689
|
+
*
|
|
1690
|
+
* @example
|
|
1691
|
+
* await client.contractTemplates.getContractTemplates({
|
|
1692
|
+
* skip: 1,
|
|
1693
|
+
* take: 1
|
|
1694
|
+
* })
|
|
1695
|
+
*/
|
|
1696
|
+
getContractTemplates(request?: GetContractTemplatesRequest, requestOptions?: ContractTemplates.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1697
|
+
private __getContractTemplates;
|
|
1698
|
+
/**
|
|
1699
|
+
* Create a new contract template
|
|
1700
|
+
*
|
|
1701
|
+
* @param {OumlaSdkApi.CreateContractTemplateRequest} request
|
|
1702
|
+
* @param {ContractTemplates.RequestOptions} requestOptions - Request-specific configuration.
|
|
1703
|
+
*
|
|
1704
|
+
* @example
|
|
1705
|
+
* await client.contractTemplates.createContractTemplate({
|
|
1706
|
+
* name: "name",
|
|
1707
|
+
* description: "description",
|
|
1708
|
+
* abi: [{
|
|
1709
|
+
* "key": "value"
|
|
1710
|
+
* }],
|
|
1711
|
+
* bytecode: "bytecode"
|
|
1712
|
+
* })
|
|
1713
|
+
*/
|
|
1714
|
+
createContractTemplate(request: CreateContractTemplateRequest, requestOptions?: ContractTemplates.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1715
|
+
private __createContractTemplate;
|
|
1716
|
+
/**
|
|
1717
|
+
* Retrieve a specific contract template
|
|
1718
|
+
*
|
|
1719
|
+
* @param {string} templateId - Contract template ID
|
|
1720
|
+
* @param {ContractTemplates.RequestOptions} requestOptions - Request-specific configuration.
|
|
1721
|
+
*
|
|
1722
|
+
* @example
|
|
1723
|
+
* await client.contractTemplates.getContractTemplate("templateId")
|
|
1724
|
+
*/
|
|
1725
|
+
getContractTemplate(templateId: string, requestOptions?: ContractTemplates.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1726
|
+
private __getContractTemplate;
|
|
1727
|
+
/**
|
|
1728
|
+
* Delete a contract template
|
|
1729
|
+
*
|
|
1730
|
+
* @param {string} templateId - Contract template ID
|
|
1731
|
+
* @param {ContractTemplates.RequestOptions} requestOptions - Request-specific configuration.
|
|
1732
|
+
*
|
|
1733
|
+
* @example
|
|
1734
|
+
* await client.contractTemplates.deleteContractTemplate("templateId")
|
|
1735
|
+
*/
|
|
1736
|
+
deleteContractTemplate(templateId: string, requestOptions?: ContractTemplates.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1737
|
+
private __deleteContractTemplate;
|
|
1738
|
+
/**
|
|
1739
|
+
* Retrieve constructor information for a contract template
|
|
1740
|
+
*
|
|
1741
|
+
* @param {string} templateId - Contract template ID
|
|
1742
|
+
* @param {ContractTemplates.RequestOptions} requestOptions - Request-specific configuration.
|
|
1743
|
+
*
|
|
1744
|
+
* @example
|
|
1745
|
+
* await client.contractTemplates.getContractConstructor("templateId")
|
|
1746
|
+
*/
|
|
1747
|
+
getContractConstructor(templateId: string, requestOptions?: ContractTemplates.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1748
|
+
private __getContractConstructor;
|
|
1749
|
+
/**
|
|
1750
|
+
* Retrieve function information for a contract template
|
|
1751
|
+
*
|
|
1752
|
+
* @param {string} templateId - Contract template ID
|
|
1753
|
+
* @param {OumlaSdkApi.GetTemplateFunctionsRequest} request
|
|
1754
|
+
* @param {ContractTemplates.RequestOptions} requestOptions - Request-specific configuration.
|
|
1755
|
+
*
|
|
1756
|
+
* @example
|
|
1757
|
+
* await client.contractTemplates.getTemplateFunctions("templateId", {
|
|
1758
|
+
* functionSignature: "functionSignature"
|
|
1759
|
+
* })
|
|
1760
|
+
*/
|
|
1761
|
+
getTemplateFunctions(templateId: string, request?: GetTemplateFunctionsRequest, requestOptions?: ContractTemplates.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1762
|
+
private __getTemplateFunctions;
|
|
1763
|
+
/**
|
|
1764
|
+
* Deploy a contract from a template
|
|
1765
|
+
*
|
|
1766
|
+
* @param {string} templateId - Contract template ID
|
|
1767
|
+
* @param {OumlaSdkApi.DeployContractRequest} request
|
|
1768
|
+
* @param {ContractTemplates.RequestOptions} requestOptions - Request-specific configuration.
|
|
1769
|
+
*
|
|
1770
|
+
* @example
|
|
1771
|
+
* await client.contractTemplates.deployContract("templateId", {
|
|
1772
|
+
* network: "network",
|
|
1773
|
+
* addressId: "addressId",
|
|
1774
|
+
* clientShare: "clientShare"
|
|
1775
|
+
* })
|
|
1776
|
+
*/
|
|
1777
|
+
deployContract(templateId: string, request: DeployContractRequest, requestOptions?: ContractTemplates.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1778
|
+
private __deployContract;
|
|
1779
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
1780
|
+
}
|
|
1781
|
+
|
|
1782
|
+
declare namespace DeployedContracts {
|
|
1783
|
+
interface Options {
|
|
1784
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
1785
|
+
/** Specify a custom URL to connect the client to. */
|
|
1786
|
+
baseUrl?: Supplier<string>;
|
|
1787
|
+
token?: Supplier<BearerToken | undefined>;
|
|
1788
|
+
/** Override the x-sdk-version header */
|
|
1789
|
+
sdkVersion?: "1.0.0";
|
|
1790
|
+
/** Override the x-api-key header */
|
|
1791
|
+
apiKey: Supplier<string>;
|
|
1792
|
+
/** Additional headers to include in requests. */
|
|
1793
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1794
|
+
}
|
|
1795
|
+
interface RequestOptions {
|
|
1796
|
+
/** The maximum time to wait for a response in seconds. */
|
|
1797
|
+
timeoutInSeconds?: number;
|
|
1798
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
1799
|
+
maxRetries?: number;
|
|
1800
|
+
/** A hook to abort the request. */
|
|
1801
|
+
abortSignal?: AbortSignal;
|
|
1802
|
+
/** Override the x-sdk-version header */
|
|
1803
|
+
sdkVersion?: "1.0.0";
|
|
1804
|
+
/** Override the x-api-key header */
|
|
1805
|
+
apiKey?: string;
|
|
1806
|
+
/** Additional query string parameters to include in the request. */
|
|
1807
|
+
queryParams?: Record<string, unknown>;
|
|
1808
|
+
/** Additional headers to include in the request. */
|
|
1809
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1810
|
+
}
|
|
1811
|
+
}
|
|
1812
|
+
/**
|
|
1813
|
+
* Deployed contract management
|
|
1814
|
+
*/
|
|
1815
|
+
declare class DeployedContracts {
|
|
1816
|
+
protected readonly _options: DeployedContracts.Options;
|
|
1817
|
+
constructor(_options: DeployedContracts.Options);
|
|
1818
|
+
/**
|
|
1819
|
+
* Retrieve a paginated list of deployed contracts
|
|
1820
|
+
*
|
|
1821
|
+
* @param {OumlaSdkApi.GetDeployedContractsRequest} request
|
|
1822
|
+
* @param {DeployedContracts.RequestOptions} requestOptions - Request-specific configuration.
|
|
1823
|
+
*
|
|
1824
|
+
* @example
|
|
1825
|
+
* await client.deployedContracts.getDeployedContracts({
|
|
1826
|
+
* skip: 1,
|
|
1827
|
+
* take: 1,
|
|
1828
|
+
* contractAddress: "contractAddress",
|
|
1829
|
+
* network: "BTC",
|
|
1830
|
+
* contractTemplateId: "contractTemplateId"
|
|
1831
|
+
* })
|
|
1832
|
+
*/
|
|
1833
|
+
getDeployedContracts(request?: GetDeployedContractsRequest, requestOptions?: DeployedContracts.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
1834
|
+
private __getDeployedContracts;
|
|
1835
|
+
/**
|
|
1836
|
+
* Retrieve a specific deployed contract
|
|
1837
|
+
*
|
|
1838
|
+
* @param {string} contractId - Deployed contract ID
|
|
1839
|
+
* @param {DeployedContracts.RequestOptions} requestOptions - Request-specific configuration.
|
|
1840
|
+
*
|
|
1841
|
+
* @example
|
|
1842
|
+
* await client.deployedContracts.getDeployedContract("contractId")
|
|
1843
|
+
*/
|
|
1844
|
+
getDeployedContract(contractId: string, requestOptions?: DeployedContracts.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1845
|
+
private __getDeployedContract;
|
|
1846
|
+
/**
|
|
1847
|
+
* Retrieve a deployed contract by network and address
|
|
1848
|
+
*
|
|
1849
|
+
* @param {string} network - Blockchain network
|
|
1850
|
+
* @param {string} contractAddress - Contract address
|
|
1851
|
+
* @param {DeployedContracts.RequestOptions} requestOptions - Request-specific configuration.
|
|
1852
|
+
*
|
|
1853
|
+
* @example
|
|
1854
|
+
* await client.deployedContracts.getDeployedContractByAddress("network", "contractAddress")
|
|
1855
|
+
*/
|
|
1856
|
+
getDeployedContractByAddress(network: string, contractAddress: string, requestOptions?: DeployedContracts.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1857
|
+
private __getDeployedContractByAddress;
|
|
1858
|
+
/**
|
|
1859
|
+
* Fetch ABI for a deployed contract
|
|
1860
|
+
*
|
|
1861
|
+
* @param {OumlaSdkApi.FetchContractAbiRequest} request
|
|
1862
|
+
* @param {DeployedContracts.RequestOptions} requestOptions - Request-specific configuration.
|
|
1863
|
+
*
|
|
1864
|
+
* @example
|
|
1865
|
+
* await client.deployedContracts.fetchContractAbi({
|
|
1866
|
+
* network: "network",
|
|
1867
|
+
* contractAddress: "contractAddress"
|
|
1868
|
+
* })
|
|
1869
|
+
*/
|
|
1870
|
+
fetchContractAbi(request: FetchContractAbiRequest, requestOptions?: DeployedContracts.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1871
|
+
private __fetchContractAbi;
|
|
1872
|
+
/**
|
|
1873
|
+
* Add ABI for a deployed contract
|
|
1874
|
+
*
|
|
1875
|
+
* @param {OumlaSdkApi.AddContractAbiRequest} request
|
|
1876
|
+
* @param {DeployedContracts.RequestOptions} requestOptions - Request-specific configuration.
|
|
1877
|
+
*
|
|
1878
|
+
* @example
|
|
1879
|
+
* await client.deployedContracts.addContractAbi({
|
|
1880
|
+
* network: "network",
|
|
1881
|
+
* contractAddress: "contractAddress",
|
|
1882
|
+
* name: "name",
|
|
1883
|
+
* abi: [{
|
|
1884
|
+
* "key": "value"
|
|
1885
|
+
* }]
|
|
1886
|
+
* })
|
|
1887
|
+
*/
|
|
1888
|
+
addContractAbi(request: AddContractAbiRequest, requestOptions?: DeployedContracts.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1889
|
+
private __addContractAbi;
|
|
1890
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
1891
|
+
}
|
|
1892
|
+
|
|
1893
|
+
declare namespace ContractInteractions {
|
|
1894
|
+
interface Options {
|
|
1895
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
1896
|
+
/** Specify a custom URL to connect the client to. */
|
|
1897
|
+
baseUrl?: Supplier<string>;
|
|
1898
|
+
token?: Supplier<BearerToken | undefined>;
|
|
1899
|
+
/** Override the x-sdk-version header */
|
|
1900
|
+
sdkVersion?: "1.0.0";
|
|
1901
|
+
/** Override the x-api-key header */
|
|
1902
|
+
apiKey: Supplier<string>;
|
|
1903
|
+
/** Additional headers to include in requests. */
|
|
1904
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1905
|
+
}
|
|
1906
|
+
interface RequestOptions {
|
|
1907
|
+
/** The maximum time to wait for a response in seconds. */
|
|
1908
|
+
timeoutInSeconds?: number;
|
|
1909
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
1910
|
+
maxRetries?: number;
|
|
1911
|
+
/** A hook to abort the request. */
|
|
1912
|
+
abortSignal?: AbortSignal;
|
|
1913
|
+
/** Override the x-sdk-version header */
|
|
1914
|
+
sdkVersion?: "1.0.0";
|
|
1915
|
+
/** Override the x-api-key header */
|
|
1916
|
+
apiKey?: string;
|
|
1917
|
+
/** Additional query string parameters to include in the request. */
|
|
1918
|
+
queryParams?: Record<string, unknown>;
|
|
1919
|
+
/** Additional headers to include in the request. */
|
|
1920
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
1921
|
+
}
|
|
1922
|
+
}
|
|
1923
|
+
/**
|
|
1924
|
+
* Smart contract interaction operations
|
|
1925
|
+
*/
|
|
1926
|
+
declare class ContractInteractions {
|
|
1927
|
+
protected readonly _options: ContractInteractions.Options;
|
|
1928
|
+
constructor(_options: ContractInteractions.Options);
|
|
1929
|
+
/**
|
|
1930
|
+
* Retrieve available functions for a deployed contract
|
|
1931
|
+
*
|
|
1932
|
+
* @param {string} network - Blockchain network
|
|
1933
|
+
* @param {string} contractAddress - Contract address
|
|
1934
|
+
* @param {ContractInteractions.RequestOptions} requestOptions - Request-specific configuration.
|
|
1935
|
+
*
|
|
1936
|
+
* @example
|
|
1937
|
+
* await client.contractInteractions.getContractFunctions("network", "contractAddress")
|
|
1938
|
+
*/
|
|
1939
|
+
getContractFunctions(network: string, contractAddress: string, requestOptions?: ContractInteractions.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1940
|
+
private __getContractFunctions;
|
|
1941
|
+
/**
|
|
1942
|
+
* Call a read function on a deployed contract
|
|
1943
|
+
*
|
|
1944
|
+
* @param {string} network - Blockchain network
|
|
1945
|
+
* @param {string} contractAddress - Contract address
|
|
1946
|
+
* @param {OumlaSdkApi.ReadFunctionRequest} request
|
|
1947
|
+
* @param {ContractInteractions.RequestOptions} requestOptions - Request-specific configuration.
|
|
1948
|
+
*
|
|
1949
|
+
* @example
|
|
1950
|
+
* await client.contractInteractions.callReadFunction("network", "contractAddress", {
|
|
1951
|
+
* abiFunction: {
|
|
1952
|
+
* name: "name",
|
|
1953
|
+
* inputs: [{}],
|
|
1954
|
+
* outputs: [{}],
|
|
1955
|
+
* type: "type"
|
|
1956
|
+
* }
|
|
1957
|
+
* })
|
|
1958
|
+
*/
|
|
1959
|
+
callReadFunction(network: string, contractAddress: string, request: ReadFunctionRequest, requestOptions?: ContractInteractions.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1960
|
+
private __callReadFunction;
|
|
1961
|
+
/**
|
|
1962
|
+
* Call a write function on a deployed contract
|
|
1963
|
+
*
|
|
1964
|
+
* @param {string} network - Blockchain network
|
|
1965
|
+
* @param {string} contractAddress - Contract address
|
|
1966
|
+
* @param {OumlaSdkApi.WriteFunctionRequest} request
|
|
1967
|
+
* @param {ContractInteractions.RequestOptions} requestOptions - Request-specific configuration.
|
|
1968
|
+
*
|
|
1969
|
+
* @example
|
|
1970
|
+
* await client.contractInteractions.callWriteFunction("network", "contractAddress", {
|
|
1971
|
+
* addressId: "addressId",
|
|
1972
|
+
* clientShare: "clientShare",
|
|
1973
|
+
* abiFunction: {
|
|
1974
|
+
* name: "name",
|
|
1975
|
+
* inputs: [{}],
|
|
1976
|
+
* outputs: [{}],
|
|
1977
|
+
* type: "type"
|
|
1978
|
+
* }
|
|
1979
|
+
* })
|
|
1980
|
+
*/
|
|
1981
|
+
callWriteFunction(network: string, contractAddress: string, request: WriteFunctionRequest, requestOptions?: ContractInteractions.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1982
|
+
private __callWriteFunction;
|
|
1983
|
+
/**
|
|
1984
|
+
* Retrieve transaction receipt for a specific transaction
|
|
1985
|
+
*
|
|
1986
|
+
* @param {string} network - Blockchain network
|
|
1987
|
+
* @param {string} txId - Transaction ID
|
|
1988
|
+
* @param {ContractInteractions.RequestOptions} requestOptions - Request-specific configuration.
|
|
1989
|
+
*
|
|
1990
|
+
* @example
|
|
1991
|
+
* await client.contractInteractions.getTransactionReceipt("network", "txId")
|
|
1992
|
+
*/
|
|
1993
|
+
getTransactionReceipt(network: string, txId: string, requestOptions?: ContractInteractions.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
1994
|
+
private __getTransactionReceipt;
|
|
1995
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
1996
|
+
}
|
|
1997
|
+
|
|
1998
|
+
declare namespace Tokenization {
|
|
1999
|
+
interface Options {
|
|
2000
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
2001
|
+
/** Specify a custom URL to connect the client to. */
|
|
2002
|
+
baseUrl?: Supplier<string>;
|
|
2003
|
+
token?: Supplier<BearerToken | undefined>;
|
|
2004
|
+
/** Override the x-sdk-version header */
|
|
2005
|
+
sdkVersion?: "1.0.0";
|
|
2006
|
+
/** Override the x-api-key header */
|
|
2007
|
+
apiKey: Supplier<string>;
|
|
2008
|
+
/** Additional headers to include in requests. */
|
|
2009
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
2010
|
+
}
|
|
2011
|
+
interface RequestOptions {
|
|
2012
|
+
/** The maximum time to wait for a response in seconds. */
|
|
2013
|
+
timeoutInSeconds?: number;
|
|
2014
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
2015
|
+
maxRetries?: number;
|
|
2016
|
+
/** A hook to abort the request. */
|
|
2017
|
+
abortSignal?: AbortSignal;
|
|
2018
|
+
/** Override the x-sdk-version header */
|
|
2019
|
+
sdkVersion?: "1.0.0";
|
|
2020
|
+
/** Override the x-api-key header */
|
|
2021
|
+
apiKey?: string;
|
|
2022
|
+
/** Additional query string parameters to include in the request. */
|
|
2023
|
+
queryParams?: Record<string, unknown>;
|
|
2024
|
+
/** Additional headers to include in the request. */
|
|
2025
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
2026
|
+
}
|
|
2027
|
+
}
|
|
2028
|
+
/**
|
|
2029
|
+
* Token creation, minting, and management
|
|
2030
|
+
*/
|
|
2031
|
+
declare class Tokenization {
|
|
2032
|
+
protected readonly _options: Tokenization.Options;
|
|
2033
|
+
constructor(_options: Tokenization.Options);
|
|
2034
|
+
/**
|
|
2035
|
+
* Retrieve a paginated list of tokens
|
|
2036
|
+
*
|
|
2037
|
+
* @param {OumlaSdkApi.GetTokensRequest} request
|
|
2038
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2039
|
+
*
|
|
2040
|
+
* @example
|
|
2041
|
+
* await client.tokenization.getTokens({
|
|
2042
|
+
* skip: 1,
|
|
2043
|
+
* take: 1
|
|
2044
|
+
* })
|
|
2045
|
+
*/
|
|
2046
|
+
getTokens(request?: GetTokensRequest, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
2047
|
+
private __getTokens;
|
|
2048
|
+
/**
|
|
2049
|
+
* Issue a new token using a contract template
|
|
2050
|
+
*
|
|
2051
|
+
* @param {OumlaSdkApi.IssueNewTokenRequest} request
|
|
2052
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2053
|
+
*
|
|
2054
|
+
* @example
|
|
2055
|
+
* await client.tokenization.issueNewToken({
|
|
2056
|
+
* addressId: "addressId",
|
|
2057
|
+
* clientShare: "clientShare",
|
|
2058
|
+
* deploymentId: "deploymentId",
|
|
2059
|
+
* createParams: {
|
|
2060
|
+
* initializeParams: [{
|
|
2061
|
+
* name: "name",
|
|
2062
|
+
* type: "type",
|
|
2063
|
+
* value: "value"
|
|
2064
|
+
* }]
|
|
2065
|
+
* }
|
|
2066
|
+
* })
|
|
2067
|
+
*/
|
|
2068
|
+
issueNewToken(request: IssueNewTokenRequest, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
2069
|
+
private __issueNewToken;
|
|
2070
|
+
/**
|
|
2071
|
+
* Link an existing contract to the platform
|
|
2072
|
+
*
|
|
2073
|
+
* @param {OumlaSdkApi.LinkContractRequest} request
|
|
2074
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2075
|
+
*
|
|
2076
|
+
* @example
|
|
2077
|
+
* await client.tokenization.linkContract({
|
|
2078
|
+
* contractAddress: "contractAddress"
|
|
2079
|
+
* })
|
|
2080
|
+
*/
|
|
2081
|
+
linkContract(request: LinkContractRequest, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
2082
|
+
private __linkContract;
|
|
2083
|
+
/**
|
|
2084
|
+
* Retrieve a paginated list of collections
|
|
2085
|
+
*
|
|
2086
|
+
* @param {OumlaSdkApi.GetCollectionsRequest} request
|
|
2087
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2088
|
+
*
|
|
2089
|
+
* @example
|
|
2090
|
+
* await client.tokenization.getCollections({
|
|
2091
|
+
* skip: 1,
|
|
2092
|
+
* take: 1
|
|
2093
|
+
* })
|
|
2094
|
+
*/
|
|
2095
|
+
getCollections(request?: GetCollectionsRequest, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<PaginatedResponse>;
|
|
2096
|
+
private __getCollections;
|
|
2097
|
+
/**
|
|
2098
|
+
* Create a new token collection
|
|
2099
|
+
*
|
|
2100
|
+
* @param {OumlaSdkApi.CreateCollectionRequest} request
|
|
2101
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2102
|
+
*
|
|
2103
|
+
* @example
|
|
2104
|
+
* await client.tokenization.createCollection({
|
|
2105
|
+
* type: "NON_FUNGIBLE_TOKEN",
|
|
2106
|
+
* addressId: "addressId",
|
|
2107
|
+
* clientShare: "clientShare",
|
|
2108
|
+
* createParams: {
|
|
2109
|
+
* initializeParams: [{
|
|
2110
|
+
* name: "name",
|
|
2111
|
+
* type: "type",
|
|
2112
|
+
* value: "value"
|
|
2113
|
+
* }]
|
|
2114
|
+
* }
|
|
2115
|
+
* })
|
|
2116
|
+
*/
|
|
2117
|
+
createCollection(request: CreateCollectionRequest, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
2118
|
+
private __createCollection;
|
|
2119
|
+
/**
|
|
2120
|
+
* Retrieve a specific collection
|
|
2121
|
+
*
|
|
2122
|
+
* @param {string} id - Collection ID
|
|
2123
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2124
|
+
*
|
|
2125
|
+
* @example
|
|
2126
|
+
* await client.tokenization.getCollection("id")
|
|
2127
|
+
*/
|
|
2128
|
+
getCollection(id: string, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
2129
|
+
private __getCollection;
|
|
2130
|
+
/**
|
|
2131
|
+
* Delete a collection
|
|
2132
|
+
*
|
|
2133
|
+
* @param {string} id - Collection ID
|
|
2134
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2135
|
+
*
|
|
2136
|
+
* @example
|
|
2137
|
+
* await client.tokenization.deleteCollection("id")
|
|
2138
|
+
*/
|
|
2139
|
+
deleteCollection(id: string, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
2140
|
+
private __deleteCollection;
|
|
2141
|
+
/**
|
|
2142
|
+
* Retrieve details for a specific token in a collection
|
|
2143
|
+
*
|
|
2144
|
+
* @param {string} id - Collection ID
|
|
2145
|
+
* @param {string} tokenId - Token ID
|
|
2146
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2147
|
+
*
|
|
2148
|
+
* @example
|
|
2149
|
+
* await client.tokenization.getCollectionTokenDetails("id", "tokenId")
|
|
2150
|
+
*/
|
|
2151
|
+
getCollectionTokenDetails(id: string, tokenId: string, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
2152
|
+
private __getCollectionTokenDetails;
|
|
2153
|
+
/**
|
|
2154
|
+
* Mint a new token in a collection
|
|
2155
|
+
*
|
|
2156
|
+
* @param {string} id - Collection ID
|
|
2157
|
+
* @param {OumlaSdkApi.MintTokenRequest} request
|
|
2158
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2159
|
+
*
|
|
2160
|
+
* @example
|
|
2161
|
+
* await client.tokenization.mintToken("id", {
|
|
2162
|
+
* addressId: "addressId",
|
|
2163
|
+
* clientShare: "clientShare",
|
|
2164
|
+
* to: "to",
|
|
2165
|
+
* tokenId: "tokenId"
|
|
2166
|
+
* })
|
|
2167
|
+
*/
|
|
2168
|
+
mintToken(id: string, request: MintTokenRequest, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
2169
|
+
private __mintToken;
|
|
2170
|
+
/**
|
|
2171
|
+
* Burn a token
|
|
2172
|
+
*
|
|
2173
|
+
* @param {string} id - Collection ID
|
|
2174
|
+
* @param {OumlaSdkApi.BurnTokenRequest} request
|
|
2175
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2176
|
+
*
|
|
2177
|
+
* @example
|
|
2178
|
+
* await client.tokenization.burnToken("id", {
|
|
2179
|
+
* addressId: "addressId",
|
|
2180
|
+
* clientShare: "clientShare",
|
|
2181
|
+
* tokenId: "tokenId"
|
|
2182
|
+
* })
|
|
2183
|
+
*/
|
|
2184
|
+
burnToken(id: string, request: BurnTokenRequest, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
2185
|
+
private __burnToken;
|
|
2186
|
+
/**
|
|
2187
|
+
* Unlink a token from the platform
|
|
2188
|
+
*
|
|
2189
|
+
* @param {string} id - Token ID
|
|
2190
|
+
* @param {Tokenization.RequestOptions} requestOptions - Request-specific configuration.
|
|
2191
|
+
*
|
|
2192
|
+
* @example
|
|
2193
|
+
* await client.tokenization.unlinkToken("id")
|
|
2194
|
+
*/
|
|
2195
|
+
unlinkToken(id: string, requestOptions?: Tokenization.RequestOptions): HttpResponsePromise<SuccessResponse>;
|
|
2196
|
+
private __unlinkToken;
|
|
2197
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
2198
|
+
}
|
|
2199
|
+
|
|
2200
|
+
declare namespace OumlaSdkApiClient {
|
|
2201
|
+
interface Options {
|
|
2202
|
+
environment?: Supplier<OumlaSdkApiEnvironment | string>;
|
|
2203
|
+
/** Specify a custom URL to connect the client to. */
|
|
2204
|
+
baseUrl?: Supplier<string>;
|
|
2205
|
+
token?: Supplier<BearerToken | undefined>;
|
|
2206
|
+
/** Override the x-sdk-version header */
|
|
2207
|
+
sdkVersion?: "1.0.0";
|
|
2208
|
+
/** Override the x-api-key header */
|
|
2209
|
+
apiKey: Supplier<string>;
|
|
2210
|
+
/** Additional headers to include in requests. */
|
|
2211
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
2212
|
+
}
|
|
2213
|
+
interface RequestOptions {
|
|
2214
|
+
/** The maximum time to wait for a response in seconds. */
|
|
2215
|
+
timeoutInSeconds?: number;
|
|
2216
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
2217
|
+
maxRetries?: number;
|
|
2218
|
+
/** A hook to abort the request. */
|
|
2219
|
+
abortSignal?: AbortSignal;
|
|
2220
|
+
/** Override the x-sdk-version header */
|
|
2221
|
+
sdkVersion?: "1.0.0";
|
|
2222
|
+
/** Override the x-api-key header */
|
|
2223
|
+
apiKey?: string;
|
|
2224
|
+
/** Additional query string parameters to include in the request. */
|
|
2225
|
+
queryParams?: Record<string, unknown>;
|
|
2226
|
+
/** Additional headers to include in the request. */
|
|
2227
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
2228
|
+
}
|
|
2229
|
+
}
|
|
2230
|
+
declare class OumlaSdkApiClient {
|
|
2231
|
+
protected readonly _options: OumlaSdkApiClient.Options;
|
|
2232
|
+
protected _profiles: Profiles | undefined;
|
|
2233
|
+
protected _wallets: Wallets | undefined;
|
|
2234
|
+
protected _addresses: Addresses | undefined;
|
|
2235
|
+
protected _transactions: Transactions | undefined;
|
|
2236
|
+
protected _assets: Assets | undefined;
|
|
2237
|
+
protected _withdrawals: Withdrawals | undefined;
|
|
2238
|
+
protected _contractTemplates: ContractTemplates | undefined;
|
|
2239
|
+
protected _deployedContracts: DeployedContracts | undefined;
|
|
2240
|
+
protected _contractInteractions: ContractInteractions | undefined;
|
|
2241
|
+
protected _tokenization: Tokenization | undefined;
|
|
2242
|
+
constructor(_options: OumlaSdkApiClient.Options);
|
|
2243
|
+
get profiles(): Profiles;
|
|
2244
|
+
get wallets(): Wallets;
|
|
2245
|
+
get addresses(): Addresses;
|
|
2246
|
+
get transactions(): Transactions;
|
|
2247
|
+
get assets(): Assets;
|
|
2248
|
+
get withdrawals(): Withdrawals;
|
|
2249
|
+
get contractTemplates(): ContractTemplates;
|
|
2250
|
+
get deployedContracts(): DeployedContracts;
|
|
2251
|
+
get contractInteractions(): ContractInteractions;
|
|
2252
|
+
get tokenization(): Tokenization;
|
|
471
2253
|
}
|
|
472
2254
|
|
|
473
|
-
export {
|
|
2255
|
+
export { index as OumlaSdkApi, OumlaSdkApiClient, OumlaSdkApiEnvironment, OumlaSdkApiError, OumlaSdkApiTimeoutError };
|