@sereel/sdk 0.1.6 → 0.2.1

package/README.md

@@ -76,8 +76,8 @@ const client = createClient({
 ```ts
 const { data, count } = await client.getAssets();
 
-for (const record of data) {
-  console.log(record.security.token_name, record.issuer.legal_name);
+for (const asset of data) {
+  console.log(asset.token_name, asset.issuer?.legal_name);
 }
 ```
 
@@ -86,14 +86,17 @@ for (const record of data) {
 ### `client.getAssetByTokenAddress(tokenAddress)`
 
 `GET /sdk/assets/{token_address}` — returns a single asset by its on-chain
-token address.
+token address. The response is a single `SdkSecurityDetails` object that
+contains the token, issuer, primary book, and network details all in one
+place.
 
 ```ts
 const { data } = await client.getAssetByTokenAddress("0xabc…");
 
-console.log(data.security.token_name);
-console.log(data.security.rule_engine?.name);   // present if token has compliance rules
-console.log(data.books.length);
+console.log(data.token_name);
+console.log(data.rule_engine?.name);   // present if token has compliance rules
+console.log(data.book?.status);        // present if token has a book
+console.log(data.network.name);
 ```
 
 ---
@@ -108,28 +111,20 @@ specific issuer. The `issuerId` is the `id` field from `SdkIssuerSummary`
 const { data, count } = await client.getAssetsByIssuer("64f1a2b3c4d5e6f7a8b9c0d1");
 
 console.log(`${count} tokens from this issuer`);
-data.forEach(record => console.log(record.security.token_symbol));
+data.forEach(asset => console.log(asset.token_symbol));
 ```
 
 ---
 
 ## Response shape
 
-Every API method returns one or more `SdkAssetRecord` objects.
-
-```ts
-interface SdkAssetRecord {
-  security: SdkSecurityDetails;
-  issuer:   SdkIssuerSummary;
-  books:    SdkBookSummary[];
-  network:  NetworkDetails;
-}
-```
+Every API method returns one or more `SdkSecurityDetails` objects.
 
 ### `SdkSecurityDetails`
 
-Full token details. Internal and sensitive fields are intentionally excluded
-(`id`, `org_id`, `deployment_txn_hash`, `token_program_id`, `engines` (raw),
+Full token details with issuer, book, and network flattened into a single
+object. Internal and sensitive fields are intentionally excluded (`id`,
+`org_id`, `deployment_txn_hash`, `token_program_id`, `engines` (raw),
 `extra_information_attributes`, `allowlist_manager`, `iota_*` fields,
 `individual_token_price`, `rule_engine_id`, `updated_at`).
 
@@ -144,15 +139,20 @@ interface SdkSecurityDetails {
   admin:         string;       // token admin wallet address
   icon_url:      string | null;
   prospectus:    SdkTokenProspectus | null;
+  issuer:        SdkIssuerSummary | null;
+  book:          SdkBookSummary | null;
   partners:      SdkTokenPartner[]  | null;
   rule_engine:   SdkRuleEngineSummary | null;  // present when token has compliance rules
+  network:       NetworkDetails;
   created_at:    string | null;
+  trex_claim_topics: number[] | null;
+  trex_issuers:  string[] | null;
 }
 ```
 
 ### `SdkRuleEngineSummary`
 
-When a token has an associated compliance rule engine, it is joined into the
+When a token has an associated compliance rule engine, it is included in the
 security details. Only the name, address, and a slim view of each linked rule
 are exposed.
 
@@ -212,10 +212,7 @@ interface SdkFundConfig {
   min_redemption:                string;
   entry_fee_bps:                 string;
   exit_fee_bps:                  string;
-  dealing_mode:                  number;
   redemption_gate_bps:           string;
-  protocol_subscription_fee_bps: string;
-  protocol_fee_recipient:        string;
   management_fee_bps_per_annum:  string;
 }
 
@@ -225,11 +222,8 @@ interface SdkBookSummary {
   name:                 string | null;
   book_type:            string | null;  // e.g. "open"
   token_address:        string;
-  fund_token:           string;         // alias for token_address
   network_id:           string;
   settlement_token:     string;
-  factory_address:      string | null;
-  deployment_txn_hash:  string | null;
   order_book_address:   string;
   fund_address:         string;
   fund_id:              string;
@@ -237,7 +231,6 @@ interface SdkBookSummary {
   fund_config:          SdkFundConfig;
   status:               IssuanceStatus;
   created_at:           string | null;
-  updated_at:           string | null;
 }
 ```
 
@@ -254,10 +247,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;
 }
 ```
 

package/dist/index.cjs

@@ -234,9 +234,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);
 }
@@ -325,79 +322,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;
@@ -487,30 +411,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) {
@@ -546,30 +452,12 @@ function isFundConfig(value, ctx, path) {
     "string",
     v.exit_fee_bps
   );
-  ctx.check(
-    isFiniteNumber(v.dealing_mode),
-    `${path}.dealing_mode`,
-    "finite number",
-    v.dealing_mode
-  );
   ctx.check(
     isString(v.redemption_gate_bps),
     `${path}.redemption_gate_bps`,
     "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`,
@@ -626,48 +514,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`,
@@ -700,31 +558,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
   );
-  if (booksOk) {
-    v.books.forEach(
-      (book, i) => isBookSummary(book, ctx, `${path}.books[${i}]`)
+  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.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) {
@@ -749,7 +698,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}]`)
       );
     }
   }
@@ -762,7 +711,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);