@bitgo-beta/sdk-api 1.10.1-beta.18 → 1.10.1-beta.1800
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/dist/package.json +27 -28
- package/dist/src/api.d.ts +8 -5
- package/dist/src/api.d.ts.map +1 -1
- package/dist/src/api.js +130 -71
- package/dist/src/bitgoAPI.d.ts +161 -16
- package/dist/src/bitgoAPI.d.ts.map +1 -1
- package/dist/src/bitgoAPI.js +881 -296
- package/dist/src/encrypt.d.ts +23 -4
- package/dist/src/encrypt.d.ts.map +1 -1
- package/dist/src/encrypt.js +86 -13
- package/dist/src/encryptV2.d.ts +68 -0
- package/dist/src/encryptV2.d.ts.map +1 -0
- package/dist/src/encryptV2.js +202 -0
- package/dist/src/encryptionSession.d.ts +34 -0
- package/dist/src/encryptionSession.d.ts.map +1 -0
- package/dist/src/encryptionSession.js +95 -0
- package/dist/src/index.d.ts +2 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +8 -2
- package/dist/src/types.d.ts +79 -42
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/types.js +4 -2
- package/dist/src/util.d.ts +12 -0
- package/dist/src/util.d.ts.map +1 -1
- package/dist/src/util.js +57 -4
- package/dist/src/v1/blockchain.js +25 -12
- package/dist/src/v1/keychains.js +34 -26
- package/dist/src/v1/markets.js +10 -5
- package/dist/src/v1/pendingapproval.d.ts.map +1 -1
- package/dist/src/v1/pendingapproval.js +57 -18
- package/dist/src/v1/pendingapprovals.d.ts.map +1 -1
- package/dist/src/v1/pendingapprovals.js +41 -7
- package/dist/src/v1/signPsbt.d.ts +14 -0
- package/dist/src/v1/signPsbt.d.ts.map +1 -0
- package/dist/src/v1/signPsbt.js +69 -0
- package/dist/src/v1/transactionBuilder.js +232 -93
- package/dist/src/v1/travelRule.js +162 -66
- package/dist/src/v1/verifyAddress.d.ts +6 -0
- package/dist/src/v1/verifyAddress.d.ts.map +1 -0
- package/dist/src/v1/verifyAddress.js +50 -0
- package/dist/src/v1/wallet.d.ts.map +1 -1
- package/dist/src/v1/wallet.js +494 -230
- package/dist/src/v1/wallets.js +113 -53
- package/dist/test/unit/api.d.ts +2 -0
- package/dist/test/unit/api.d.ts.map +1 -0
- package/dist/test/unit/api.js +307 -0
- package/dist/test/unit/bitgoAPI.d.ts +2 -0
- package/dist/test/unit/bitgoAPI.d.ts.map +1 -0
- package/dist/test/unit/bitgoAPI.js +896 -0
- package/dist/test/unit/encrypt.d.ts +2 -0
- package/dist/test/unit/encrypt.d.ts.map +1 -0
- package/dist/test/unit/encrypt.js +415 -0
- package/dist/test/unit/hmacStrategy.d.ts +2 -0
- package/dist/test/unit/hmacStrategy.d.ts.map +1 -0
- package/dist/test/unit/hmacStrategy.js +136 -0
- package/dist/test/unit/utils.d.ts +2 -0
- package/dist/test/unit/utils.d.ts.map +1 -0
- package/dist/test/unit/utils.js +65 -0
- package/dist/test/unit/v1/fixtures/accelerate-tx.d.ts +4 -0
- package/dist/test/unit/v1/fixtures/accelerate-tx.d.ts.map +1 -0
- package/dist/test/unit/v1/fixtures/accelerate-tx.js +53 -0
- package/dist/test/unit/v1/fixtures/index.d.ts +3 -0
- package/dist/test/unit/v1/fixtures/index.d.ts.map +1 -0
- package/dist/test/unit/v1/fixtures/index.js +24 -0
- package/dist/test/unit/v1/signPsbt.d.ts +2 -0
- package/dist/test/unit/v1/signPsbt.d.ts.map +1 -0
- package/dist/test/unit/v1/signPsbt.js +53 -0
- package/dist/test/unit/v1/travelRule.d.ts +2 -0
- package/dist/test/unit/v1/travelRule.d.ts.map +1 -0
- package/dist/test/unit/v1/travelRule.js +173 -0
- package/dist/test/unit/v1/wallet.d.ts +2 -0
- package/dist/test/unit/v1/wallet.d.ts.map +1 -0
- package/dist/test/unit/v1/wallet.js +1603 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +27 -28
- package/.eslintignore +0 -5
- package/CHANGELOG.md +0 -262
- package/dist/web/main.js +0 -2
- package/dist/web/main.js.LICENSE.txt +0 -103
package/dist/src/bitgoAPI.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
+
import { BaseCoin, BitGoBase, BitGoRequest, CoinConstructor, DecryptKeysOptions, DecryptOptions, EcdhDerivedKeypair, EncryptOptions, EnvironmentName, GetSharingKeyOptions, GetSigningKeyApi, IRequestTracer } from '@bitgo-beta/sdk-core';
|
|
2
|
+
import { type IHmacAuthStrategy } from '@bitgo-beta/sdk-hmac';
|
|
1
3
|
import { ECPairInterface } from '@bitgo-beta/utxo-lib';
|
|
2
4
|
import * as superagent from 'superagent';
|
|
3
|
-
import {
|
|
4
|
-
import { AccessTokenOptions, AddAccessTokenResponse, AddAccessTokenOptions, AuthenticateOptions, AuthenticateWithAuthCodeOptions, BitGoAPIOptions, BitGoJson, BitGoSimulateWebhookOptions, CalculateHmacSubjectOptions, CalculateRequestHeadersOptions, CalculateRequestHmacOptions, ChangePasswordOptions, DeprecatedVerifyAddressOptions, EstimateFeeOptions, ExtendTokenOptions, GetEcdhSecretOptions, GetUserOptions, ListWebhookNotificationsOptions, PingOptions, ProcessedAuthenticationOptions, ReconstitutedSecret, ReconstituteSecretOptions, RegisterPushTokenOptions, RemoveAccessTokenOptions, RequestHeaders, SplitSecret, SplitSecretOptions, TokenIssuance, TokenIssuanceResponse, UnlockOptions, User, VerifyPasswordOptions, VerifyPushTokenOptions, VerifyResponseInfo, VerifyResponseOptions, VerifyShardsOptions, WebhookOptions } from './types';
|
|
5
|
-
declare const patchedRequestMethods: readonly ["get", "post", "put", "del", "patch"];
|
|
5
|
+
import { AccessTokenOptions, AddAccessTokenOptions, AddAccessTokenResponse, AuthenticateOptions, AuthenticateWithAuthCodeOptions, BitGoAPIOptions, BitGoJson, BitGoSimulateWebhookOptions, CalculateHmacSubjectOptions, CalculateRequestHeadersOptions, CalculateRequestHmacOptions, ChangePasswordOptions, Constants, DeprecatedVerifyAddressOptions, EstimateFeeOptions, ExtendTokenOptions, GetEcdhSecretOptions, GetUserOptions, ListWebhookNotificationsOptions, LoginResponse, PingOptions, ProcessedAuthenticationOptions, ReconstitutedSecret, ReconstituteSecretOptions, RegisterPushTokenOptions, RemoveAccessTokenOptions, RequestHeaders, RequestMethods, SplitSecret, SplitSecretOptions, TokenIssuance, TokenIssuanceResponse, UnlockOptions, User, VerifyPasswordOptions, VerifyPushTokenOptions, VerifyResponseInfo, VerifyResponseOptions, VerifyShardsOptions, WebhookOptions } from './types';
|
|
6
6
|
export declare class BitGoAPI implements BitGoBase {
|
|
7
7
|
protected _keychains: any;
|
|
8
8
|
protected _wallets: any;
|
|
@@ -17,6 +17,7 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
17
17
|
protected readonly _baseUrl: string;
|
|
18
18
|
protected readonly _baseApiUrl: string;
|
|
19
19
|
protected readonly _baseApiUrlV2: string;
|
|
20
|
+
protected readonly _baseApiUrlV3: string;
|
|
20
21
|
protected readonly _env: EnvironmentName;
|
|
21
22
|
protected readonly _authVersion: Exclude<BitGoAPIOptions['authVersion'], undefined>;
|
|
22
23
|
protected _hmacVerification: boolean;
|
|
@@ -33,13 +34,23 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
33
34
|
protected readonly _clientSecret?: string;
|
|
34
35
|
protected _validate: boolean;
|
|
35
36
|
readonly cookiesPropagationEnabled: boolean;
|
|
37
|
+
private _customProxyAgent?;
|
|
38
|
+
private _requestIdPrefix?;
|
|
39
|
+
private getAdditionalHeadersCb?;
|
|
40
|
+
protected _hmacAuthStrategy: IHmacAuthStrategy;
|
|
36
41
|
constructor(params?: BitGoAPIOptions);
|
|
42
|
+
/**
|
|
43
|
+
* Initialize client constants if provided.
|
|
44
|
+
* @param clientConstants - The client constants from params
|
|
45
|
+
* @private
|
|
46
|
+
*/
|
|
47
|
+
private _initializeClientConstants;
|
|
37
48
|
/**
|
|
38
49
|
* Get a superagent request for specified http method and URL configured to the SDK configuration
|
|
39
50
|
* @param method - http method for the new request
|
|
40
51
|
* @param url - URL for the new request
|
|
41
52
|
*/
|
|
42
|
-
protected getAgentRequest(method:
|
|
53
|
+
protected getAgentRequest(method: RequestMethods, url: string): superagent.SuperAgentRequest;
|
|
43
54
|
/**
|
|
44
55
|
* Create a basecoin object
|
|
45
56
|
* @param name
|
|
@@ -53,6 +64,11 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
53
64
|
* Return the current auth version used for requests to the BitGo server
|
|
54
65
|
*/
|
|
55
66
|
getAuthVersion(): number;
|
|
67
|
+
/**
|
|
68
|
+
* Signs and sends a v2-authenticated request, then verifies the response HMAC.
|
|
69
|
+
* Extracted from the req.then override in requestPatch to keep that method readable.
|
|
70
|
+
*/
|
|
71
|
+
private _sendRequestWithHmac;
|
|
56
72
|
/**
|
|
57
73
|
* This is a patching function which can apply our authorization
|
|
58
74
|
* headers to any outbound request.
|
|
@@ -64,6 +80,7 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
64
80
|
put(url: string): BitGoRequest;
|
|
65
81
|
del(url: string): BitGoRequest;
|
|
66
82
|
patch(url: string): BitGoRequest;
|
|
83
|
+
options(url: string): BitGoRequest;
|
|
67
84
|
/**
|
|
68
85
|
* Calculate the HMAC for the given key and message
|
|
69
86
|
* @param key {String} - the key to use for the HMAC
|
|
@@ -78,28 +95,34 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
78
95
|
* @param timestamp request timestamp from `Date.now()`
|
|
79
96
|
* @param statusCode Only set for HTTP responses, leave blank for requests
|
|
80
97
|
* @param method request method
|
|
81
|
-
* @returns {string}
|
|
98
|
+
* @returns {string | Buffer}
|
|
82
99
|
*/
|
|
83
|
-
calculateHMACSubject
|
|
100
|
+
calculateHMACSubject<T extends string | Buffer = string>(params: CalculateHmacSubjectOptions<T>): T;
|
|
84
101
|
/**
|
|
85
102
|
* Calculate the HMAC for an HTTP request
|
|
86
103
|
*/
|
|
87
|
-
calculateRequestHMAC(
|
|
104
|
+
calculateRequestHMAC(params: CalculateRequestHmacOptions): string;
|
|
88
105
|
/**
|
|
89
106
|
* Calculate request headers with HMAC
|
|
90
107
|
*/
|
|
91
|
-
calculateRequestHeaders(
|
|
108
|
+
calculateRequestHeaders(params: CalculateRequestHeadersOptions): RequestHeaders;
|
|
92
109
|
/**
|
|
93
|
-
* Verify the HMAC for an HTTP response
|
|
110
|
+
* Verify the HMAC for an HTTP response (synchronous, uses sdk-hmac directly).
|
|
111
|
+
* Kept for backward compatibility with external callers.
|
|
94
112
|
*/
|
|
95
|
-
verifyResponse(
|
|
113
|
+
verifyResponse(params: VerifyResponseOptions): VerifyResponseInfo;
|
|
114
|
+
/**
|
|
115
|
+
* Verify the HMAC for an HTTP response via the configured strategy (async).
|
|
116
|
+
* Used internally by the request pipeline.
|
|
117
|
+
*/
|
|
118
|
+
verifyResponseAsync(params: VerifyResponseOptions): Promise<VerifyResponseInfo>;
|
|
96
119
|
/**
|
|
97
120
|
* Fetch useful constant values from the BitGo server.
|
|
98
121
|
* These values do change infrequently, so they need to be fetched,
|
|
99
122
|
* but are unlikely to change during the lifetime of a BitGo object,
|
|
100
123
|
* so they can safely cached.
|
|
101
124
|
*/
|
|
102
|
-
fetchConstants(): Promise<
|
|
125
|
+
fetchConstants(): Promise<Constants>;
|
|
103
126
|
/**
|
|
104
127
|
* Create a url for calling BitGo platform APIs
|
|
105
128
|
* @param path
|
|
@@ -127,10 +150,39 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
127
150
|
* Utility function to encrypt locally.
|
|
128
151
|
*/
|
|
129
152
|
encrypt(params: EncryptOptions): string;
|
|
153
|
+
/**
|
|
154
|
+
* Async encrypt that dispatches to v1 (SJCL) or v2 (Argon2id + AES-256-GCM)
|
|
155
|
+
* based on `encryptionVersion`.
|
|
156
|
+
*/
|
|
157
|
+
encryptAsync(params: EncryptOptions): Promise<string>;
|
|
158
|
+
/**
|
|
159
|
+
* Create an encryption session for multi-call operations.
|
|
160
|
+
* Runs Argon2id once; all subsequent calls derive keys via HKDF.
|
|
161
|
+
*/
|
|
162
|
+
createEncryptionSession(password: string): Promise<import("./encryptionSession").EncryptionSession>;
|
|
130
163
|
/**
|
|
131
164
|
* Decrypt an encrypted string locally.
|
|
132
165
|
*/
|
|
133
166
|
decrypt(params: DecryptOptions): string;
|
|
167
|
+
/**
|
|
168
|
+
* Async decrypt that auto-detects v1 (SJCL) or v2 (Argon2id).
|
|
169
|
+
* Migration path from sync decrypt() -- use this before the breaking release.
|
|
170
|
+
*/
|
|
171
|
+
decryptAsync(params: DecryptOptions): Promise<string>;
|
|
172
|
+
/**
|
|
173
|
+
* TODO: deprecate this function in favor of decryptKeysAsync once v2 encryption is default
|
|
174
|
+
* Attempt to decrypt multiple wallet keys with the provided passphrase
|
|
175
|
+
* @param {DecryptKeysOptions} params - Parameters object containing wallet key pairs and password
|
|
176
|
+
* @param {Array<{walletId: string, encryptedPrv: string}>} params.walletIdEncryptedKeyPairs - Array of wallet ID and encrypted private key pairs
|
|
177
|
+
* @param {string} params.password - The passphrase to attempt decryption with
|
|
178
|
+
* @returns {string[]} - Array of wallet IDs for which decryption failed
|
|
179
|
+
*/
|
|
180
|
+
decryptKeys(params: DecryptKeysOptions): string[];
|
|
181
|
+
/**
|
|
182
|
+
* Async version of decryptKeys with v2 encrypt/decrypt support.
|
|
183
|
+
* @param params
|
|
184
|
+
*/
|
|
185
|
+
decryptKeysAsync(params: DecryptKeysOptions): Promise<string[]>;
|
|
134
186
|
/**
|
|
135
187
|
* Serialize this BitGo object to a JSON object.
|
|
136
188
|
*
|
|
@@ -154,21 +206,58 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
154
206
|
* Process the username, password and otp into an object containing the username and hashed password, ready to
|
|
155
207
|
* send to bitgo for authentication.
|
|
156
208
|
*/
|
|
157
|
-
preprocessAuthenticationParams({ username, password, otp, forceSMS, extensible, trust, }: AuthenticateOptions): ProcessedAuthenticationOptions
|
|
209
|
+
preprocessAuthenticationParams({ username, password, otp, forceSMS, extensible, trust, forReset2FA, initialHash, fingerprintHash, }: AuthenticateOptions): Promise<ProcessedAuthenticationOptions>;
|
|
210
|
+
/**
|
|
211
|
+
* Validate the passkey response is in the expected format
|
|
212
|
+
* Should be as is returned from navigator.credentials.get()
|
|
213
|
+
*/
|
|
214
|
+
validatePasskeyResponse(passkeyResponse: string): void;
|
|
158
215
|
/**
|
|
159
216
|
* Synchronous method for activating an access token.
|
|
160
217
|
*/
|
|
161
218
|
authenticateWithAccessToken({ accessToken }: AccessTokenOptions): void;
|
|
219
|
+
/**
|
|
220
|
+
* Creates a new ECDH keychain for the user.
|
|
221
|
+
* @param {string} loginPassword - The user's login password.
|
|
222
|
+
* @returns {Promise<any>} - A promise that resolves with the new ECDH keychain data.
|
|
223
|
+
* @throws {Error} - Throws an error if there is an issue creating the keychain.
|
|
224
|
+
*/
|
|
225
|
+
createUserEcdhKeychain(loginPassword: string): Promise<any>;
|
|
226
|
+
/**
|
|
227
|
+
* Updates the user's settings with the provided parameters.
|
|
228
|
+
* @param {Object} params - The parameters to update the user's settings with.
|
|
229
|
+
* @returns {Promise<any>}
|
|
230
|
+
* @throws {Error} - Throws an error if there is an issue updating the user's settings.
|
|
231
|
+
*/
|
|
232
|
+
private updateUserSettings;
|
|
233
|
+
/**
|
|
234
|
+
* Ensures that the user's ECDH keychain is created for wallet sharing and TSS wallets.
|
|
235
|
+
* If the keychain does not exist, it will be created and the user's settings will be updated.
|
|
236
|
+
* @param {string} loginPassword - The user's login password.
|
|
237
|
+
* @returns {Promise<any>} - A promise that resolves with the user's settings ensuring we have the ecdhKeychain in there.
|
|
238
|
+
* @throws {Error} - Throws an error if there is an issue creating the keychain or updating the user's settings.
|
|
239
|
+
*/
|
|
240
|
+
private ensureUserEcdhKeychainIsCreated;
|
|
162
241
|
/**
|
|
163
242
|
* Login to the bitgo platform.
|
|
164
243
|
*/
|
|
165
|
-
authenticate(params: AuthenticateOptions): Promise<any>;
|
|
244
|
+
authenticate(params: AuthenticateOptions): Promise<LoginResponse | any>;
|
|
166
245
|
/**
|
|
167
|
-
*
|
|
246
|
+
* Login to the bitgo platform with passkey.
|
|
247
|
+
*/
|
|
248
|
+
authenticateWithPasskey(passkey: string, initialHash?: string, fingerprintHash?: string): Promise<LoginResponse | any>;
|
|
249
|
+
/**
|
|
250
|
+
* TODO: Deprecate this function in favor of handleTokenIssuanceAsync once v2 encryption is default.
|
|
168
251
|
* @param responseBody Response body object
|
|
169
252
|
* @param password Password for the symmetric decryption
|
|
170
253
|
*/
|
|
171
254
|
handleTokenIssuance(responseBody: TokenIssuanceResponse, password?: string): TokenIssuance;
|
|
255
|
+
/**
|
|
256
|
+
* Async version of handleTokenIssuance with v2 encrypt/decrypt support.
|
|
257
|
+
* @param responseBody Response body object
|
|
258
|
+
* @param password Password for the symmetric decryption
|
|
259
|
+
*/
|
|
260
|
+
handleTokenIssuanceAsync(responseBody: TokenIssuanceResponse, password?: string): Promise<TokenIssuance>;
|
|
172
261
|
/**
|
|
173
262
|
*/
|
|
174
263
|
verifyPassword(params?: VerifyPasswordOptions): Promise<any>;
|
|
@@ -176,6 +265,7 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
176
265
|
* Clear out all state from this BitGo object, effectively logging out the current user.
|
|
177
266
|
*/
|
|
178
267
|
clear(): void;
|
|
268
|
+
clearAsync(): Promise<void>;
|
|
179
269
|
/**
|
|
180
270
|
* Use refresh token to get new access token.
|
|
181
271
|
* If the refresh token is null/defined, then we use the stored token from auth
|
|
@@ -399,6 +489,7 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
399
489
|
*/
|
|
400
490
|
verifyAddress(params?: DeprecatedVerifyAddressOptions): boolean;
|
|
401
491
|
/**
|
|
492
|
+
* TODO: deprecate this function in favor of splitSecretAsync when v2 encryption is the default
|
|
402
493
|
* Split a secret into shards using Shamir Secret Sharing.
|
|
403
494
|
* @param seed A hexadecimal secret to split
|
|
404
495
|
* @param passwords An array of the passwords used to encrypt each share
|
|
@@ -406,19 +497,41 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
406
497
|
*/
|
|
407
498
|
splitSecret({ seed, passwords, m }: SplitSecretOptions): SplitSecret;
|
|
408
499
|
/**
|
|
500
|
+
* Async version of splitSecret with v2 encrypt/decrypt support.
|
|
501
|
+
* @param seed
|
|
502
|
+
* @param passwords
|
|
503
|
+
* @param m
|
|
504
|
+
*/
|
|
505
|
+
splitSecretAsync({ seed, passwords, m }: SplitSecretOptions): Promise<SplitSecret>;
|
|
506
|
+
/**
|
|
507
|
+
* TODO: deprecate this function in favor of reconstituteSecretAsync when v2 encryption is the default
|
|
409
508
|
* Reconstitute a secret which was sharded with `splitSecret`.
|
|
410
509
|
* @param shards
|
|
411
510
|
* @param passwords
|
|
412
511
|
*/
|
|
413
512
|
reconstituteSecret({ shards, passwords }: ReconstituteSecretOptions): ReconstitutedSecret;
|
|
414
513
|
/**
|
|
415
|
-
*
|
|
514
|
+
* Async version of reconstituteSecret with v2 encrypt/decrypt support.
|
|
515
|
+
* @param shards
|
|
516
|
+
* @param passwords
|
|
517
|
+
*/
|
|
518
|
+
reconstituteSecretAsync({ shards, passwords }: ReconstituteSecretOptions): Promise<ReconstitutedSecret>;
|
|
519
|
+
/**
|
|
520
|
+
* TODO: Deprecate this function in favour of verifyShardsAsync when v2 encryption is the default.
|
|
416
521
|
* @param shards
|
|
417
522
|
* @param passwords
|
|
418
523
|
* @param m
|
|
419
524
|
* @param xpub Optional xpub to verify the results against
|
|
420
525
|
*/
|
|
421
526
|
verifyShards({ shards, passwords, m, xpub }: VerifyShardsOptions): boolean;
|
|
527
|
+
/**
|
|
528
|
+
* Async version of verifyShards with v2 encrypt/decrypt support.
|
|
529
|
+
* @param shards
|
|
530
|
+
* @param passwords
|
|
531
|
+
* @param m
|
|
532
|
+
* @param xpub
|
|
533
|
+
*/
|
|
534
|
+
verifyShardsAsync({ shards, passwords, m, xpub }: VerifyShardsOptions): Promise<boolean>;
|
|
422
535
|
/**
|
|
423
536
|
* @deprecated - use `getSharedSecret()`
|
|
424
537
|
*/
|
|
@@ -427,6 +540,12 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
427
540
|
* Gets the user's private ECDH keychain
|
|
428
541
|
*/
|
|
429
542
|
getECDHKeychain(ecdhKeychainPub?: string): Promise<any>;
|
|
543
|
+
/**
|
|
544
|
+
* Returns the user derived public and private ECDH keypair
|
|
545
|
+
* @param password password to decrypt the user's ECDH encrypted private key
|
|
546
|
+
* @param entId? optional enterprise id to check for permissions
|
|
547
|
+
*/
|
|
548
|
+
getEcdhKeypairPrivate(password: string, entId: string): Promise<EcdhDerivedKeypair>;
|
|
430
549
|
/**
|
|
431
550
|
* @param params
|
|
432
551
|
* - operatingSystem: one of ios, android
|
|
@@ -539,6 +658,32 @@ export declare class BitGoAPI implements BitGoBase {
|
|
|
539
658
|
* @return {Object} The client constants object
|
|
540
659
|
*/
|
|
541
660
|
getConstants(): any;
|
|
661
|
+
/**
|
|
662
|
+
* Execute an asset request which does not need HMAC validation
|
|
663
|
+
* @param url The URL for the asset request
|
|
664
|
+
* @returns {Promise<any>} The response body
|
|
665
|
+
*/
|
|
666
|
+
protected executeAssetRequest(url: string): Promise<any>;
|
|
667
|
+
/**
|
|
668
|
+
* Pack keychains into batches using First Fit Decreasing (FFD) algorithm.
|
|
669
|
+
*
|
|
670
|
+
* @param keychains - V1 keychains
|
|
671
|
+
* @param v2Keychains - V2 keychains
|
|
672
|
+
* @param maxBatchSizeBytes - Maximum byte size per batch
|
|
673
|
+
* @private
|
|
674
|
+
*/
|
|
675
|
+
private packKeychainsFFD;
|
|
676
|
+
/**
|
|
677
|
+
* Process keychain password updates in batches with retry logic.
|
|
678
|
+
* Uses First Fit Decreasing (FFD) bin packing to ensure no batch exceeds
|
|
679
|
+
* maxBatchSizeKB
|
|
680
|
+
*
|
|
681
|
+
* @param keychains - The v1 keychains to update
|
|
682
|
+
* @param v2Keychains - The v2 keychains to update
|
|
683
|
+
* @param maxBatchSizeKB - Maximum payload size per batch in kilobytes
|
|
684
|
+
* @param maxRetries - Maximum number of retries per batch
|
|
685
|
+
* @private
|
|
686
|
+
*/
|
|
687
|
+
private processKeychainPasswordUpdatesInBatches;
|
|
542
688
|
}
|
|
543
|
-
export {};
|
|
544
689
|
//# sourceMappingURL=bitgoAPI.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bitgoAPI.d.ts","sourceRoot":"","sources":["../../src/bitgoAPI.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"bitgoAPI.d.ts","sourceRoot":"","sources":["../../src/bitgoAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAER,SAAS,EACT,YAAY,EACZ,eAAe,EAEf,kBAAkB,EAClB,cAAc,EAEd,kBAAkB,EAClB,cAAc,EACd,eAAe,EAIf,oBAAoB,EACpB,gBAAgB,EAEhB,cAAc,EAGf,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAA2B,KAAK,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEvF,OAAO,EAAS,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAM9D,OAAO,KAAK,UAAU,MAAM,YAAY,CAAC;AAYzC,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,sBAAsB,EAEtB,mBAAmB,EACnB,+BAA+B,EAC/B,eAAe,EACf,SAAS,EACT,2BAA2B,EAC3B,2BAA2B,EAC3B,8BAA8B,EAC9B,2BAA2B,EAC3B,qBAAqB,EACrB,SAAS,EACT,8BAA8B,EAC9B,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,+BAA+B,EAC/B,aAAa,EACb,WAAW,EACX,8BAA8B,EAC9B,mBAAmB,EACnB,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACxB,cAAc,EACd,cAAc,EACd,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,aAAa,EACb,IAAI,EACJ,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACf,MAAM,SAAS,CAAC;AA8IjB,qBAAa,QAAS,YAAW,SAAS;IAExC,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC;IAC1B,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;IACxB,SAAS,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC;IACzB,SAAS,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IAC5B,SAAS,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IAC5B,SAAS,CAAC,iBAAiB,CAAC,EAAE,GAAG,CAAC;IAElC,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC;IACjC,SAAS,CAAC,MAAM,CAAC,gBAAgB,EAAE,GAAG,CAAC;IACvC,SAAS,CAAC,MAAM,CAAC,sBAAsB,UAAS;IAChD,SAAgB,GAAG,EAAE,eAAe,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IACpC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IACvC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IACzC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IACzC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IACzC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC,CAAK;IACxF,SAAS,CAAC,iBAAiB,UAAQ;IACnC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC;IACvB,SAAS,CAAC,aAAa,CAAC,EAAE,eAAe,CAAC;IAC1C,SAAS,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC;IAClC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,QAAQ,SAAiB;IACnC,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IACjC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IACtC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAC1C,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC;IAC7B,SAAgB,yBAAyB,EAAE,OAAO,CAAC;IACnD,OAAO,CAAC,iBAAiB,CAAC,CAAQ;IAClC,OAAO,CAAC,gBAAgB,CAAC,CAAS;IAClC,OAAO,CAAC,sBAAsB,CAAC,CAA4B;IAC3D,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;gBAEnC,MAAM,GAAE,eAAoB;IAgMxC;;;;OAIG;IACH,OAAO,CAAC,0BAA0B;IASlC;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,iBAAiB;IAO5F;;;OAGG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ;IAInC;;OAEG;IACH,MAAM,IAAI,eAAe;IAIzB;;OAEG;IACH,cAAc,IAAI,MAAM;IAIxB;;;OAGG;YACW,oBAAoB;IA2ElC;;;;OAIG;IACH,OAAO,CAAC,YAAY;IA6EpB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAG9B,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAG/B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAG9B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAG9B,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAGhC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;IAIlC;;;;;OAKG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAInD;;;;;;;;OAQG;IACH,oBAAoB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,2BAA2B,CAAC,CAAC,CAAC,GAAG,CAAC;IAInG;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,2BAA2B,GAAG,MAAM;IAIjE;;OAEG;IACH,uBAAuB,CAAC,MAAM,EAAE,8BAA8B,GAAG,cAAc;IAI/E;;;OAGG;IACH,cAAc,CAAC,MAAM,EAAE,qBAAqB,GAAG,kBAAkB;IAIjE;;;OAGG;IACH,mBAAmB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI/E;;;;;OAKG;IACG,cAAc,IAAI,OAAO,CAAC,SAAS,CAAC;IA2C1C;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,SAAI,GAAG,MAAM;IAKtC;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAItC;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,EAAE,GAAE,WAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IAQ/C;;OAEG;IACH,gBAAgB,CAAC,SAAS,EAAE,cAAc,GAAG,IAAI;IAMjD;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IAQvC;;;OAGG;IACG,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAW3D;;;OAGG;IACG,uBAAuB,CAAC,QAAQ,EAAE,MAAM;IAI9C;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IAgBvC;;;OAGG;IACG,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB3D;;;;;;;OAOG;IACH,WAAW,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,EAAE;IAgCjD;;;OAGG;IACG,gBAAgB,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA8BrE;;;;OAIG;IACH,MAAM,IAAI,SAAS;IASnB;;OAEG;IACH,IAAI,IAAI,IAAI,GAAG,SAAS;IAIxB;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;IAa/B;;;OAGG;IACG,8BAA8B,CAAC,EACnC,QAAQ,EACR,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,UAAU,EACV,KAAK,EACL,WAAW,EACX,WAAW,EACX,eAAe,GAChB,EAAE,mBAAmB,GAAG,OAAO,CAAC,8BAA8B,CAAC;IA+ChE;;;OAGG;IACH,uBAAuB,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI;IAsBtD;;OAEG;IACH,2BAA2B,CAAC,EAAE,WAAW,EAAE,EAAE,kBAAkB,GAAG,IAAI;IAKtE;;;;;OAKG;IACU,sBAAsB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBxE;;;;;OAKG;YACW,kBAAkB;IAIhC;;;;;;OAMG;YACW,+BAA+B;IA0B7C;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,GAAG,GAAG,CAAC;IAyE7E;;OAEG;IACG,uBAAuB,CAC3B,OAAO,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,MAAM,GACvB,OAAO,CAAC,aAAa,GAAG,GAAG,CAAC;IAoC/B;;;;OAIG;IACH,mBAAmB,CAAC,YAAY,EAAE,qBAAqB,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,aAAa;IA2C1F;;;;OAIG;IACG,wBAAwB,CAAC,YAAY,EAAE,qBAAqB,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IA2C9G;OACG;IACG,cAAc,CAAC,MAAM,GAAE,qBAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;IAatE;;OAEG;IACH,KAAK,IAAI,IAAI;IAQP,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAKjC;;;OAGG;IACG,YAAY,CAAC,MAAM,GAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IA2BxE;;;;;;;;;;;;;;;;;;OAkBG;IACG,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAItC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,cAAc,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAiEpF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,iBAAiB,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC;IA6B9E;;;;OAIG;IACH,sBAAsB,CAAC,QAAQ,SAAI,GAAG,MAAM;IAI5C;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC;IAM5B;;;;;OAKG;IACG,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAMnD;;OAEG;IACG,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxB;;;;OAIG;IACG,MAAM,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC;IAO5D;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAI1B;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC;IAI7B;;;;OAIG;IACG,OAAO,CAAC,MAAM,GAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhE;;;;OAIG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAuBhE;;;OAGG;IACG,aAAa,CAAC,EAAE,KAAK,EAAE,EAAE,oBAAoB,GAAG,OAAO,CAAC,GAAG,CAAC;IAQlE;;;;;;;OAOG;IACG,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO5F;;OAEG;IACH,WAAW,IAAI,OAAO;IAItB;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;IAOpC;;;;;OAKG;IACI,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,GAAG,IAAI;IAI1D;;;;OAIG;IACH,OAAO,IAAI,GAAG;IAOd;;;;OAIG;IAEG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC;IAI5B;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC;IAI/B;;;OAGG;IACH,UAAU,IAAI,GAAG;IAOjB;;;OAGG;IACH,SAAS,IAAI,GAAG;IAOhB;;;OAGG;IACH,UAAU,IAAI,GAAG;IAOjB;;;OAGG;IACH,OAAO,IAAI,GAAG;IAOd;;;OAGG;IACH,gBAAgB,IAAI,GAAG;IAOvB;;;;;OAKG;IACH,eAAe,CAAC,YAAY,KAAA,GAAG,GAAG;IAIlC;;;;;;;;;OASG;IACG,qBAAqB,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAItD;;;OAGG;IACH,aAAa,CAAC,MAAM,GAAE,8BAAmC,GAAG,OAAO;IAanE;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,kBAAkB,GAAG,WAAW;IASpE;;;;;OAKG;IACG,gBAAgB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IASxF;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,yBAAyB,GAAG,mBAAmB;IASzF;;;;OAIG;IACG,uBAAuB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,yBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAS7G;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,mBAAmB,GAAG,OAAO;IAQ1E;;;;;;OAMG;IACG,iBAAiB,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ9F;;OAEG;IACH,aAAa,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,oBAAoB,GAAG,MAAM;IAWtE;;OAEG;IACG,eAAe,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAW7D;;;;OAIG;IACG,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAuBzF;;;;;;OAMG;IACG,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC;IAcvE;;;;OAIG;IACH,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB7D;;OAEG;IACG,wBAAwB,CAAC,MAAM,EAAE,+BAA+B,GAAG,OAAO,CAAC,GAAG,CAAC;IAuCrF;;;;;;OAMG;IACG,cAAc,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;IAyEvF;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC;IAI5B;;;;;;;;OAQG;IACG,WAAW,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAoChE;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAsB5D;;;OAGG;IACG,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxC;;;;OAIG;IACG,gBAAgB,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAItE;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC;IAIlC;;;;;;OAMG;IACG,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAYtD;;;;;;OAMG;IACG,aAAa,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAYzD;;;;;OAKG;IACG,wBAAwB,CAAC,MAAM,GAAE,+BAAoC,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB1F;;;;;OAKG;IACG,eAAe,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,GAAG,CAAC;IAexE;;;;;;;;;;OAUG;IACH,YAAY,IAAI,GAAG;IAcnB;;;;OAIG;cACa,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB9D;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IA6CxB;;;;;;;;;;OAUG;YACW,uCAAuC;CA4CtD"}
|