@sereel/sdk 0.1.4 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -200,9 +200,12 @@ interface SdkIssuerSummary {
200
200
 
201
201
  ### `SdkBookSummary`
202
202
 
203
- Fund details attached to the token.
203
+ Fund (order book) details attached to the token. Wallet addresses are
204
+ intentionally excluded from this response.
204
205
 
205
206
  ```ts
207
+ type IssuanceStatus = "OPEN" | "CLOSED" | "FINALIZED" | "SETTLED" | "CANCELLED";
208
+
206
209
  interface SdkFundConfig {
207
210
  nav_staleness_threshold: string;
208
211
  min_subscription: string;
@@ -217,19 +220,24 @@ interface SdkFundConfig {
217
220
  }
218
221
 
219
222
  interface SdkBookSummary {
220
- id: string;
221
- order_book_address: string;
222
- fund_address: string;
223
- fund_id: string;
224
- fund_token: string;
225
- settlement_token: string;
226
- owner_wallet: string;
227
- manager_wallet: string;
228
- initial_nav: string;
229
- fund_config: SdkFundConfig;
230
- status: string;
231
- book_type: string | null;
232
- network_id: string;
223
+ id: string | null;
224
+ organization_id: string;
225
+ name: string | null;
226
+ book_type: string | null; // e.g. "open"
227
+ token_address: string;
228
+ fund_token: string; // alias for token_address
229
+ network_id: string;
230
+ settlement_token: string;
231
+ factory_address: string | null;
232
+ deployment_txn_hash: string | null;
233
+ order_book_address: string;
234
+ fund_address: string;
235
+ fund_id: string;
236
+ initial_nav: string;
237
+ fund_config: SdkFundConfig;
238
+ status: IssuanceStatus;
239
+ created_at: string | null;
240
+ updated_at: string | null;
233
241
  }
234
242
  ```
235
243
 
@@ -239,16 +247,17 @@ On-chain network the token is deployed on.
239
247
 
240
248
  ```ts
241
249
  interface NetworkDetails {
242
- network_id: string;
243
- name: string;
244
- family: string; // e.g. "ethereum" | "solana" | "iota"
245
- chain_id: number | null;
246
- native_currency: NativeCurrency;
247
- rpc_endpoint: string;
248
- explorer_urls: string[];
249
- can_deploy_token: boolean;
250
- is_testnet: boolean;
251
- is_supported: boolean;
250
+ network_id: string;
251
+ name: string;
252
+ family: string; // e.g. "ethereum" | "solana" | "iota"
253
+ chain_id: number | null;
254
+ native_currency: NativeCurrency;
255
+ rpc_endpoint: string;
256
+ explorer_urls: string[];
257
+ can_deploy_cmtat_token: boolean;
258
+ can_deploy_trex_token: boolean;
259
+ is_testnet: boolean;
260
+ is_supported: boolean;
252
261
  }
253
262
  ```
254
263