Merge remote-tracking branch 'origin/master' into ncw-unspent-inputs

fireblocks · Apr 2, 2024 · 08235ce · 08235ce
2 parents ac12750 + ac9fe07
commit 08235ce
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,12 +2,25 @@
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
-#### [v5.23.0](https://github.com/fireblocks/fireblocks-sdk-js/compare/v5.21.0...v5.23.0)
+#### [v5.24.0](https://github.com/fireblocks/fireblocks-sdk-js/compare/v5.23.0...v5.24.0)
+
+> 1 April 2024
+
+- Add registerNewAsset function [`#264`](https://github.com/fireblocks/fireblocks-sdk-js/pull/264)
+
+#### [v5.23.0](https://github.com/fireblocks/fireblocks-sdk-js/compare/v5.22.0...v5.23.0)
 
 > 14 March 2024
 
 - Tokenization - Add displayName [`#262`](https://github.com/fireblocks/fireblocks-sdk-js/pull/262)
 
+#### [v5.22.0](https://github.com/fireblocks/fireblocks-sdk-js/compare/v5.21.0...v5.22.0)
+
+> 12 March 2024
+
+- Remove colon from supported screening URL [`#265`](https://github.com/fireblocks/fireblocks-sdk-js/pull/265)
+- Add supported screening assets route [`#259`](https://github.com/fireblocks/fireblocks-sdk-js/pull/259)
+
 #### [v5.21.0](https://github.com/fireblocks/fireblocks-sdk-js/compare/v5.20.0...v5.21.0)
 
 > 28 February 2024

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "fireblocks-sdk",
-  "version": "5.23.0",
+  "version": "5.24.0",
   "main": "dist/src/fireblocks-sdk.js",
   "types": "dist/src/fireblocks-sdk.d.ts",
   "scripts": {

diff --git a/src/fireblocks-sdk.ts b/src/fireblocks-sdk.ts
@@ -133,7 +133,11 @@ import {
     TokenLinkStatus,
     SupportedContractTemplateType,
     AbiFunction,
-    TokenOwnershipSpamUpdatePayload, ScreeningSupportedAssetResponse, ScreeningSupportedProviders, UnspentInputsResponse,
+    TokenOwnershipSpamUpdatePayload,
+    ScreeningSupportedAssetResponse,
+    ScreeningSupportedProviders,
+    RegisterAssetResponse,
+    UnspentInputsResponse,
 } from "./types";
 import { AxiosProxyConfig, AxiosResponse, InternalAxiosRequestConfig } from "axios";
 import { PIIEncryption } from "./pii-client";
@@ -859,6 +863,17 @@ export class FireblocksSDK {
         return await this.apiClient.issuePostRequest(`/v1/vault/accounts/${vaultAccountId}/${assetId}`, {}, requestOptions);
     }
 
+    /**
+     * Registers new asset
+     * @param blockchainId Native asset of blockchain
+     * @param address Asset contract address
+     * @param symbol Asset symbol
+     * @param requestOptions
+     */
+    public async registerNewAsset(blockchainId: string, address: string, symbol?: string, requestOptions?: RequestOptions): Promise<RegisterAssetResponse> {
+        return await this.apiClient.issuePostRequest(`/v1/assets`, { blockchainId, address, symbol }, requestOptions);
+    }
+
     /**
      * Retry to create a vault asset for a vault asset that failed
      * @param vaultAccountId The vault account ID

diff --git a/src/types.ts b/src/types.ts
@@ -65,6 +65,38 @@ export interface UnfreezeTransactionResponse {
     success: boolean;
 }
 
+export interface RegisterAssetResponse {
+    legacyId: string;
+    assetClass: AssetClass;
+    onchain: OnchainAsset;
+    metadata: AssetMetadata;
+}
+
+export enum AssetClass {
+    NATIVE = "NATIVE",
+    FT = "FT",
+    NFT = "NFT",
+    SFT = "SFT",
+}
+
+export interface OnchainAsset {
+    symbol: string;
+    name: string;
+    address?: string;
+    decimals: number;
+    standard: string;
+}
+
+export interface AssetMetadata {
+    scope: AssetScope;
+    deprecated: boolean;
+}
+
+export enum AssetScope {
+    GLOBAL = "Global",
+    LOCAL = "Local",
+}
+
 export interface VaultAssetResponse {
     id: string;
     address: string;