Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
fireblocks-sdk
Advanced tools
fireblocks-sdk - npm Package Compare versions
Comparing version 1.0.10 to 1.0.11
@@ -7,125 +7,134 @@ import { VaultAccountResponse, CreateTransactionResponse, TransactionArguments, AssetResponse, ExchangeResponse, TransactionResponse, TransactionFilter, CancelTransactionResponse, WalletContainerResponse, WalletAssetResponse, DepositAddressResponse, GenerateAddressResponse, OperationSuccessResponse } from "./types"; | ||
| /** | ||
| * Creates a new Fireblocks API Client. | ||
| * @param privateKey A string representation of your private key. | ||
| * @param apiKey Your api key. This is a uuid you received from Fireblocks. | ||
| * @param apiBaseUrl The fireblocks server URL. Leave empty to use the default server. | ||
| * Creates a new Fireblocks API Client | ||
| * @param privateKey A string representation of your private key | ||
| * @param apiKey Your api key. This is a uuid you received from Fireblocks | ||
| * @param apiBaseUrl The fireblocks server URL. Leave empty to use the default server | ||
| */ | ||
| constructor(privateKey: string, apiKey: string, apiBaseUrl?: string); | ||
| /** | ||
| * Gets all assets that are currently supported by Fireblocks. | ||
| * Gets all assets that are currently supported by Fireblocks | ||
| */ | ||
| getSupportedAssets(): Promise<VaultAccountResponse[]>; | ||
| /** | ||
| * Gets all vault accounts for your tenant. | ||
| * Gets all vault accounts for your tenant | ||
| */ | ||
| getVaultAccounts(): Promise<VaultAccountResponse[]>; | ||
| /** | ||
| * Gets a single vault account. | ||
| * @param vaultAccountId The vault account ID. | ||
| * Gets a single vault account | ||
| * @param vaultAccountId The vault account ID | ||
| */ | ||
| getVaultAccount(vaultAccountId: string): Promise<VaultAccountResponse>; | ||
| /** | ||
| * Gets a single vault account asset. | ||
| * @param vaultAccountId The vault account ID. | ||
| * @param assetId The ID of the asset to get. | ||
| * Gets a single vault account asset | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The ID of the asset to get | ||
| */ | ||
| getVaultAccountAsset(vaultAccountId: string, assetId: string): Promise<AssetResponse>; | ||
| /** | ||
| * Gets deposit addresses for an asset in a vault account. | ||
| * @param vaultAccountId The vault account ID. | ||
| * @param assetId The ID of the asset for which to get the deposit address. | ||
| * Gets deposit addresses for an asset in a vault account | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The ID of the asset for which to get the deposit address | ||
| */ | ||
| getDepositAddresses(vaultAccountId: string, assetId: string): Promise<DepositAddressResponse[]>; | ||
| /** | ||
| * Generates a new address for an asset in a vault account. | ||
| * @param vaultAccountId The vault account ID. | ||
| * @param assetId The ID of the asset for which to get the deposit address. | ||
| * Generates a new address for an asset in a vault account | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The ID of the asset for which to get the deposit address | ||
| */ | ||
| generateNewAddress(vaultAccountId: string, assetId: string, description?: string): Promise<GenerateAddressResponse>; | ||
| /** | ||
| * Gets all exchange accounts for your tenant. | ||
| * Sets the description of an existing address | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The ID of the asset for which to get the deposit address | ||
| * @param address The ID of the asset for which to get the deposit address | ||
| * @param tag The ID of the asset for which to get the deposit address | ||
| * @param description The description to set | ||
| */ | ||
| setAddressDescription(vaultAccountId: string, assetId: string, address: string, tag?: string, description?: string): Promise<GenerateAddressResponse>; | ||
| /** | ||
| * Gets all exchange accounts for your tenant | ||
| */ | ||
| getExchangeAccounts(): Promise<ExchangeResponse[]>; | ||
| /** | ||
| * Gets a single exchange account by ID. | ||
| * @param exchangeAccountId The exchange account ID. | ||
| * Gets a single exchange account by ID | ||
| * @param exchangeAccountId The exchange account ID | ||
| */ | ||
| getExchangeAccount(exchangeAccountId: string): Promise<ExchangeResponse>; | ||
| /** | ||
| * Transfer from a main exchange account to a subaccount. | ||
| * @param exchangeAccountId The exchange ID in Fireblocks. | ||
| * @param subaccountId The ID of the subaccount in the exchange. | ||
| * @param assetId The asset to transfer. | ||
| * @param amount The amount to transfer. | ||
| * Transfer from a main exchange account to a subaccount | ||
| * @param exchangeAccountId The exchange ID in Fireblocks | ||
| * @param subaccountId The ID of the subaccount in the exchange | ||
| * @param assetId The asset to transfer | ||
| * @param amount The amount to transfer | ||
| */ | ||
| transferToSubaccount(exchangeAccountId: string, subaccountId: string, assetId: string, amount: number): Promise<OperationSuccessResponse>; | ||
| /** | ||
| * Transfer from a subaccount to a main exchange account. | ||
| * @param exchangeAccountId The exchange ID in Fireblocks. | ||
| * @param subaccountId The ID of the subaccount in the exchange. | ||
| * @param assetId The asset to transfer. | ||
| * @param amount The amount to transfer. | ||
| * Transfer from a subaccount to a main exchange account | ||
| * @param exchangeAccountId The exchange ID in Fireblocks | ||
| * @param subaccountId The ID of the subaccount in the exchange | ||
| * @param assetId The asset to transfer | ||
| * @param amount The amount to transfer | ||
| */ | ||
| transferFromSubaccount(exchangeAccountId: string, subaccountId: string, assetId: string, amount: number): Promise<OperationSuccessResponse>; | ||
| /** | ||
| * Gets a list of transactions matching the given filter. | ||
| * @param filter.before Only gets transactions created before a given timestamp (in seconds). | ||
| * @param filter.after Only gets transactions created after a given timestamp (in seconds). | ||
| * @param filter.status Only gets transactions with the spcified status. | ||
| * Gets a list of transactions matching the given filter | ||
| * @param filter.before Only gets transactions created before a given timestamp (in seconds) | ||
| * @param filter.after Only gets transactions created after a given timestamp (in seconds) | ||
| * @param filter.status Only gets transactions with the spcified status | ||
| */ | ||
| getTransactions(filter: TransactionFilter): Promise<TransactionResponse[]>; | ||
| /** | ||
| * Gets all internal wallets for your tenant. | ||
| * Gets all internal wallets for your tenant | ||
| */ | ||
| getInternalWallets(): Promise<WalletContainerResponse[]>; | ||
| /** | ||
| * Gets a single internal wallet. | ||
| * @param walletId The internal wallet ID. | ||
| * Gets a single internal wallet | ||
| * @param walletId The internal wallet ID | ||
| */ | ||
| getInternalWallet(walletId: string): Promise<WalletContainerResponse>; | ||
| /** | ||
| * Gets a single internal wallet asset. | ||
| * @param walletId The internal wallet ID. | ||
| * @param assetId The asset ID. | ||
| * Gets a single internal wallet asset | ||
| * @param walletId The internal wallet ID | ||
| * @param assetId The asset ID | ||
| */ | ||
| getInternalWalletAsset(walletId: string, assetId: string): Promise<WalletAssetResponse>; | ||
| /** | ||
| * Gets all external wallets for your tenant. | ||
| * Gets all external wallets for your tenant | ||
| */ | ||
| getExternalWallets(): Promise<WalletContainerResponse[]>; | ||
| /** | ||
| * Gets a single external wallet. | ||
| * @param walletId The external wallet ID. | ||
| * Gets a single external wallet | ||
| * @param walletId The external wallet ID | ||
| */ | ||
| getExternalWallet(walletId: string): Promise<WalletContainerResponse>; | ||
| /** | ||
| * Gets a single external wallet asset. | ||
| * @param walletId The external wallet ID. | ||
| * @param assetId The asset ID. | ||
| * Gets a single external wallet asset | ||
| * @param walletId The external wallet ID | ||
| * @param assetId The asset ID | ||
| */ | ||
| getExternalWalletAsset(walletId: string, assetId: string): Promise<WalletAssetResponse>; | ||
| /** | ||
| * Gets detailed information for a single transaction. | ||
| * @param txId The transaction id to query. | ||
| * Gets detailed information for a single transaction | ||
| * @param txId The transaction id to query | ||
| */ | ||
| getTransactionById(txId: string): Promise<TransactionResponse>; | ||
| /** | ||
| * Cancels the selected transaction. | ||
| * @param txId The transaction id to cancel. | ||
| * Cancels the selected transaction | ||
| * @param txId The transaction id to cancel | ||
| */ | ||
| cancelTransactionById(txId: string): Promise<CancelTransactionResponse>; | ||
| /** | ||
| * Creates a new vault account. | ||
| * @param name A name for the new vault account. | ||
| * Creates a new vault account | ||
| * @param name A name for the new vault account | ||
| */ | ||
| createVaultAccount(name: string): Promise<VaultAccountResponse>; | ||
| /** | ||
| * Updates a vault account. | ||
| * @param name A new name for the vault account. | ||
| * Updates a vault account | ||
| * @param name A new name for the vault account | ||
| */ | ||
| updateVaultAccount(vaultAccountId: string, name: string): Promise<VaultAccountResponse>; | ||
| /** | ||
| * Creates a new asset within an existing vault account. | ||
| * @param vaultAccountId The vault account ID. | ||
| * @param assetId The asset to add. | ||
| * Creates a new asset within an existing vault account | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The asset to add | ||
| */ | ||
@@ -135,26 +144,26 @@ createVaultAsset(vaultAccountId: string, assetId: string): Promise<AssetResponse>; | ||
| /** | ||
| * Creates a new internal wallet. | ||
| * @param name A name for the new internal wallet. | ||
| * Creates a new internal wallet | ||
| * @param name A name for the new internal wallet | ||
| */ | ||
| createInternalWallet(name: string): Promise<WalletContainerResponse>; | ||
| /** | ||
| * Creates a new asset within an exiting external wallet. | ||
| * @param walletId The wallet id. | ||
| * @param assetId The asset to add. | ||
| * @param address The wallet address. | ||
| * @param tag (for ripple only) The ripple account tag. | ||
| * Creates a new asset within an exiting external wallet | ||
| * @param walletId The wallet id | ||
| * @param assetId The asset to add | ||
| * @param address The wallet address | ||
| * @param tag (for ripple only) The ripple account tag | ||
| */ | ||
| createExternalWalletAsset(walletId: string, assetId: string, address: string, tag?: string): Promise<WalletAssetResponse>; | ||
| /** | ||
| * Creates a new asset within an exiting internal wallet. | ||
| * @param walletId The wallet id. | ||
| * @param assetId The asset to add. | ||
| * @param address The wallet address. | ||
| * @param tag (for ripple only) The ripple account tag. | ||
| * Creates a new asset within an exiting internal wallet | ||
| * @param walletId The wallet id | ||
| * @param assetId The asset to add | ||
| * @param address The wallet address | ||
| * @param tag (for ripple only) The ripple account tag | ||
| */ | ||
| createInternalWalletAsset(walletId: string, assetId: string, address: string, tag?: string): Promise<WalletAssetResponse>; | ||
| /** | ||
| * Creates a new transaction with the specified options. | ||
| * Creates a new transaction with the specified options | ||
| */ | ||
| createTransaction(options: TransactionArguments): Promise<CreateTransactionResponse>; | ||
| } |
@@ -20,6 +20,6 @@ "use strict"; | ||
| /** | ||
| * Creates a new Fireblocks API Client. | ||
| * @param privateKey A string representation of your private key. | ||
| * @param apiKey Your api key. This is a uuid you received from Fireblocks. | ||
| * @param apiBaseUrl The fireblocks server URL. Leave empty to use the default server. | ||
| * Creates a new Fireblocks API Client | ||
| * @param privateKey A string representation of your private key | ||
| * @param apiKey Your api key. This is a uuid you received from Fireblocks | ||
| * @param apiBaseUrl The fireblocks server URL. Leave empty to use the default server | ||
| */ | ||
@@ -34,3 +34,3 @@ constructor(privateKey, apiKey, apiBaseUrl = "https://api.fireblocks.io") { | ||
| /** | ||
| * Gets all assets that are currently supported by Fireblocks. | ||
| * Gets all assets that are currently supported by Fireblocks | ||
| */ | ||
@@ -43,3 +43,3 @@ getSupportedAssets() { | ||
| /** | ||
| * Gets all vault accounts for your tenant. | ||
| * Gets all vault accounts for your tenant | ||
| */ | ||
@@ -52,4 +52,4 @@ getVaultAccounts() { | ||
| /** | ||
| * Gets a single vault account. | ||
| * @param vaultAccountId The vault account ID. | ||
| * Gets a single vault account | ||
| * @param vaultAccountId The vault account ID | ||
| */ | ||
@@ -62,5 +62,5 @@ getVaultAccount(vaultAccountId) { | ||
| /** | ||
| * Gets a single vault account asset. | ||
| * @param vaultAccountId The vault account ID. | ||
| * @param assetId The ID of the asset to get. | ||
| * Gets a single vault account asset | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The ID of the asset to get | ||
| */ | ||
@@ -73,5 +73,5 @@ getVaultAccountAsset(vaultAccountId, assetId) { | ||
| /** | ||
| * Gets deposit addresses for an asset in a vault account. | ||
| * @param vaultAccountId The vault account ID. | ||
| * @param assetId The ID of the asset for which to get the deposit address. | ||
| * Gets deposit addresses for an asset in a vault account | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The ID of the asset for which to get the deposit address | ||
| */ | ||
@@ -84,5 +84,5 @@ getDepositAddresses(vaultAccountId, assetId) { | ||
| /** | ||
| * Generates a new address for an asset in a vault account. | ||
| * @param vaultAccountId The vault account ID. | ||
| * @param assetId The ID of the asset for which to get the deposit address. | ||
| * Generates a new address for an asset in a vault account | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The ID of the asset for which to get the deposit address | ||
| */ | ||
@@ -95,4 +95,17 @@ generateNewAddress(vaultAccountId, assetId, description) { | ||
| /** | ||
| * Gets all exchange accounts for your tenant. | ||
| * Sets the description of an existing address | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The ID of the asset for which to get the deposit address | ||
| * @param address The ID of the asset for which to get the deposit address | ||
| * @param tag The ID of the asset for which to get the deposit address | ||
| * @param description The description to set | ||
| */ | ||
| setAddressDescription(vaultAccountId, assetId, address, tag, description) { | ||
| return __awaiter(this, void 0, void 0, function* () { | ||
| return yield this.apiClient.issuePutRequest(`/v1/vault/accounts/${vaultAccountId}/${assetId}/addresses/${address}:${tag || ""}`, { description: description || "" }); | ||
| }); | ||
| } | ||
| /** | ||
| * Gets all exchange accounts for your tenant | ||
| */ | ||
| getExchangeAccounts() { | ||
@@ -104,4 +117,4 @@ return __awaiter(this, void 0, void 0, function* () { | ||
| /** | ||
| * Gets a single exchange account by ID. | ||
| * @param exchangeAccountId The exchange account ID. | ||
| * Gets a single exchange account by ID | ||
| * @param exchangeAccountId The exchange account ID | ||
| */ | ||
@@ -114,7 +127,7 @@ getExchangeAccount(exchangeAccountId) { | ||
| /** | ||
| * Transfer from a main exchange account to a subaccount. | ||
| * @param exchangeAccountId The exchange ID in Fireblocks. | ||
| * @param subaccountId The ID of the subaccount in the exchange. | ||
| * @param assetId The asset to transfer. | ||
| * @param amount The amount to transfer. | ||
| * Transfer from a main exchange account to a subaccount | ||
| * @param exchangeAccountId The exchange ID in Fireblocks | ||
| * @param subaccountId The ID of the subaccount in the exchange | ||
| * @param assetId The asset to transfer | ||
| * @param amount The amount to transfer | ||
| */ | ||
@@ -131,7 +144,7 @@ transferToSubaccount(exchangeAccountId, subaccountId, assetId, amount) { | ||
| /** | ||
| * Transfer from a subaccount to a main exchange account. | ||
| * @param exchangeAccountId The exchange ID in Fireblocks. | ||
| * @param subaccountId The ID of the subaccount in the exchange. | ||
| * @param assetId The asset to transfer. | ||
| * @param amount The amount to transfer. | ||
| * Transfer from a subaccount to a main exchange account | ||
| * @param exchangeAccountId The exchange ID in Fireblocks | ||
| * @param subaccountId The ID of the subaccount in the exchange | ||
| * @param assetId The asset to transfer | ||
| * @param amount The amount to transfer | ||
| */ | ||
@@ -148,6 +161,6 @@ transferFromSubaccount(exchangeAccountId, subaccountId, assetId, amount) { | ||
| /** | ||
| * Gets a list of transactions matching the given filter. | ||
| * @param filter.before Only gets transactions created before a given timestamp (in seconds). | ||
| * @param filter.after Only gets transactions created after a given timestamp (in seconds). | ||
| * @param filter.status Only gets transactions with the spcified status. | ||
| * Gets a list of transactions matching the given filter | ||
| * @param filter.before Only gets transactions created before a given timestamp (in seconds) | ||
| * @param filter.after Only gets transactions created after a given timestamp (in seconds) | ||
| * @param filter.status Only gets transactions with the spcified status | ||
| */ | ||
@@ -160,3 +173,3 @@ getTransactions(filter) { | ||
| /** | ||
| * Gets all internal wallets for your tenant. | ||
| * Gets all internal wallets for your tenant | ||
| */ | ||
@@ -169,4 +182,4 @@ getInternalWallets() { | ||
| /** | ||
| * Gets a single internal wallet. | ||
| * @param walletId The internal wallet ID. | ||
| * Gets a single internal wallet | ||
| * @param walletId The internal wallet ID | ||
| */ | ||
@@ -179,5 +192,5 @@ getInternalWallet(walletId) { | ||
| /** | ||
| * Gets a single internal wallet asset. | ||
| * @param walletId The internal wallet ID. | ||
| * @param assetId The asset ID. | ||
| * Gets a single internal wallet asset | ||
| * @param walletId The internal wallet ID | ||
| * @param assetId The asset ID | ||
| */ | ||
@@ -190,3 +203,3 @@ getInternalWalletAsset(walletId, assetId) { | ||
| /** | ||
| * Gets all external wallets for your tenant. | ||
| * Gets all external wallets for your tenant | ||
| */ | ||
@@ -199,4 +212,4 @@ getExternalWallets() { | ||
| /** | ||
| * Gets a single external wallet. | ||
| * @param walletId The external wallet ID. | ||
| * Gets a single external wallet | ||
| * @param walletId The external wallet ID | ||
| */ | ||
@@ -209,5 +222,5 @@ getExternalWallet(walletId) { | ||
| /** | ||
| * Gets a single external wallet asset. | ||
| * @param walletId The external wallet ID. | ||
| * @param assetId The asset ID. | ||
| * Gets a single external wallet asset | ||
| * @param walletId The external wallet ID | ||
| * @param assetId The asset ID | ||
| */ | ||
@@ -220,4 +233,4 @@ getExternalWalletAsset(walletId, assetId) { | ||
| /** | ||
| * Gets detailed information for a single transaction. | ||
| * @param txId The transaction id to query. | ||
| * Gets detailed information for a single transaction | ||
| * @param txId The transaction id to query | ||
| */ | ||
@@ -230,4 +243,4 @@ getTransactionById(txId) { | ||
| /** | ||
| * Cancels the selected transaction. | ||
| * @param txId The transaction id to cancel. | ||
| * Cancels the selected transaction | ||
| * @param txId The transaction id to cancel | ||
| */ | ||
@@ -240,4 +253,4 @@ cancelTransactionById(txId) { | ||
| /** | ||
| * Creates a new vault account. | ||
| * @param name A name for the new vault account. | ||
| * Creates a new vault account | ||
| * @param name A name for the new vault account | ||
| */ | ||
@@ -253,4 +266,4 @@ createVaultAccount(name) { | ||
| /** | ||
| * Updates a vault account. | ||
| * @param name A new name for the vault account. | ||
| * Updates a vault account | ||
| * @param name A new name for the vault account | ||
| */ | ||
@@ -266,5 +279,5 @@ updateVaultAccount(vaultAccountId, name) { | ||
| /** | ||
| * Creates a new asset within an existing vault account. | ||
| * @param vaultAccountId The vault account ID. | ||
| * @param assetId The asset to add. | ||
| * Creates a new asset within an existing vault account | ||
| * @param vaultAccountId The vault account ID | ||
| * @param assetId The asset to add | ||
| */ | ||
@@ -285,4 +298,4 @@ createVaultAsset(vaultAccountId, assetId) { | ||
| /** | ||
| * Creates a new internal wallet. | ||
| * @param name A name for the new internal wallet. | ||
| * Creates a new internal wallet | ||
| * @param name A name for the new internal wallet | ||
| */ | ||
@@ -298,7 +311,7 @@ createInternalWallet(name) { | ||
| /** | ||
| * Creates a new asset within an exiting external wallet. | ||
| * @param walletId The wallet id. | ||
| * @param assetId The asset to add. | ||
| * @param address The wallet address. | ||
| * @param tag (for ripple only) The ripple account tag. | ||
| * Creates a new asset within an exiting external wallet | ||
| * @param walletId The wallet id | ||
| * @param assetId The asset to add | ||
| * @param address The wallet address | ||
| * @param tag (for ripple only) The ripple account tag | ||
| */ | ||
@@ -316,7 +329,7 @@ createExternalWalletAsset(walletId, assetId, address, tag) { | ||
| /** | ||
| * Creates a new asset within an exiting internal wallet. | ||
| * @param walletId The wallet id. | ||
| * @param assetId The asset to add. | ||
| * @param address The wallet address. | ||
| * @param tag (for ripple only) The ripple account tag. | ||
| * Creates a new asset within an exiting internal wallet | ||
| * @param walletId The wallet id | ||
| * @param assetId The asset to add | ||
| * @param address The wallet address | ||
| * @param tag (for ripple only) The ripple account tag | ||
| */ | ||
@@ -334,3 +347,3 @@ createInternalWalletAsset(walletId, assetId, address, tag) { | ||
| /** | ||
| * Creates a new transaction with the specified options. | ||
| * Creates a new transaction with the specified options | ||
| */ | ||
@@ -337,0 +350,0 @@ createTransaction(options) { |
| { | ||
| "name": "fireblocks-sdk", | ||
| "version": "1.0.10", | ||
| "version": "1.0.11", | ||
| "main": "dist/fireblocks-sdk.js", | ||
@@ -5,0 +5,0 @@ "types": "dist/fireblocks-sdk.d.ts", |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.92%
49368
- Lines of code
- increased by2.46%
915
No dependency changes