@orbinum/sdk 0.7.9 → 0.8.0

package/dist/index.d.mts

@@ -530,8 +530,6 @@ interface ShieldedCommitment {
     assetId: string;
     /** Origin of the commitment: direct shield, output of private transfer, or change from unshield. */
     source: 'shield' | 'transfer' | 'unshield';
-    /** SS58 or 0x-prefixed depositor address, null if not tracked. */
-    sender: string | null;
     /** 0x-prefixed encrypted memo hex, null if not present. */
     encryptedMemo: string | null;
     timestampMs: number | null;
@@ -728,17 +726,29 @@ interface RegisteredAsset {
     timestampMs: number | null;
 }
 /**
- * A single shielded activity event tied to an address.
- * The `kind` discriminant identifies whether it is a shield (commitment),
- * unshield, or private transfer event.
- */
-type ShieldedAddressEvent = ({
-    kind: 'commitment';
-} & ShieldedCommitment) | ({
-    kind: 'unshield';
-} & Unshield) | ({
-    kind: 'transfer';
-} & PrivateTransferTimestamp);
+ * One shielded-pool BOUNDARY event for an address, as served by
+ * `GET /shielded/address/:addr`. Only boundary facts are exposed — block,
+ * asset, amount (unshield), time, tx hash. Note internals (commitment hex,
+ * leaf index, nullifier, memo, sender/recipient) are never returned
+ * per-address: a public sender→leaf mapping would shrink the shielded pool's
+ * anonymity set. Private transfers carry no address and are never included.
+ */
+interface ShieldedAddressEvent {
+    /** 'shield' = deposit into the pool by this address; 'unshield' = withdrawal received by it. */
+    kind: 'shield' | 'unshield';
+    blockNumber: number;
+    extrinsicIndex: number | null;
+    /** Asset ID as decimal string. */
+    assetId: string;
+    /**
+     * Amount as decimal string (bigint-safe) for unshields.
+     * Always null for shields — the shield amount lives in the extrinsic, not the index.
+     */
+    amount: string | null;
+    timestampMs: number | null;
+    /** Blake2-256 hash of the enclosing extrinsic, 0x-prefixed. Null if not decoded. */
+    hash: string | null;
+}
 /** A validator node indexed from pallet-validator-set events. */
 interface IndexedValidator {
     account: string;
@@ -881,11 +891,6 @@ declare class IndexerClient {
     }): Promise<PaginatedResult<IndexedBlock>>;
     /** Returns a single block by number or hash, or null if not found. */
     getBlock(numberOrHash: string | number): Promise<IndexedBlock | null>;
-    /** Returns a paginated list of shielded commitments initiated by an address. */
-    getAddressCommitments(address: string, params?: {
-        page?: number;
-        limit?: number;
-    }): Promise<PaginatedResult<ShieldedCommitment>>;
     /**
      * Returns a paginated list of unshield events where the given address is the recipient.
      * Accepts a 0x-prefixed EVM address or an SS58 Substrate address.
@@ -895,9 +900,11 @@ declare class IndexerClient {
         limit?: number;
     }): Promise<PaginatedResult<Unshield>>;
     /**
-     * Returns a paginated list of all shielded activity (commitments, unshields,
-     * private transfers) associated with the given address.
-     * Each item is tagged with a `kind` discriminant.
+     * Returns the shielded-pool BOUNDARY activity for an address: shields it
+     * deposited and unshields it received, tagged `kind: 'shield' | 'unshield'`.
+     * Only boundary fields are returned (block, asset, amount for unshields,
+     * timestamp, tx hash) — note internals are never served per-address, and
+     * private transfers carry no address at all (PIR-A).
      */
     getAddressShieldedActivity(address: string, params?: {
         page?: number;

package/dist/index.d.ts

@@ -530,8 +530,6 @@ interface ShieldedCommitment {
     assetId: string;
     /** Origin of the commitment: direct shield, output of private transfer, or change from unshield. */
     source: 'shield' | 'transfer' | 'unshield';
-    /** SS58 or 0x-prefixed depositor address, null if not tracked. */
-    sender: string | null;
     /** 0x-prefixed encrypted memo hex, null if not present. */
     encryptedMemo: string | null;
     timestampMs: number | null;
@@ -728,17 +726,29 @@ interface RegisteredAsset {
     timestampMs: number | null;
 }
 /**
- * A single shielded activity event tied to an address.
- * The `kind` discriminant identifies whether it is a shield (commitment),
- * unshield, or private transfer event.
- */
-type ShieldedAddressEvent = ({
-    kind: 'commitment';
-} & ShieldedCommitment) | ({
-    kind: 'unshield';
-} & Unshield) | ({
-    kind: 'transfer';
-} & PrivateTransferTimestamp);
+ * One shielded-pool BOUNDARY event for an address, as served by
+ * `GET /shielded/address/:addr`. Only boundary facts are exposed — block,
+ * asset, amount (unshield), time, tx hash. Note internals (commitment hex,
+ * leaf index, nullifier, memo, sender/recipient) are never returned
+ * per-address: a public sender→leaf mapping would shrink the shielded pool's
+ * anonymity set. Private transfers carry no address and are never included.
+ */
+interface ShieldedAddressEvent {
+    /** 'shield' = deposit into the pool by this address; 'unshield' = withdrawal received by it. */
+    kind: 'shield' | 'unshield';
+    blockNumber: number;
+    extrinsicIndex: number | null;
+    /** Asset ID as decimal string. */
+    assetId: string;
+    /**
+     * Amount as decimal string (bigint-safe) for unshields.
+     * Always null for shields — the shield amount lives in the extrinsic, not the index.
+     */
+    amount: string | null;
+    timestampMs: number | null;
+    /** Blake2-256 hash of the enclosing extrinsic, 0x-prefixed. Null if not decoded. */
+    hash: string | null;
+}
 /** A validator node indexed from pallet-validator-set events. */
 interface IndexedValidator {
     account: string;
@@ -881,11 +891,6 @@ declare class IndexerClient {
     }): Promise<PaginatedResult<IndexedBlock>>;
     /** Returns a single block by number or hash, or null if not found. */
     getBlock(numberOrHash: string | number): Promise<IndexedBlock | null>;
-    /** Returns a paginated list of shielded commitments initiated by an address. */
-    getAddressCommitments(address: string, params?: {
-        page?: number;
-        limit?: number;
-    }): Promise<PaginatedResult<ShieldedCommitment>>;
     /**
      * Returns a paginated list of unshield events where the given address is the recipient.
      * Accepts a 0x-prefixed EVM address or an SS58 Substrate address.
@@ -895,9 +900,11 @@ declare class IndexerClient {
         limit?: number;
     }): Promise<PaginatedResult<Unshield>>;
     /**
-     * Returns a paginated list of all shielded activity (commitments, unshields,
-     * private transfers) associated with the given address.
-     * Each item is tagged with a `kind` discriminant.
+     * Returns the shielded-pool BOUNDARY activity for an address: shields it
+     * deposited and unshields it received, tagged `kind: 'shield' | 'unshield'`.
+     * Only boundary fields are returned (block, asset, amount for unshields,
+     * timestamp, tx hash) — note internals are never served per-address, and
+     * private transfers carry no address at all (PIR-A).
      */
     getAddressShieldedActivity(address: string, params?: {
         page?: number;

package/dist/index.js

@@ -1329,14 +1329,7 @@ var IndexerClient = class {
   async getBlock(numberOrHash) {
     return this.getOrNull(`/blocks/${encodeURIComponent(String(numberOrHash))}`);
   }
-  // ─── Address commitments ───────────────────────────────────────────────────
-  /** Returns a paginated list of shielded commitments initiated by an address. */
-  async getAddressCommitments(address, params) {
-    const qs = this.buildQuery({ page: params?.page, limit: params?.limit });
-    return this.get(
-      `/address/${encodeURIComponent(address.toLowerCase())}/shielded${qs}`
-    );
-  }
+  // ─── Address-scoped shielded activity ─────────────────────────────────────
   /**
    * Returns a paginated list of unshield events where the given address is the recipient.
    * Accepts a 0x-prefixed EVM address or an SS58 Substrate address.
@@ -1348,14 +1341,16 @@ var IndexerClient = class {
     );
   }
   /**
-   * Returns a paginated list of all shielded activity (commitments, unshields,
-   * private transfers) associated with the given address.
-   * Each item is tagged with a `kind` discriminant.
+   * Returns the shielded-pool BOUNDARY activity for an address: shields it
+   * deposited and unshields it received, tagged `kind: 'shield' | 'unshield'`.
+   * Only boundary fields are returned (block, asset, amount for unshields,
+   * timestamp, tx hash) — note internals are never served per-address, and
+   * private transfers carry no address at all (PIR-A).
    */
   async getAddressShieldedActivity(address, params) {
     const qs = this.buildQuery({ page: params?.page, limit: params?.limit });
     return this.get(
-      `/shielded/address/${encodeURIComponent(address.toLowerCase())}${qs}`
+      `/shielded/address/${encodeURIComponent(address)}${qs}`
     );
   }
   // ─── Relayers ──────────────────────────────────────────────────────────────

package/dist/index.mjs

@@ -1202,14 +1202,7 @@ var IndexerClient = class {
   async getBlock(numberOrHash) {
     return this.getOrNull(`/blocks/${encodeURIComponent(String(numberOrHash))}`);
   }
-  // ─── Address commitments ───────────────────────────────────────────────────
-  /** Returns a paginated list of shielded commitments initiated by an address. */
-  async getAddressCommitments(address, params) {
-    const qs = this.buildQuery({ page: params?.page, limit: params?.limit });
-    return this.get(
-      `/address/${encodeURIComponent(address.toLowerCase())}/shielded${qs}`
-    );
-  }
+  // ─── Address-scoped shielded activity ─────────────────────────────────────
   /**
    * Returns a paginated list of unshield events where the given address is the recipient.
    * Accepts a 0x-prefixed EVM address or an SS58 Substrate address.
@@ -1221,14 +1214,16 @@ var IndexerClient = class {
     );
   }
   /**
-   * Returns a paginated list of all shielded activity (commitments, unshields,
-   * private transfers) associated with the given address.
-   * Each item is tagged with a `kind` discriminant.
+   * Returns the shielded-pool BOUNDARY activity for an address: shields it
+   * deposited and unshields it received, tagged `kind: 'shield' | 'unshield'`.
+   * Only boundary fields are returned (block, asset, amount for unshields,
+   * timestamp, tx hash) — note internals are never served per-address, and
+   * private transfers carry no address at all (PIR-A).
    */
   async getAddressShieldedActivity(address, params) {
     const qs = this.buildQuery({ page: params?.page, limit: params?.limit });
     return this.get(
-      `/shielded/address/${encodeURIComponent(address.toLowerCase())}${qs}`
+      `/shielded/address/${encodeURIComponent(address)}${qs}`
     );
   }
   // ─── Relayers ──────────────────────────────────────────────────────────────

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orbinum/sdk",
-  "version": "0.7.9",
+  "version": "0.8.0",
   "description": "Official TypeScript SDK for Orbinum.",
   "author": "Orbinum",
   "license": "MIT",