Support Freeze Tenant via API

.nvmrc

@@ -0,0 +1 @@
+18

CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
+#### [v5.5.1](https://github.com/fireblocks/fireblocks-sdk-js/compare/v5.5.0...v5.5.1)
+
+> 23 August 2023
+
+- Rename NCW base path [`#198`](https://github.com/fireblocks/fireblocks-sdk-js/pull/198)
+
+#### [v5.5.0](https://github.com/fireblocks/fireblocks-sdk-js/compare/v5.4.0...v5.5.0)
+
+> 22 August 2023
+
+- fix: add NCW methods [`#197`](https://github.com/fireblocks/fireblocks-sdk-js/pull/197)
+- add NCW feature [`#192`](https://github.com/fireblocks/fireblocks-sdk-js/pull/192)
+- changed return type to pending instead of TokenLink [`#188`](https://github.com/fireblocks/fireblocks-sdk-js/pull/188)
+
+#### [v5.4.0](https://github.com/fireblocks/fireblocks-sdk-js/compare/v5.3.1...v5.4.0)
+
+> 7 August 2023
+
+- Support users groups crud [`#179`](https://github.com/fireblocks/fireblocks-sdk-js/pull/179)
+
 #### [v5.3.1](https://github.com/fireblocks/fireblocks-sdk-js/compare/v5.3.0...v5.3.1)
 
 > 2 August 2023

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fireblocks-sdk",
-  "version": "5.3.1",
+  "version": "5.5.1",
   "main": "dist/src/fireblocks-sdk.js",
   "types": "dist/src/fireblocks-sdk.d.ts",
   "scripts": {

src/api-client.ts

@@ -65,6 +65,12 @@ export class ApiClient {
         if (idempotencyKey) {
             headers["Idempotency-Key"] = idempotencyKey;
         }
+
+        const ncwWalletId = requestOptions?.ncw?.walletId;
+        if (ncwWalletId) {
+            headers["X-End-User-Wallet-Id"] = ncwWalletId;
+        }
+
         const response = await this.axiosInstance.post<T>(path, body, {headers});
         return response.data;
     }

src/fireblocks-sdk.ts

@@ -68,6 +68,7 @@ import {
     SettlementRequest,
     SettlementResponse,
     GetNFTsFilter,
+    PeerType,
     PublicKeyInformation,
     DropTransactionResponse,
     TokenLink,
@@ -91,9 +92,12 @@ import {
     SmartTransfersTicketTermPayload,
     SmartTransfersTicketTermFundPayload,
     SmartTransfersTicketTermResponse,
+    UsersGroup, PendingTokenLinkDto,
 } from "./types";
 import { AxiosProxyConfig, AxiosResponse } from "axios";
 import { PIIEncryption } from "./pii-client";
+import { NcwApiClient } from "./ncw-api-client";
+import { NcwSdk } from "./ncw-sdk";
 
 export * from "./types";
 
@@ -132,6 +136,8 @@ export class FireblocksSDK {
     private readonly authProvider: IAuthProvider;
     private readonly apiBaseUrl: string;
     private readonly apiClient: ApiClient;
+    private readonly apiNcw: NcwApiClient;
+
     private piiClient: PIIEncryption;
 
     /**
@@ -154,6 +160,18 @@ export class FireblocksSDK {
         if (sdkOptions?.travelRuleOptions) {
             this.piiClient = new PIIEncryption(sdkOptions.travelRuleOptions);
         }
+
+        this.apiNcw = new NcwApiClient(this.apiClient);
+    }
+
+    /**
+     * NCW API Namespace
+     *
+     * @readonly
+     * @type {NcwSdk}
+     */
+    public get NCW(): NcwSdk {
+        return this.apiNcw;
     }
 
     /**
@@ -797,11 +815,18 @@ export class FireblocksSDK {
      * Creates a new transaction with the specified options
      */
     public async createTransaction(transactionArguments: TransactionArguments, requestOptions?: RequestOptions, travelRuleEncryptionOptions?: TravelRuleEncryptionOptions): Promise<CreateTransactionResponse> {
+        const opts = { ...requestOptions };
+
         if (transactionArguments?.travelRuleMessage) {
             transactionArguments = await this.piiClient.hybridEncode(transactionArguments, travelRuleEncryptionOptions);
         }
 
-        return await this.apiClient.issuePostRequest("/v1/transactions", transactionArguments, requestOptions);
+        if (transactionArguments.source?.type === PeerType.END_USER_WALLET && !opts.ncw?.walletId) {
+            const { walletId } = transactionArguments.source;
+            opts.ncw = { ...opts.ncw, walletId };
+        }
+
+        return await this.apiClient.issuePostRequest("/v1/transactions", transactionArguments, opts);
     }
 
     /**
@@ -1123,6 +1148,50 @@ export class FireblocksSDK {
         return await this.apiClient.issueGetRequest("/v1/users");
     }
 
+    /**
+     * Gets all Users Groups for your tenant
+     */
+    public async getUsersGroups(): Promise<UsersGroup[]> {
+        return await this.apiClient.issueGetRequest("/v1/users_groups");
+    }
+
+    /**
+     * Gets a Users Group by ID
+     * @param id The ID of the User
+     */
+    public async getUsersGroup(id: string): Promise<UsersGroup> {
+        return await this.apiClient.issueGetRequest(`/v1/users_groups/${id}`);
+    }
+
+    /**
+     * Creates a new Users Group
+     * @param name The name of the Users Group
+     * @param memberIds The members of the Users Group
+     */
+    public async createUserGroup(groupName: string, memberIds?: string[]): Promise<UsersGroup> {
+        const body = { groupName, memberIds };
+        return await this.apiClient.issuePostRequest("/v1/users_groups", body);
+    }
+
+    /**
+     * Updates a Users Group
+     * @param id The ID of the Users Group
+     * @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> {
+        const body = { groupName, memberIds };
+        return await this.apiClient.issuePutRequest(`/v1/users_groups/${id}`, body);
+    }
+
+    /**
+     * Deletes a Users Group
+     * @param id The ID of the Users Group
+     */
+    public async deleteUserGroup(id: string): Promise<void> {
+        return await this.apiClient.issueDeleteRequest(`/v1/users_groups/${id}`);
+    }
+
     /**
      * Get off exchange accounts
      */
@@ -1450,8 +1519,8 @@ export class FireblocksSDK {
      * Issue a new token and link it to the tenant
      * @param request
      */
-    public async issueNewToken(request: IssueTokenRequest): Promise<TokenLink> {
-        return await this.apiClient.issuePostRequest(`/v1/tokenization/tokens/`, request);
+    public async issueNewToken(request: IssueTokenRequest): Promise<PendingTokenLinkDto> {
+        return await this.apiClient.issuePostRequest(`/v1/tokenization/tokens`, request);
     }
 
     /**

src/ncw-api-client.ts

@@ -0,0 +1,135 @@
+import { ApiClient } from "./api-client";
+import {
+    AssetResponse,
+    Web3PagedResponse,
+    NCW,
+} from "./types";
+import { NcwSdk } from "./ncw-sdk";
+
+export class NcwApiClient implements NcwSdk {
+    private readonly NCW_BASE_PATH = "/v1/ncw/wallets";
+
+    constructor(private readonly apiClient: ApiClient) { }
+
+    public async createWallet(): Promise<{ walletId: string; enabled: boolean; }> {
+        return await this.apiClient.issuePostRequest(
+            `${this.NCW_BASE_PATH}`,
+            {});
+    }
+
+    public async getWallet(walletId: string): Promise<{ walletId: string; enabled: boolean; }> {
+        return await this.apiClient.issueGetRequest(
+            `${this.NCW_BASE_PATH}/${walletId}`);
+    }
+
+    public async enableWallet(walletId: string, enabled: boolean): Promise<void> {
+        return await this.apiClient.issuePutRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/enable`,
+            { enabled });
+    }
+
+    public async getWalletDevices(walletId: string): Promise<NCW.Device> {
+        return await this.apiClient.issueGetRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/devices/`);
+    }
+
+    public async enableWalletDevice(walletId: string, deviceId: string, enabled: boolean): Promise<void> {
+        return await this.apiClient.issuePutRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/devices/${deviceId}/enable`,
+            { enabled });
+    }
+
+    public async invokeWalletRpc(walletId: string, deviceId: string, payload: string): Promise<{ result: string; } | { error: { message: string; code?: number; }; }> {
+        return await this.apiClient.issuePostRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/devices/${deviceId}/invoke`,
+            { payload });
+    }
+
+    public async createWalletAccount(walletId: string): Promise<{
+        walletId: string;
+        accountId: number;
+    }> {
+        return await this.apiClient.issuePostRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/accounts`,
+            {});
+    }
+
+    public async getWallets({ pageCursor, pageSize, sort, order }: NCW.GetWalletsPayload = {}): Promise<Web3PagedResponse<NCW.WalletInfo>> {
+        const params = new URLSearchParams({
+            ...(pageCursor && { pageCursor }),
+            ...(pageSize && { pageSize: pageSize.toString() }),
+            ...(sort && { sort }),
+            ...(order && { order }),
+        });
+
+        return await this.apiClient.issueGetRequest(`${this.NCW_BASE_PATH}?${params.toString()}`);
+    }
+
+    public async getWalletAccounts(walletId: string, { pageCursor, pageSize, sort, order }: NCW.GetWalletsPayload = {}): Promise<Web3PagedResponse<{
+        walletId: string;
+        accountId: number;
+    }>> {
+        const params = new URLSearchParams({
+            ...(pageCursor && { pageCursor }),
+            ...(pageSize && { pageSize: pageSize.toString() }),
+            ...(sort && { sort }),
+            ...(order && { order }),
+        });
+
+        return await this.apiClient.issueGetRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/accounts?${params.toString()}`);
+    }
+
+    public async getWalletAccount(walletId: string, accountId: number): Promise<{
+        walletId: string;
+        accountId: number;
+    }> {
+        return await this.apiClient.issueGetRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/accounts/${accountId}`);
+    }
+
+    public async getWalletAssets(walletId: string, accountId: number, { pageCursor, pageSize, sort, order }: NCW.GetWalletAssetsPayload = {}): Promise<Web3PagedResponse<NCW.WalletAssetResponse>> {
+        const params = new URLSearchParams({
+            ...(pageCursor && { pageCursor }),
+            ...(pageSize && { pageSize: pageSize.toString() }),
+            ...(sort && { sort }),
+            ...(order && { order }),
+        });
+
+        return await this.apiClient.issueGetRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/accounts/${accountId}/assets?${params.toString()}`);
+    }
+
+    public async getWalletAsset(walletId: string, accountId: number, assetId: string): Promise<NCW.WalletAssetResponse> {
+        return await this.apiClient.issueGetRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/accounts/${accountId}/assets/${assetId}`);
+    }
+
+    public async activateWalletAsset(walletId: string, accountId: number, assetId: string): Promise<NCW.WalletAssetAddress> {
+        return await this.apiClient.issuePostRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/accounts/${accountId}/assets/${assetId}`, {});
+    }
+
+    public async getWalletAssetAddresses(walletId: string, accountId: number, assetId: string, { pageCursor, pageSize, sort, order }: NCW.GetWalletAddressesPayload = {}): Promise<Web3PagedResponse<NCW.WalletAssetAddress>> {
+        const params = new URLSearchParams({
+            ...(pageCursor && { pageCursor }),
+            ...(pageSize && { pageSize: pageSize.toString() }),
+            ...(sort && { sort }),
+            ...(order && { order }),
+        });
+
+        return await this.apiClient.issueGetRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/accounts/${accountId}/assets/${assetId}/addresses?${params.toString()}`);
+    }
+
+    public async getWalletAssetBalance(walletId: string, accountId: number, assetId: string): Promise<AssetResponse> {
+        return await this.apiClient.issueGetRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/accounts/${accountId}/assets/${assetId}/balance`);
+    }
+
+    public async refreshWalletAssetBalance(walletId: string, accountId: number, assetId: string): Promise<AssetResponse> {
+        return await this.apiClient.issuePutRequest(
+            `${this.NCW_BASE_PATH}/${walletId}/accounts/${accountId}/assets/${assetId}/balance`,
+            {});
+    }
+}