Skip to content

Add Idempotency Key to PUT requests #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add Idempotency Key to PUT requests #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b188fff
Update fireblocks-sdk.ts
SlavaSereb Sep 19, 2023
c5ac756
Update api-client.ts
SlavaSereb Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions src/api-client.ts
View file
Open in desktop
Copy link
Collaborator

@YoavBZ YoavBZ Oct 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please reformat

Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,20 @@ export class ApiClient {
return response.data;
}

public async issuePutRequest<T>(path: string, body: any): Promise<T> {
public async issuePutRequest<T>(path: string, body: any, requestOptions?: RequestOptions): Promise<T> {
const token = this.authProvider.signJwt(path, body);
const res = (await this.axiosInstance.put<T>(path, body, {
headers: {"Authorization": `Bearer ${token}`}
}));
const headers: any = { "Authorization": `Bearer ${token}` }
const idempotencyKey = requestOptions?.idempotencyKey;
if (idempotencyKey) {
headers["Idempotency-Key"] = idempotencyKey;
}

const ncwWalletId = requestOptions?.ncw?.walletId;
if (ncwWalletId) {
headers["X-End-User-Wallet-Id"] = ncwWalletId;
}

const res = (await this.axiosInstance.put<T>(path, body, { headers }));
return res.data;
}

Expand Down
84 changes: 42 additions & 42 deletions src/fireblocks-sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,15 +272,15 @@ export class FireblocksSDK {
* @param tag The XRP tag, or EOS memo, for which to set the description
* @param description The description to set
*/
public async setAddressDescription(vaultAccountId: string, assetId: string, address: string, tag?: string, description?: string): Promise<OperationSuccessResponse> {
public async setAddressDescription(vaultAccountId: string, assetId: string, address: string, tag?: string, description?: string, requestOptions?: RequestOptions): Promise<OperationSuccessResponse> {
let addressId = address;
if (tag && tag.length > 0) {
addressId = `${address}:${tag}`;
}

return await this.apiClient.issuePutRequest(
`/v1/vault/accounts/${vaultAccountId}/${assetId}/addresses/${addressId}`,
{description: description || ""});
{description: description || ""}, requestOptions);
}

/**
Expand Down Expand Up @@ -698,12 +698,12 @@ export class FireblocksSDK {
* @param vaultAccountId
* @param name A new name for the vault account
*/
public async updateVaultAccount(vaultAccountId: string, name: string): Promise<VaultAccountResponse> {
public async updateVaultAccount(vaultAccountId: string, name: string, requestOptions?: RequestOptions): Promise<VaultAccountResponse> {
const body = {
name: name
};

return await this.apiClient.issuePutRequest(`/v1/vault/accounts/${vaultAccountId}`, body);
return await this.apiClient.issuePutRequest(`/v1/vault/accounts/${vaultAccountId}`, body, requestOptions);
}

/**
Expand Down Expand Up @@ -1044,7 +1044,7 @@ export class FireblocksSDK {
/**
* Set configuration of the Gas Station account
*/
public async setGasStationConfiguration(gasThreshold: string, gasCap: string, maxGasPrice?: string, assetId?: string): Promise<OperationSuccessResponse> {
public async setGasStationConfiguration(gasThreshold: string, gasCap: string, maxGasPrice?: string, assetId?: string, requestOptions?: RequestOptions): Promise<OperationSuccessResponse> {
let url = `/v1/gas_station/configuration`;

if (assetId) {
Expand All @@ -1053,7 +1053,7 @@ export class FireblocksSDK {

const body = {gasThreshold, gasCap, maxGasPrice};

return await this.apiClient.issuePutRequest(url, body);
return await this.apiClient.issuePutRequest(url, body, requestOptions);
}

/**
Expand Down Expand Up @@ -1189,9 +1189,9 @@ export class FireblocksSDK {
* @param name The name of the Users Group
* @param memberIds The members of the Users Group
*/
public async updateUserGroup(id: string, groupName?: string, memberIds?: string[]): Promise<UsersGroup> {
public async updateUserGroup(id: string, groupName?: string, memberIds?: string[], requestOptions?: RequestOptions): Promise<UsersGroup> {
const body = { groupName, memberIds };
return await this.apiClient.issuePutRequest(`/v1/users_groups/${id}`, body);
return await this.apiClient.issuePutRequest(`/v1/users_groups/${id}`, body, requestOptions);
}

/**
Expand Down Expand Up @@ -1361,10 +1361,10 @@ export class FireblocksSDK {
* @param approve Whether you approve the connection or not
*/
public async submitWeb3Connection(type: Web3ConnectionType.WALLET_CONNECT, sessionId: string, approve: boolean): Promise<void>;
public async submitWeb3Connection(type: Web3ConnectionType, sessionId: string, approve: boolean): Promise<void> {
public async submitWeb3Connection(type: Web3ConnectionType, sessionId: string, approve: boolean, requestOptions?: RequestOptions): Promise<void> {
const path = this.getWeb3ConnectionPath(type);

return await this.apiClient.issuePutRequest(`${path}/${sessionId}`, {approve});
return await this.apiClient.issuePutRequest(`${path}/${sessionId}`, {approve}, requestOptions);
}

/**
Expand Down Expand Up @@ -1531,8 +1531,8 @@ export class FireblocksSDK {
*
* @param id
*/
public async refreshNFTMetadata(id: string): Promise<void> {
return await this.apiClient.issuePutRequest(`/v1/nfts/tokens/${id}`, undefined);
public async refreshNFTMetadata(id: string, requestOptions?: RequestOptions): Promise<void> {
return await this.apiClient.issuePutRequest(`/v1/nfts/tokens/${id}`, undefined, requestOptions);
}

/**
Expand All @@ -1541,19 +1541,19 @@ export class FireblocksSDK {
* @param id NFT asset id
* @param status Status for update
*/
public async updateNFTOwnershipStatus(id: string, status: NFTOwnershipStatus): Promise<void> {
return await this.apiClient.issuePutRequest(`/v1/nfts/ownership/tokens/${id}/status`, { status });
public async updateNFTOwnershipStatus(id: string, status: NFTOwnershipStatus, requestOptions?: RequestOptions): Promise<void> {
return await this.apiClient.issuePutRequest(`/v1/nfts/ownership/tokens/${id}/status`, { status }, requestOptions);
}

/**
*
* @param vaultAccountId
* @param blockchainDescriptor
*/
public async refreshNFTOwnershipByVault(vaultAccountId: string, blockchainDescriptor: string): Promise<void> {
public async refreshNFTOwnershipByVault(vaultAccountId: string, blockchainDescriptor: string, requestOptions?: RequestOptions): Promise<void> {
return await this.apiClient.issuePutRequest(
`/v1/nfts/ownership/tokens?vaultAccountId=${vaultAccountId}&blockchainDescriptor=${blockchainDescriptor}`,
undefined);
undefined, requestOptions);
}

/**
Expand Down Expand Up @@ -1599,8 +1599,8 @@ export class FireblocksSDK {
* Link a token to the tenant
* @param assetId
*/
public async linkToken(assetId: string): Promise<TokenLink> {
return await this.apiClient.issuePutRequest(`/v1/tokenization/tokens/${assetId}/link`, { });
public async linkToken(assetId: string, requestOptions?: RequestOptions): Promise<TokenLink> {
return await this.apiClient.issuePutRequest(`/v1/tokenization/tokens/${assetId}/link`, { }, requestOptions);
}

/**
Expand All @@ -1616,8 +1616,8 @@ export class FireblocksSDK {
* @param assetId
* @param permissions
*/
public async addLinkedTokenPermissions(assetId: string, permissions: TokenLinkPermissionEntry[]): Promise<TokenLink> {
return await this.apiClient.issuePutRequest(`/v1/tokenization/tokens/${assetId}/permissions`, { permissions });
public async addLinkedTokenPermissions(assetId: string, permissions: TokenLinkPermissionEntry[], requestOptions?: RequestOptions): Promise<TokenLink> {
return await this.apiClient.issuePutRequest(`/v1/tokenization/tokens/${assetId}/permissions`, { permissions }, requestOptions);
}

/**
Expand Down Expand Up @@ -1678,8 +1678,8 @@ export class FireblocksSDK {
/**
* Update VASP for travel rule compliance
*/
public async updateVasp(vaspInfo: TravelRuleVasp): Promise<TravelRuleVasp> {
return await this.apiClient.issuePutRequest(`/v1/screening/travel-rule/vasp/update`, vaspInfo);
public async updateVasp(vaspInfo: TravelRuleVasp, requestOptions?: RequestOptions): Promise<TravelRuleVasp> {
return await this.apiClient.issuePutRequest(`/v1/screening/travel-rule/vasp/update`, vaspInfo, requestOptions);
}

/**
Expand Down Expand Up @@ -1707,8 +1707,8 @@ export class FireblocksSDK {
* Update Bypass Screening Configuration for travel rule compliance
* @param screeningPolicyConfiguration
*/
public async updateTravelRulePolicyConfiguration(screeningPolicyConfiguration: ScreeningPolicyConfiguration): Promise<ScreeningPolicyConfiguration> {
return await this.apiClient.issuePutRequest(`/v1/screening/travel_rule/policy_configuration`, screeningPolicyConfiguration);
public async updateTravelRulePolicyConfiguration(screeningPolicyConfiguration: ScreeningPolicyConfiguration, requestOptions?: RequestOptions): Promise<ScreeningPolicyConfiguration> {
return await this.apiClient.issuePutRequest(`/v1/screening/travel_rule/policy_configuration`, screeningPolicyConfiguration, requestOptions);
}

/**
Expand Down Expand Up @@ -1741,42 +1741,42 @@ export class FireblocksSDK {
* @param ticketId
* @param expiresIn
*/
public setSmartTransferTicketExpiresIn(ticketId: string, expiresIn: number): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/expires-in`, {expiresIn});
public setSmartTransferTicketExpiresIn(ticketId: string, expiresIn: number, requestOptions?: RequestOptions): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/expires-in`, {expiresIn}, requestOptions);
}

/**
* Set Smart Transfer ticket external id
* @param ticketId
* @param externalRefId
*/
public setSmartTransferTicketExternalId(ticketId: string, externalRefId: string): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/external-id`, {externalRefId});
public setSmartTransferTicketExternalId(ticketId: string, externalRefId: string, requestOptions?: RequestOptions): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/external-id`, {externalRefId}, requestOptions);
}

/**
* Submit Smart Transfers ticket
* @param ticketId
* @param expiresIn
*/
public submitSmartTransferTicket(ticketId: string, expiresIn: number): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/submit`, {expiresIn});
public submitSmartTransferTicket(ticketId: string, expiresIn: number, requestOptions?: RequestOptions): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/submit`, {expiresIn}, requestOptions);
}

/**
* Fulfill Smart Transfers ticket
* @param ticketId
*/
public fulfillSmartTransferTicket(ticketId: string): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/fulfill`, {});
public fulfillSmartTransferTicket(ticketId: string, requestOptions?: RequestOptions): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/fulfill`, {}, requestOptions);
}

/**
* Cancel Smart Transfers ticket
* @param ticketId
*/
public cancelSmartTransferTicket(ticketId: string): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/cancel`, {});
public cancelSmartTransferTicket(ticketId: string, requestOptions?: RequestOptions): Promise<SmartTransfersTicketResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/cancel`, {}, requestOptions);
}

/**
Expand All @@ -1803,8 +1803,8 @@ export class FireblocksSDK {
* @param termId
* @param data
*/
public updateSmartTransferTicketTerms(ticketId: string, termId: string, data: SmartTransfersTicketTermPayload): Promise<SmartTransfersTicketTermResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/terms/${termId}`, data);
public updateSmartTransferTicketTerms(ticketId: string, termId: string, data: SmartTransfersTicketTermPayload, requestOptions?: RequestOptions): Promise<SmartTransfersTicketTermResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/terms/${termId}`, data, requestOptions);
}

/**
Expand All @@ -1813,8 +1813,8 @@ export class FireblocksSDK {
* @param termId
* @param data
*/
public fundSmartTransferTicketTerm(ticketId: string, termId: string, data: SmartTransfersTicketTermFundPayload): Promise<SmartTransfersTicketTermResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/terms/${termId}/fund`, data);
public fundSmartTransferTicketTerm(ticketId: string, termId: string, data: SmartTransfersTicketTermFundPayload, requestOptions?: RequestOptions): Promise<SmartTransfersTicketTermResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/terms/${termId}/fund`, data, requestOptions);
}

/**
Expand All @@ -1823,8 +1823,8 @@ export class FireblocksSDK {
* @param termId
* @param txHash
*/
public manuallyFundSmartTransferTicketTerms(ticketId: string, termId: string, txHash: string): Promise<SmartTransfersTicketTermResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/terms/${termId}/manually-fund`, { txHash });
public manuallyFundSmartTransferTicketTerms(ticketId: string, termId: string, txHash: string, requestOptions?: RequestOptions): Promise<SmartTransfersTicketTermResponse> {
return this.apiClient.issuePutRequest(`/v1/smart-transfers/${ticketId}/terms/${termId}/manually-fund`, { txHash }, requestOptions);
}

/**
Expand Down Expand Up @@ -1869,8 +1869,8 @@ export class FireblocksSDK {
* Update draft policy (TAP) [BETA]
* @param rules
*/
public async updateDraft(rules: TAP.PolicyRule[]): Promise<TAP.DraftReviewAndValidationResponse> {
return await this.apiClient.issuePutRequest(`/v1/tap/draft`, { rules });
public async updateDraft(rules: TAP.PolicyRule[], requestOptions?: RequestOptions): Promise<TAP.DraftReviewAndValidationResponse> {
return await this.apiClient.issuePutRequest(`/v1/tap/draft`, { rules }, requestOptions);
}

/**
Expand Down