@sereel/sdk 0.1.6 → 0.2.0

package/dist/index.d.cts

@@ -19,10 +19,7 @@ interface NetworkDetails {
     native_currency: NativeCurrency;
     rpc_endpoint: string;
     explorer_urls: string[];
-    can_deploy_cmtat_token: boolean;
-    can_deploy_trex_token: boolean;
     is_testnet: boolean;
-    is_supported: boolean;
 }
 interface SdkTokenProspectus {
     name: string;
@@ -53,8 +50,11 @@ interface SdkSecurityDetails {
     admin: string;
     icon_url: string | null;
     prospectus: SdkTokenProspectus | null;
+    issuer: SdkIssuerSummary | null;
+    book: SdkBookSummary | null;
     partners: SdkTokenPartner[] | null;
     rule_engine: SdkRuleEngineSummary | null;
+    network: NetworkDetails;
     created_at: string | null;
     trex_claim_topics: number[] | null;
     trex_issuers: string[] | null;
@@ -75,8 +75,6 @@ interface SdkFundConfig {
     exit_fee_bps: string;
     dealing_mode: number;
     redemption_gate_bps: string;
-    protocol_subscription_fee_bps: string | null;
-    protocol_fee_recipient: string | null;
     management_fee_bps_per_annum: string;
 }
 type IssuanceStatus = "OPEN" | "CLOSED" | "FINALIZED" | "SETTLED" | "CANCELLED";
@@ -86,13 +84,8 @@ interface SdkBookSummary {
     name: string | null;
     book_type: string | null;
     token_address: string;
-    fund_token: string;
     network_id: string;
-    admin_wallet: string | null;
-    manager_wallet: string | null;
     settlement_token: string;
-    factory_address: string | null;
-    deployment_txn_hash: string | null;
     order_book_address: string;
     fund_address: string;
     fund_id: string;
@@ -100,20 +93,13 @@ interface SdkBookSummary {
     fund_config: SdkFundConfig;
     status: IssuanceStatus;
     created_at: string | null;
-    updated_at: string | null;
-}
-interface SdkAssetRecord {
-    security: SdkSecurityDetails;
-    issuer: SdkIssuerSummary;
-    books: SdkBookSummary[];
-    network: NetworkDetails;
 }
 interface SdkAssetsResponse {
-    data: SdkAssetRecord[];
+    data: SdkSecurityDetails[];
     count: number;
 }
 interface SdkAssetResponse {
-    data: SdkAssetRecord;
+    data: SdkSecurityDetails;
 }
 interface SereelSdkClient {
     getAssets(): Promise<SdkAssetsResponse>;
@@ -159,4 +145,4 @@ declare class TimeoutError extends SereelSdkError {
 declare class MalformedResponseError extends SereelSdkError {
 }
 
-export { type ClientConfig, ENVIRONMENT_BASE_URLS, ForbiddenError, HttpError, InvalidConfigurationError, type IssuanceStatus, MalformedResponseError, type NativeCurrency, type NetworkDetails, NetworkError, NotFoundError, RateLimitError, type SdkAssetRecord, type SdkAssetResponse, type SdkAssetsResponse, type SdkBookSummary, type SdkFundConfig, type SdkIssuerSummary, type SdkRuleEngineSummary, type SdkRuleSummary, type SdkSecurityDetails, type SdkTokenPartner, type SdkTokenProspectus, type SereelEnvironment, type SereelSdkClient, SereelSdkError, ServerError, TimeoutError, UnauthorizedError, createClient, resolveBaseUrl };
+export { type ClientConfig, ENVIRONMENT_BASE_URLS, ForbiddenError, HttpError, InvalidConfigurationError, type IssuanceStatus, MalformedResponseError, type NativeCurrency, type NetworkDetails, NetworkError, NotFoundError, RateLimitError, type SdkAssetResponse, type SdkAssetsResponse, type SdkBookSummary, type SdkFundConfig, type SdkIssuerSummary, type SdkRuleEngineSummary, type SdkRuleSummary, type SdkSecurityDetails, type SdkTokenPartner, type SdkTokenProspectus, type SereelEnvironment, type SereelSdkClient, SereelSdkError, ServerError, TimeoutError, UnauthorizedError, createClient, resolveBaseUrl };

package/dist/index.d.ts

@@ -19,10 +19,7 @@ interface NetworkDetails {
     native_currency: NativeCurrency;
     rpc_endpoint: string;
     explorer_urls: string[];
-    can_deploy_cmtat_token: boolean;
-    can_deploy_trex_token: boolean;
     is_testnet: boolean;
-    is_supported: boolean;
 }
 interface SdkTokenProspectus {
     name: string;
@@ -53,8 +50,11 @@ interface SdkSecurityDetails {
     admin: string;
     icon_url: string | null;
     prospectus: SdkTokenProspectus | null;
+    issuer: SdkIssuerSummary | null;
+    book: SdkBookSummary | null;
     partners: SdkTokenPartner[] | null;
     rule_engine: SdkRuleEngineSummary | null;
+    network: NetworkDetails;
     created_at: string | null;
     trex_claim_topics: number[] | null;
     trex_issuers: string[] | null;
@@ -75,8 +75,6 @@ interface SdkFundConfig {
     exit_fee_bps: string;
     dealing_mode: number;
     redemption_gate_bps: string;
-    protocol_subscription_fee_bps: string | null;
-    protocol_fee_recipient: string | null;
     management_fee_bps_per_annum: string;
 }
 type IssuanceStatus = "OPEN" | "CLOSED" | "FINALIZED" | "SETTLED" | "CANCELLED";
@@ -86,13 +84,8 @@ interface SdkBookSummary {
     name: string | null;
     book_type: string | null;
     token_address: string;
-    fund_token: string;
     network_id: string;
-    admin_wallet: string | null;
-    manager_wallet: string | null;
     settlement_token: string;
-    factory_address: string | null;
-    deployment_txn_hash: string | null;
     order_book_address: string;
     fund_address: string;
     fund_id: string;
@@ -100,20 +93,13 @@ interface SdkBookSummary {
     fund_config: SdkFundConfig;
     status: IssuanceStatus;
     created_at: string | null;
-    updated_at: string | null;
-}
-interface SdkAssetRecord {
-    security: SdkSecurityDetails;
-    issuer: SdkIssuerSummary;
-    books: SdkBookSummary[];
-    network: NetworkDetails;
 }
 interface SdkAssetsResponse {
-    data: SdkAssetRecord[];
+    data: SdkSecurityDetails[];
     count: number;
 }
 interface SdkAssetResponse {
-    data: SdkAssetRecord;
+    data: SdkSecurityDetails;
 }
 interface SereelSdkClient {
     getAssets(): Promise<SdkAssetsResponse>;
@@ -159,4 +145,4 @@ declare class TimeoutError extends SereelSdkError {
 declare class MalformedResponseError extends SereelSdkError {
 }
 
-export { type ClientConfig, ENVIRONMENT_BASE_URLS, ForbiddenError, HttpError, InvalidConfigurationError, type IssuanceStatus, MalformedResponseError, type NativeCurrency, type NetworkDetails, NetworkError, NotFoundError, RateLimitError, type SdkAssetRecord, type SdkAssetResponse, type SdkAssetsResponse, type SdkBookSummary, type SdkFundConfig, type SdkIssuerSummary, type SdkRuleEngineSummary, type SdkRuleSummary, type SdkSecurityDetails, type SdkTokenPartner, type SdkTokenProspectus, type SereelEnvironment, type SereelSdkClient, SereelSdkError, ServerError, TimeoutError, UnauthorizedError, createClient, resolveBaseUrl };
+export { type ClientConfig, ENVIRONMENT_BASE_URLS, ForbiddenError, HttpError, InvalidConfigurationError, type IssuanceStatus, MalformedResponseError, type NativeCurrency, type NetworkDetails, NetworkError, NotFoundError, RateLimitError, type SdkAssetResponse, type SdkAssetsResponse, type SdkBookSummary, type SdkFundConfig, type SdkIssuerSummary, type SdkRuleEngineSummary, type SdkRuleSummary, type SdkSecurityDetails, type SdkTokenPartner, type SdkTokenProspectus, type SereelEnvironment, type SereelSdkClient, SereelSdkError, ServerError, TimeoutError, UnauthorizedError, createClient, resolveBaseUrl };

package/dist/index.js

@@ -195,9 +195,6 @@ function isString(value) {
 function isNullableString(value) {
   return typeof value === "string" || value === null;
 }
-function isOptionalNullableString(value) {
-  return typeof value === "string" || value === null || value === void 0;
-}
 function isFiniteNumber(value) {
   return typeof value === "number" && Number.isFinite(value);
 }
@@ -286,79 +283,6 @@ function isRuleEngineSummary(value, ctx, path) {
   }
   return true;
 }
-function isSecurityDetails(value, ctx, path) {
-  const v = asRecord(value);
-  if (!ctx.check(v !== void 0, path, "object", value)) return false;
-  ctx.check(
-    isString(v.token_address),
-    `${path}.token_address`,
-    "string",
-    v.token_address
-  );
-  ctx.check(
-    isString(v.token_name),
-    `${path}.token_name`,
-    "string",
-    v.token_name
-  );
-  ctx.check(
-    isString(v.token_symbol),
-    `${path}.token_symbol`,
-    "string",
-    v.token_symbol
-  );
-  ctx.check(
-    isString(v.token_decimal),
-    `${path}.token_decimal`,
-    "string",
-    v.token_decimal
-  );
-  ctx.check(
-    isString(v.network_id),
-    `${path}.network_id`,
-    "string",
-    v.network_id
-  );
-  ctx.check(
-    isString(v.token_type),
-    `${path}.token_type`,
-    "string",
-    v.token_type
-  );
-  ctx.check(isString(v.admin), `${path}.admin`, "string", v.admin);
-  ctx.check(
-    isNullableString(v.icon_url),
-    `${path}.icon_url`,
-    "string | null",
-    v.icon_url
-  );
-  ctx.check(
-    isNullableString(v.created_at),
-    `${path}.created_at`,
-    "string | null",
-    v.created_at
-  );
-  if (v.prospectus !== null && v.prospectus !== void 0) {
-    isProspectus(v.prospectus, ctx, `${path}.prospectus`);
-  }
-  if (v.partners !== null && v.partners !== void 0) {
-    const partnersOk = ctx.check(
-      Array.isArray(v.partners),
-      `${path}.partners`,
-      "array",
-      v.partners
-    );
-    if (partnersOk) {
-      v.partners.forEach(
-        (partner, i) => isTokenPartner(partner, ctx, `${path}.partners[${i}]`)
-      );
-    }
-  }
-  if (v.rule_engine !== null && v.rule_engine !== void 0) {
-    isRuleEngineSummary(v.rule_engine, ctx, `${path}.rule_engine`);
-  }
-  return true;
-}
 function isIssuerSummary(value, ctx, path) {
   const v = asRecord(value);
   if (!ctx.check(v !== void 0, path, "object", value)) return false;
@@ -448,30 +372,12 @@ function isNetworkDetails(value, ctx, path) {
       )
     );
   }
-  ctx.check(
-    isBoolean(v.can_deploy_cmtat_token),
-    `${path}.can_deploy_cmtat_token`,
-    "boolean",
-    v.can_deploy_cmtat_token
-  );
-  ctx.check(
-    isBoolean(v.can_deploy_trex_token),
-    `${path}.can_deploy_trex_token`,
-    "boolean",
-    v.can_deploy_trex_token
-  );
   ctx.check(
     isBoolean(v.is_testnet),
     `${path}.is_testnet`,
     "boolean",
     v.is_testnet
   );
-  ctx.check(
-    isBoolean(v.is_supported),
-    `${path}.is_supported`,
-    "boolean",
-    v.is_supported
-  );
   return true;
 }
 function isFundConfig(value, ctx, path) {
@@ -519,18 +425,6 @@ function isFundConfig(value, ctx, path) {
     "string",
     v.redemption_gate_bps
   );
-  ctx.check(
-    isOptionalNullableString(v.protocol_subscription_fee_bps),
-    `${path}.protocol_subscription_fee_bps`,
-    "string | null | undefined",
-    v.protocol_subscription_fee_bps
-  );
-  ctx.check(
-    isOptionalNullableString(v.protocol_fee_recipient),
-    `${path}.protocol_fee_recipient`,
-    "string | null | undefined",
-    v.protocol_fee_recipient
-  );
   ctx.check(
     isString(v.management_fee_bps_per_annum),
     `${path}.management_fee_bps_per_annum`,
@@ -587,48 +481,18 @@ function isBookSummary(value, ctx, path) {
     "string",
     v.token_address
   );
-  ctx.check(
-    isString(v.fund_token),
-    `${path}.fund_token`,
-    "string",
-    v.fund_token
-  );
   ctx.check(
     isString(v.network_id),
     `${path}.network_id`,
     "string",
     v.network_id
   );
-  ctx.check(
-    isOptionalNullableString(v.admin_wallet),
-    `${path}.admin_wallet`,
-    "string | null | undefined",
-    v.admin_wallet
-  );
-  ctx.check(
-    isOptionalNullableString(v.manager_wallet),
-    `${path}.manager_wallet`,
-    "string | null | undefined",
-    v.manager_wallet
-  );
   ctx.check(
     isString(v.settlement_token),
     `${path}.settlement_token`,
     "string",
     v.settlement_token
   );
-  ctx.check(
-    isNullableString(v.factory_address),
-    `${path}.factory_address`,
-    "string | null",
-    v.factory_address
-  );
-  ctx.check(
-    isNullableString(v.deployment_txn_hash),
-    `${path}.deployment_txn_hash`,
-    "string | null",
-    v.deployment_txn_hash
-  );
   ctx.check(
     isString(v.order_book_address),
     `${path}.order_book_address`,
@@ -661,31 +525,122 @@ function isBookSummary(value, ctx, path) {
     "string | null",
     v.created_at
   );
-  ctx.check(
-    isNullableString(v.updated_at),
-    `${path}.updated_at`,
-    "string | null",
-    v.updated_at
-  );
   return true;
 }
-function isAssetRecord(value, ctx, path) {
+function isSecurityDetails(value, ctx, path) {
   const v = asRecord(value);
   if (!ctx.check(v !== void 0, path, "object", value)) return false;
-  isSecurityDetails(v.security, ctx, `${path}.security`);
-  isIssuerSummary(v.issuer, ctx, `${path}.issuer`);
-  const booksOk = ctx.check(
-    Array.isArray(v.books),
-    `${path}.books`,
-    "array",
-    v.books
+  ctx.check(
+    isString(v.token_address),
+    `${path}.token_address`,
+    "string",
+    v.token_address
+  );
+  ctx.check(
+    isString(v.token_name),
+    `${path}.token_name`,
+    "string",
+    v.token_name
+  );
+  ctx.check(
+    isString(v.token_symbol),
+    `${path}.token_symbol`,
+    "string",
+    v.token_symbol
+  );
+  ctx.check(
+    isString(v.token_decimal),
+    `${path}.token_decimal`,
+    "string",
+    v.token_decimal
+  );
+  ctx.check(
+    isString(v.network_id),
+    `${path}.network_id`,
+    "string",
+    v.network_id
+  );
+  ctx.check(
+    isString(v.token_type),
+    `${path}.token_type`,
+    "string",
+    v.token_type
+  );
+  ctx.check(isString(v.admin), `${path}.admin`, "string", v.admin);
+  ctx.check(
+    isNullableString(v.icon_url),
+    `${path}.icon_url`,
+    "string | null",
+    v.icon_url
   );
-  if (booksOk) {
-    v.books.forEach(
-      (book, i) => isBookSummary(book, ctx, `${path}.books[${i}]`)
+  ctx.check(
+    isNullableString(v.created_at),
+    `${path}.created_at`,
+    "string | null",
+    v.created_at
+  );
+  if (v.prospectus !== null && v.prospectus !== void 0) {
+    isProspectus(v.prospectus, ctx, `${path}.prospectus`);
+  }
+  if (v.issuer !== null && v.issuer !== void 0) {
+    isIssuerSummary(v.issuer, ctx, `${path}.issuer`);
+  }
+  if (v.book !== null && v.book !== void 0) {
+    isBookSummary(v.book, ctx, `${path}.book`);
+  }
+  if (v.partners !== null && v.partners !== void 0) {
+    const partnersOk = ctx.check(
+      Array.isArray(v.partners),
+      `${path}.partners`,
+      "array",
+      v.partners
     );
+    if (partnersOk) {
+      v.partners.forEach(
+        (partner, i) => isTokenPartner(partner, ctx, `${path}.partners[${i}]`)
+      );
+    }
+  }
+  if (v.rule_engine !== null && v.rule_engine !== void 0) {
+    isRuleEngineSummary(v.rule_engine, ctx, `${path}.rule_engine`);
   }
   isNetworkDetails(v.network, ctx, `${path}.network`);
+  if (v.trex_claim_topics !== null && v.trex_claim_topics !== void 0) {
+    const topicsOk = ctx.check(
+      Array.isArray(v.trex_claim_topics),
+      `${path}.trex_claim_topics`,
+      "number[]",
+      v.trex_claim_topics
+    );
+    if (topicsOk) {
+      v.trex_claim_topics.forEach(
+        (topic, i) => ctx.check(
+          isFiniteNumber(topic),
+          `${path}.trex_claim_topics[${i}]`,
+          "finite number",
+          topic
+        )
+      );
+    }
+  }
+  if (v.trex_issuers !== null && v.trex_issuers !== void 0) {
+    const issuersOk = ctx.check(
+      Array.isArray(v.trex_issuers),
+      `${path}.trex_issuers`,
+      "string[]",
+      v.trex_issuers
+    );
+    if (issuersOk) {
+      v.trex_issuers.forEach(
+        (issuer, i) => ctx.check(
+          isString(issuer),
+          `${path}.trex_issuers[${i}]`,
+          "string",
+          issuer
+        )
+      );
+    }
+  }
   return true;
 }
 function buildValidationError(value, failures) {
@@ -710,7 +665,7 @@ function validateSdkAssetsResponse(value) {
     );
     if (Array.isArray(value.data)) {
       value.data.forEach(
-        (item, i) => isAssetRecord(item, ctx, `<root>.data[${i}]`)
+        (item, i) => isSecurityDetails(item, ctx, `<root>.data[${i}]`)
       );
     }
   }
@@ -723,7 +678,7 @@ function validateSdkAssetResponse(value) {
   const ctx = new ValidationContext();
   ctx.check(isRecord(value), "<root>", "object", value);
   if (isRecord(value)) {
-    isAssetRecord(value.data, ctx, "<root>.data");
+    isSecurityDetails(value.data, ctx, "<root>.data");
   }
   if (ctx.failures.length > 0) {
     throw buildValidationError(value, ctx.failures);