@fepvenancio/stela-sdk 0.4.3 → 0.5.1

package/README.md

@@ -117,7 +117,6 @@ Return a `Call` object for use with `account.execute()`. Bundle multiple calls (
 | `buildRepay(id)` | Repay a filled inscription |
 | `buildLiquidate(id)` | Liquidate an expired inscription |
 | `buildRedeem(id, shares)` | Redeem shares for underlying assets |
-| `buildPrivateRedeem(request, proof)` | Redeem shares via the privacy pool with a ZK proof |
 | `buildSettle(params)` | Settle an off-chain order (used by relayer bots) |
 | `buildFillSignedOrder(order, sig, fillBps)` | Fill a signed order on-chain |
 | `buildCancelOrder(order)` | Cancel a specific signed order |
@@ -136,7 +135,6 @@ Convenience wrappers that call `account.execute()` directly. Accept optional `ap
 | `repay(id, approvals?)` | Repay a loan |
 | `liquidate(id)` | Liquidate an expired loan |
 | `redeem(id, shares)` | Redeem ERC1155 shares |
-| `privateRedeem(request, proof)` | Redeem via privacy pool |
 | `fillSignedOrder(order, sig, fillBps, approvals?)` | Fill a signed order |
 | `cancelOrder(order)` | Cancel a signed order |
 | `cancelOrdersByNonce(minNonce)` | Bulk cancel by nonce |
@@ -208,58 +206,13 @@ import {
 | Function | Description |
 |----------|-------------|
 | `getInscriptionOrderTypedData(params)` | Build SNIP-12 typed data for a borrower's InscriptionOrder |
-| `getLendOfferTypedData(params)` | Build SNIP-12 typed data for a lender's LendOffer (supports `lenderCommitment` for privacy) |
+| `getLendOfferTypedData(params)` | Build SNIP-12 typed data for a lender's LendOffer |
 | `hashAssets(assets)` | Poseidon hash of an asset array (matches Cairo's `hash_assets()`) |
 | `serializeSignature(sig)` | Convert `string[]` signature to `{ r, s }` for storage |
 | `deserializeSignature(stored)` | Convert `{ r, s }` back to `string[]` |
 
 ---
 
-### Privacy Utilities
-
-Functions for the privacy pool (shielded share commitments via Poseidon hashing).
-
-```typescript
-import {
-  createPrivateNote,
-  computeCommitment,
-  computeNullifier,
-  hashPair,
-  generateSalt,
-} from '@fepvenancio/stela-sdk'
-```
-
-| Function | Returns | Description |
-|----------|---------|-------------|
-| `createPrivateNote(owner, inscriptionId, shares, salt?)` | `PrivateNote` | Generate a full private note (auto-generates salt if omitted) |
-| `computeCommitment(owner, inscriptionId, shares, salt)` | `string` | Compute a Poseidon commitment hash |
-| `computeNullifier(commitment, ownerSecret)` | `string` | Derive a nullifier from a commitment |
-| `hashPair(left, right)` | `string` | Poseidon hash of two children (Merkle tree nodes) |
-| `generateSalt()` | `string` | Random felt252 salt for commitment uniqueness |
-
-#### Types
-
-```typescript
-interface PrivateNote {
-  owner: string
-  inscriptionId: bigint
-  shares: bigint
-  salt: string
-  commitment: string
-}
-
-interface PrivateRedeemRequest {
-  root: string            // Merkle root the proof was generated against
-  inscriptionId: bigint
-  shares: bigint
-  nullifier: string       // Prevents double-spend
-  changeCommitment: string // For partial redemption ('0' if full)
-  recipient: string
-}
-```
-
----
-
 ### Math Utilities
 
 Share calculation helpers that mirror the on-chain math.
@@ -296,7 +249,7 @@ import { parseEvent, parseEvents, SELECTORS } from '@fepvenancio/stela-sdk'
 | `parseEvent(raw)` | Parse a single raw event into a typed `StelaEvent` |
 | `parseEvents(raws)` | Parse an array of raw events |
 
-Supported event types: `InscriptionCreated`, `InscriptionSigned`, `InscriptionCancelled`, `InscriptionRepaid`, `InscriptionLiquidated`, `SharesRedeemed`, `TransferSingle`, `OrderSettled`, `OrderFilled`, `OrderCancelled`, `OrdersBulkCancelled`, `PrivateSettled`, `PrivateSharesRedeemed`.
+Supported event types: `InscriptionCreated`, `InscriptionSigned`, `InscriptionCancelled`, `InscriptionRepaid`, `InscriptionLiquidated`, `SharesRedeemed`, `TransferSingle`, `OrderSettled`, `OrderFilled`, `OrderCancelled`, `OrdersBulkCancelled`.
 
 ---
 
@@ -369,12 +322,28 @@ All exported types from the SDK:
 | `LockerInfo` | Locker information from the API |
 | `LockerState` | Locker address + unlock status |
 | `LockerCall` | Call to execute through a locker |
+| `RawEvent` | Raw StarkNet event (keys, data, tx_hash, block) |
 | `StelaEvent` | Discriminated union of all protocol events |
-| `PrivateNote` | Private share note for the privacy pool |
-| `PrivateRedeemRequest` | Request to privately redeem shares |
+| `InscriptionCreatedEvent` | InscriptionCreated event type |
+| `InscriptionSignedEvent` | InscriptionSigned event type |
+| `InscriptionCancelledEvent` | InscriptionCancelled event type |
+| `InscriptionRepaidEvent` | InscriptionRepaid event type |
+| `InscriptionLiquidatedEvent` | InscriptionLiquidated event type |
+| `SharesRedeemedEvent` | SharesRedeemed event type |
+| `TransferSingleEvent` | ERC1155 TransferSingle event type |
+| `OrderSettledEvent` | OrderSettled event type |
+| `OrderFilledEvent` | OrderFilled event type |
+| `OrderCancelledEvent` | OrderCancelled event type |
+| `OrdersBulkCancelledEvent` | OrdersBulkCancelled event type |
 | `TokenInfo` | Token metadata (symbol, name, decimals, addresses) |
 | `StatusInput` | Input for `computeStatus()` |
 | `StoredSignature` | Serialized signature for storage (`{ r, s }`) |
+| `InscriptionClientOptions` | Options for InscriptionClient constructor |
+| `ShareClientOptions` | Options for ShareClient constructor |
+| `ApiClientOptions` | Options for ApiClient constructor |
+| `ListInscriptionsParams` | Parameters for `listInscriptions()` |
+| `InscriptionEventRow` | API response row for inscription events |
+| `StelaSdkOptions` | Options for StelaSdk constructor |
 
 ---
 
@@ -384,6 +353,8 @@ All exported types from the SDK:
 |--------|-------------|
 | `STELA_ADDRESS` | Contract addresses per network (`{ sepolia, mainnet }`) |
 | `resolveNetwork(raw?)` | Validate/default network string |
+| `CHAIN_ID` | SNIP-12 chain ID shortstrings per network (`{ sepolia: 'SN_SEPOLIA', mainnet: 'SN_MAIN' }`) |
+| `EXPLORER_TX_URL` | Block explorer base URLs per network (for transaction links) |
 | `MAX_BPS` | `10_000n` (100% in basis points) |
 | `VIRTUAL_SHARE_OFFSET` | `1e16n` (share calculation offset) |
 | `ASSET_TYPE_ENUM` | AssetType to numeric enum mapping |
@@ -391,13 +362,19 @@ All exported types from the SDK:
 | `VALID_STATUSES` | Array of all valid inscription statuses |
 | `STATUS_LABELS` | Human-readable status labels |
 
+### Classes
+
+| Export | Description |
+|--------|-------------|
+| `ApiError` | Error class thrown by ApiClient on HTTP failures |
+
 ### ABIs
 
 The package ships raw ABI JSON files in `src/abi/`:
 
 | File | Contents |
 |------|----------|
-| `src/abi/stela.json` | Full Stela protocol ABI (IStelaProtocol + ERC1155 + Ownable + Privacy) |
+| `src/abi/stela.json` | Full Stela protocol ABI (IStelaProtocol + ERC1155 + Ownable) |
 | `src/abi/erc20.json` | Minimal ERC20 ABI (approve, balanceOf, allowance) |
 | `src/abi/locker.json` | Locker account ABI (__execute__, is_unlocked) |
 

package/dist/index.cjs

@@ -24,7 +24,7 @@ var STATUS_LABELS = {
 
 // src/constants/addresses.ts
 var STELA_ADDRESS = {
-  sepolia: "0x038fb9a3bbf84aef962c70bc0ed15744f4f3088bae73bed99031b6f2b7cfab01",
+  sepolia: "0x042f27b5cf82781d8fffd7daeec9184ac4f14c9e86e87b880bd81ef5197345ed",
   mainnet: "0x0"
 };
 var VALID_NETWORKS = ["sepolia", "mainnet"];
@@ -492,16 +492,6 @@ function getInscriptionOrderTypedData(params) {
     }
   };
 }
-function getPrivateLendOfferTypedData(params) {
-  return getLendOfferTypedData({
-    orderHash: params.orderHash,
-    lender: "0x0",
-    issuedDebtPercentage: params.issuedDebtPercentage,
-    nonce: params.nonce,
-    chainId: params.chainId,
-    lenderCommitment: params.depositCommitment
-  });
-}
 function getLendOfferTypedData(params) {
   return {
     types: {
@@ -515,8 +505,7 @@ function getLendOfferTypedData(params) {
         { name: "order_hash", type: "felt" },
         { name: "lender", type: "ContractAddress" },
         { name: "issued_debt_percentage", type: "u256" },
-        { name: "nonce", type: "felt" },
-        { name: "lender_commitment", type: "felt" }
+        { name: "nonce", type: "felt" }
       ],
       u256: [
         { name: "low", type: "u128" },
@@ -535,8 +524,7 @@ function getLendOfferTypedData(params) {
         low: (params.issuedDebtPercentage & (1n << 128n) - 1n).toString(),
         high: (params.issuedDebtPercentage >> 128n).toString()
       },
-      nonce: params.nonce.toString(),
-      lender_commitment: params.lenderCommitment ?? "0"
+      nonce: params.nonce.toString()
     }
   };
 }
@@ -548,54 +536,6 @@ function serializeSignature(sig) {
 function deserializeSignature(stored) {
   return [stored.r, stored.s];
 }
-var COMMITMENT_DOMAIN = starknet.shortString.encodeShortString("STELA_COMMITMENT_V1");
-var NULLIFIER_DOMAIN = starknet.shortString.encodeShortString("STELA_NULLIFIER_V1");
-function computeCommitment(owner, inscriptionId, shares, salt) {
-  const [idLow, idHigh] = toU256(inscriptionId);
-  const [sharesLow, sharesHigh] = toU256(shares);
-  return starknet.hash.computePoseidonHashOnElements([
-    COMMITMENT_DOMAIN,
-    owner,
-    idLow,
-    idHigh,
-    sharesLow,
-    sharesHigh,
-    salt
-  ]);
-}
-function computeNullifier(commitment, ownerSecret) {
-  return starknet.hash.computePoseidonHashOnElements([NULLIFIER_DOMAIN, commitment, ownerSecret]);
-}
-function hashPair(left, right) {
-  return starknet.hash.computePoseidonHashOnElements([left, right]);
-}
-function generateSalt() {
-  const bytes = new Uint8Array(31);
-  crypto.getRandomValues(bytes);
-  return "0x" + Array.from(bytes).map((b) => b.toString(16).padStart(2, "0")).join("");
-}
-function computeDepositCommitment(depositor, token, amount, salt) {
-  const [amountLow, amountHigh] = toU256(amount);
-  return starknet.hash.computePoseidonHashOnElements([
-    COMMITMENT_DOMAIN,
-    depositor,
-    token,
-    amountLow,
-    amountHigh,
-    "0x" + salt.toString(16)
-  ]);
-}
-function createPrivateNote(owner, inscriptionId, shares, salt) {
-  const noteSalt = salt ?? generateSalt();
-  const commitment = computeCommitment(owner, inscriptionId, shares, noteSalt);
-  return {
-    owner,
-    inscriptionId,
-    shares,
-    salt: noteSalt,
-    commitment
-  };
-}
 
 // src/abi/stela.json
 var stela_default = [
@@ -710,46 +650,6 @@ var stela_default = [
       }
     ]
   },
-  {
-    type: "struct",
-    name: "stela::types::private_redeem::PrivateRedeemRequest",
-    members: [
-      {
-        name: "root",
-        type: "core::felt252"
-      },
-      {
-        name: "inscription_id",
-        type: "core::integer::u256"
-      },
-      {
-        name: "shares",
-        type: "core::integer::u256"
-      },
-      {
-        name: "nullifier",
-        type: "core::felt252"
-      },
-      {
-        name: "change_commitment",
-        type: "core::felt252"
-      },
-      {
-        name: "recipient",
-        type: "core::starknet::contract_address::ContractAddress"
-      }
-    ]
-  },
-  {
-    type: "struct",
-    name: "core::array::Span::<core::felt252>",
-    members: [
-      {
-        name: "snapshot",
-        type: "@core::array::Array::<core::felt252>"
-      }
-    ]
-  },
   {
     type: "struct",
     name: "stela::snip12::InscriptionOrder",
@@ -819,10 +719,6 @@ var stela_default = [
       {
         name: "nonce",
         type: "core::felt252"
-      },
-      {
-        name: "lender_commitment",
-        type: "core::felt252"
       }
     ]
   },
@@ -1002,22 +898,6 @@ var stela_default = [
         outputs: [],
         state_mutability: "external"
       },
-      {
-        type: "function",
-        name: "private_redeem",
-        inputs: [
-          {
-            name: "request",
-            type: "stela::types::private_redeem::PrivateRedeemRequest"
-          },
-          {
-            name: "proof",
-            type: "core::array::Span::<core::felt252>"
-          }
-        ],
-        outputs: [],
-        state_mutability: "external"
-      },
       {
         type: "function",
         name: "settle",
@@ -1276,7 +1156,7 @@ var stela_default = [
       },
       {
         type: "function",
-        name: "get_privacy_pool",
+        name: "get_genesis_contract",
         inputs: [],
         outputs: [
           {
@@ -1285,6 +1165,22 @@ var stela_default = [
         ],
         state_mutability: "view"
       },
+      {
+        type: "function",
+        name: "get_volume_settled",
+        inputs: [
+          {
+            name: "user",
+            type: "core::starknet::contract_address::ContractAddress"
+          }
+        ],
+        outputs: [
+          {
+            type: "core::integer::u256"
+          }
+        ],
+        state_mutability: "view"
+      },
       {
         type: "function",
         name: "set_inscription_fee",
@@ -1359,10 +1255,10 @@ var stela_default = [
       },
       {
         type: "function",
-        name: "set_privacy_pool",
+        name: "set_genesis_contract",
         inputs: [
           {
-            name: "privacy_pool",
+            name: "genesis_contract",
             type: "core::starknet::contract_address::ContractAddress"
           }
         ],
@@ -1371,40 +1267,28 @@ var stela_default = [
       },
       {
         type: "function",
-        name: "set_fee_vault",
-        inputs: [
-          {
-            name: "fee_vault",
-            type: "core::starknet::contract_address::ContractAddress"
-          }
-        ],
+        name: "pause",
+        inputs: [],
         outputs: [],
         state_mutability: "external"
       },
       {
         type: "function",
-        name: "get_fee_vault",
-        inputs: [],
-        outputs: [
-          {
-            type: "core::starknet::contract_address::ContractAddress"
-          }
-        ],
-        state_mutability: "view"
-      },
-      {
-        type: "function",
-        name: "pause",
+        name: "unpause",
         inputs: [],
         outputs: [],
         state_mutability: "external"
       },
       {
         type: "function",
-        name: "unpause",
+        name: "get_pauser",
         inputs: [],
-        outputs: [],
-        state_mutability: "external"
+        outputs: [
+          {
+            type: "core::starknet::contract_address::ContractAddress"
+          }
+        ],
+        state_mutability: "view"
       },
       {
         type: "function",
@@ -1453,6 +1337,16 @@ var stela_default = [
       }
     ]
   },
+  {
+    type: "struct",
+    name: "core::array::Span::<core::felt252>",
+    members: [
+      {
+        name: "snapshot",
+        type: "@core::array::Array::<core::felt252>"
+      }
+    ]
+  },
   {
     type: "struct",
     name: "core::byte_array::ByteArray",
@@ -1852,6 +1746,10 @@ var stela_default = [
       {
         name: "implementation_hash",
         type: "core::felt252"
+      },
+      {
+        name: "pauser",
+        type: "core::starknet::contract_address::ContractAddress"
       }
     ]
   },
@@ -2320,55 +2218,6 @@ var stela_default = [
       }
     ]
   },
-  {
-    type: "event",
-    name: "stela::stela::StelaProtocol::PrivateSettled",
-    kind: "struct",
-    members: [
-      {
-        name: "inscription_id",
-        type: "core::integer::u256",
-        kind: "key"
-      },
-      {
-        name: "lender_commitment",
-        type: "core::felt252",
-        kind: "key"
-      },
-      {
-        name: "shares_committed",
-        type: "core::integer::u256",
-        kind: "data"
-      }
-    ]
-  },
-  {
-    type: "event",
-    name: "stela::stela::StelaProtocol::PrivateSharesRedeemed",
-    kind: "struct",
-    members: [
-      {
-        name: "inscription_id",
-        type: "core::integer::u256",
-        kind: "key"
-      },
-      {
-        name: "nullifier",
-        type: "core::felt252",
-        kind: "key"
-      },
-      {
-        name: "shares",
-        type: "core::integer::u256",
-        kind: "data"
-      },
-      {
-        name: "recipient",
-        type: "core::starknet::contract_address::ContractAddress",
-        kind: "data"
-      }
-    ]
-  },
   {
     type: "event",
     name: "stela::stela::StelaProtocol::Event",
@@ -2453,16 +2302,6 @@ var stela_default = [
         name: "OrdersBulkCancelled",
         type: "stela::stela::StelaProtocol::OrdersBulkCancelled",
         kind: "nested"
-      },
-      {
-        name: "PrivateSettled",
-        type: "stela::stela::StelaProtocol::PrivateSettled",
-        kind: "nested"
-      },
-      {
-        name: "PrivateSharesRedeemed",
-        type: "stela::stela::StelaProtocol::PrivateSharesRedeemed",
-        kind: "nested"
       }
     ]
   }
@@ -2578,53 +2417,6 @@ var InscriptionClient = class {
       calldata: [...toU256(inscriptionId), ...toU256(shares)]
     };
   }
-  buildPrivateRedeem(request, proof) {
-    const calldata = [
-      // PrivateRedeemRequest struct fields (must match Cairo Serde order)
-      request.root,
-      ...toU256(request.inscriptionId),
-      ...toU256(request.shares),
-      request.nullifier,
-      request.changeCommitment,
-      request.recipient,
-      // proof array
-      String(proof.length),
-      ...proof
-    ];
-    return { contractAddress: this.address, entrypoint: "private_redeem", calldata };
-  }
-  /**
-   * Build a shield() call on the privacy pool contract.
-   * The depositor shields tokens into the pool, creating a commitment that can
-   * later be consumed during private settlement.
-   */
-  buildShieldDeposit(params) {
-    return {
-      contractAddress: params.privacyPoolAddress,
-      entrypoint: "shield",
-      calldata: [
-        params.token,
-        ...toU256(params.amount),
-        params.commitment
-      ]
-    };
-  }
-  /**
-   * Build a settle() call for private settlement.
-   *
-   * In a private settlement, the lender is zero address and the lender_commitment
-   * is the deposit commitment from the privacy pool. The contract skips lender
-   * signature verification and instead consumes the deposit from the privacy pool.
-   */
-  buildSettlePrivate(params) {
-    return this.buildSettle({
-      ...params,
-      offer: {
-        ...params.offer,
-        lender: "0x0"
-      }
-    });
-  }
   buildSettle(params) {
     const calldata = [
       // Order struct fields
@@ -2653,7 +2445,6 @@ var InscriptionClient = class {
       params.offer.lender,
       ...toU256(params.offer.issuedDebtPercentage),
       params.offer.nonce.toString(),
-      params.offer.lenderCommitment ?? "0",
       // lender_sig array
       String(params.lenderSig.length),
       ...params.lenderSig
@@ -2728,9 +2519,6 @@ var InscriptionClient = class {
   async redeem(inscriptionId, shares) {
     return this.execute([this.buildRedeem(inscriptionId, shares)]);
   }
-  async privateRedeem(request, proof) {
-    return this.execute([this.buildPrivateRedeem(request, proof)]);
-  }
   async fillSignedOrder(order, signature, fillBps, approvals) {
     const calls = [...approvals ?? [], this.buildFillSignedOrder(order, signature, fillBps)];
     return this.execute(calls);
@@ -3129,12 +2917,8 @@ exports.VALID_STATUSES = VALID_STATUSES;
 exports.VIRTUAL_SHARE_OFFSET = VIRTUAL_SHARE_OFFSET;
 exports.addressesEqual = addressesEqual;
 exports.calculateFeeShares = calculateFeeShares;
-exports.computeCommitment = computeCommitment;
-exports.computeDepositCommitment = computeDepositCommitment;
-exports.computeNullifier = computeNullifier;
 exports.computeStatus = computeStatus;
 exports.convertToShares = convertToShares;
-exports.createPrivateNote = createPrivateNote;
 exports.deserializeSignature = deserializeSignature;
 exports.findTokenByAddress = findTokenByAddress;
 exports.formatAddress = formatAddress;
@@ -3142,13 +2926,10 @@ exports.formatDuration = formatDuration;
 exports.formatTimestamp = formatTimestamp;
 exports.formatTokenValue = formatTokenValue;
 exports.fromU256 = fromU256;
-exports.generateSalt = generateSalt;
 exports.getInscriptionOrderTypedData = getInscriptionOrderTypedData;
 exports.getLendOfferTypedData = getLendOfferTypedData;
-exports.getPrivateLendOfferTypedData = getPrivateLendOfferTypedData;
 exports.getTokensForNetwork = getTokensForNetwork;
 exports.hashAssets = hashAssets;
-exports.hashPair = hashPair;
 exports.inscriptionIdToHex = inscriptionIdToHex;
 exports.normalizeAddress = normalizeAddress;
 exports.parseAmount = parseAmount;