@sereel/sdk 0.1.5 → 0.2.0

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.
 
@@ -200,9 +200,12 @@ interface SdkIssuerSummary {
 
 ### `SdkBookSummary`
 
-Fund details attached to the token.
+Fund (order book) details attached to the token. Wallet addresses are
+intentionally excluded from this response.
 
 ```ts
+type IssuanceStatus = "OPEN" | "CLOSED" | "FINALIZED" | "SETTLED" | "CANCELLED";
+
 interface SdkFundConfig {
   nav_staleness_threshold:       string;
   min_subscription:              string;
@@ -211,25 +214,24 @@ interface SdkFundConfig {
   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;
 }
 
 interface SdkBookSummary {
-  id:                  string;
-  order_book_address:  string;
-  fund_address:        string;
-  fund_id:             string;
-  fund_token:          string;
-  settlement_token:    string;
-  owner_wallet:        string;
-  manager_wallet:      string;
-  initial_nav:         string;
-  fund_config:         SdkFundConfig;
-  status:              string;
-  book_type:           string | null;
-  network_id:          string;
+  id:                   string | null;
+  organization_id:      string;
+  name:                 string | null;
+  book_type:            string | null;  // e.g. "open"
+  token_address:        string;
+  network_id:           string;
+  settlement_token:     string;
+  order_book_address:   string;
+  fund_address:         string;
+  fund_id:              string;
+  initial_nav:          string;
+  fund_config:          SdkFundConfig;
+  status:               IssuanceStatus;
+  created_at:           string | null;
 }
 ```
 
@@ -239,16 +241,14 @@ On-chain network the token is deployed on.
 
 ```ts
 interface NetworkDetails {
-  network_id:       string;
-  name:             string;
-  family:           string;    // e.g. "ethereum" | "solana" | "iota"
-  chain_id:         number | null;
-  native_currency:  NativeCurrency;
-  rpc_endpoint:     string;
-  explorer_urls:    string[];
-  can_deploy_token: boolean;
-  is_testnet:       boolean;
-  is_supported:     boolean;
+  network_id:              string;
+  name:                    string;
+  family:                  string;    // e.g. "ethereum" | "solana" | "iota"
+  chain_id:                number | null;
+  native_currency:         NativeCurrency;
+  rpc_endpoint:            string;
+  explorer_urls:           string[];
+  is_testnet:              boolean;
 }
 ```