@fairblock/stabletrust 1.0.20 → 1.0.21

package/README.md

@@ -2,12 +2,12 @@
 
 ## Overview
 
-The StableTrust SDK by Fairblock provides a robust interface for executing confidential transfers using homomorphic encryption and zero-knowledge proofs. This package enables developers to integrate confidentiality features directly into their applications, allowing for secure token deposits, private transfers, and withdrawals while maintaining the integrity and auditability of the underlying blockchain transactions.
+The Stabletrust SDK by Fairblock provides a robust interface for executing confidential transfers using homomorphic encryption and zero-knowledge proofs. This package enables developers to integrate confidentiality features directly into their applications, allowing for secure token deposits, private transfers, and withdrawals while maintaining the integrity and auditability of the underlying blockchain transactions.
 
 For a comprehensive technical understanding of the architecture and cryptographic primitives, please refer to the following documentation:
 
 - **Technical Overview**: [Fairblock Confidential Transfers](https://docs.fairblock.network/docs/confidential_transfers/technical_overview)
-- **StableTrust Protocol**: [StableTrust Documentation](https://docs.fairblock.network/docs/confidential_transfers/stabletrust)
+- **Stabletrust Protocol**: [Stabletrust Documentation](https://docs.fairblock.network/docs/confidential_transfers/stabletrust)
 - **Confidential Transactions**: [Transaction Mechanics](https://docs.fairblock.network/docs/confidential_transfers/confidential_transactions)
 
 ## Requirements
@@ -57,7 +57,7 @@ Import and initialize the client with your network configuration.
 import { ConfidentialTransferClient } from "@fairblock/stabletrust";
 import { ethers } from "ethers";
 
-// Configuration for Base Sepolia (uses SDK default StableTrust contract for chainId 84532)
+// Configuration for Base Sepolia (uses SDK default Stabletrust contract for chainId 84532)
 const client = new ConfidentialTransferClient(
   "https://sepolia.base.org",
   84532,
@@ -69,7 +69,7 @@ If you are using a custom deployment, you can still pass an explicit contract ad
 ```javascript
 const customClient = new ConfidentialTransferClient(
   "https://sepolia.base.org",
-  "0xYourCustomStableTrustContract",
+  "0xYourCustomStabletrustContract",
   84532,
 );
 ```
@@ -146,7 +146,7 @@ Fetches account core information from the contract.
 
 #### `ensureAccount(signer, options)`
 
-Initializes or retrieves the cryptographic keys associated with an account. This step is required before performing any confidential operations. Automatically creates the account on-chain if it doesn't exist.
+Initializes or retrieves the cryptographic keys associated with an account. This step is required before performing any confidential operations. Automatically creates the account onchain if it doesn't exist.
 
 - **Parameters**:
   - `signer` (ethers.Signer): The ethers.js signer instance for the user.
@@ -266,7 +266,7 @@ The following are estimated execution times for standard operations within the c
 
 ## Security Considerations
 
-When using the StableTrust SDK, follow these best practices to ensure the security of your confidential transactions:
+When using the Stabletrust SDK, follow these best practices to ensure the security of your confidential transactions:
 
 1. **Private Key Management**
    - Never expose or log private keys or seed phrases

package/examples/complete-flow.js

@@ -245,7 +245,7 @@ async function runChainFlow(chain, senderPrivateKey, recipientPrivateKey) {
 
     const txHash = txRes.result.hash || txRes.result.transactionHash;
     console.log(
-      "Status: Confidential Transfer is completed. Transfer amount is hidden on-chain.",
+      "Status: Confidential Transfer is completed. Transfer amount is hidden onchain.",
     );
     console.log(`Transaction Hash: ${txHash}`);
     console.log(`View Transaction: ${explorerBaseUrl}${txHash}`);

package/examples/simple-snippets.js

@@ -28,7 +28,7 @@ async function minimalFlow() {
   // 3. DEPOSIT: Move public ERC20 into the confidential contract
   res = await client.confidentialDeposit(sender, TOKEN, amount);
   console.log("Deposit TX Hash:", EXPLORER_URL + res.hash);
-  // 4. TRANSFER: Privacy-preserving transfer (On-chain amount is hidden)
+  // 4. TRANSFER: Privacy-preserving transfer (onchain amount is hidden)
   // This moves funds from Sender's 'Available' to Recipient's 'Pending' balance
   res = await client.confidentialTransfer(
     sender,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fairblock/stabletrust",
-  "version": "1.0.20",
+  "version": "1.0.21",
   "description": "SDK for confidential transfers using homomorphic encryption and zero-knowledge proofs",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/client.js

@@ -2,7 +2,7 @@ import { ethers } from "ethers";
 import {
   CONTRACT_ABI,
   ERC20_ABI,
-  getStableTrustContractAddress,
+  getStabletrustContractAddress,
 } from "./constants.js";
 import { deriveKeys, decryptCiphertext, combineCiphertext } from "./crypto.js";
 import {
@@ -45,12 +45,12 @@ export class ConfidentialTransferClient {
 
     if (typeof contractAddressOrChainId === "number" && chainId === undefined) {
       resolvedChainId = contractAddressOrChainId;
-      resolvedContractAddress = getStableTrustContractAddress(resolvedChainId);
+      resolvedContractAddress = getStabletrustContractAddress(resolvedChainId);
     } else {
       resolvedChainId = chainId;
       resolvedContractAddress =
         contractAddressOrChainId ||
-        getStableTrustContractAddress(resolvedChainId);
+        getStabletrustContractAddress(resolvedChainId);
     }
 
     if (!resolvedChainId) {
@@ -61,7 +61,7 @@ export class ConfidentialTransferClient {
         .map(String)
         .join(", ");
       throw new Error(
-        `contractAddress is required for chainId ${resolvedChainId}. No default StableTrust contract is configured for this chain. Supported chainIds: ${supportedChainIds}`,
+        `contractAddress is required for chainId ${resolvedChainId}. No default Stabletrust contract is configured for this chain. Supported chainIds: ${supportedChainIds}`,
       );
     }
     if (!ethers.isAddress(resolvedContractAddress)) {

package/src/constants.js

@@ -33,6 +33,6 @@ export const STABLETRUST_CONTRACTS_BY_CHAIN_ID = Object.freeze({
   42431: "0xE559fB936C69c46E216bf61B07C16bF1a6d444aa", //Tempo
 });
 
-export function getStableTrustContractAddress(chainId) {
+export function getStabletrustContractAddress(chainId) {
   return STABLETRUST_CONTRACTS_BY_CHAIN_ID[Number(chainId)] || null;
 }

package/src/index.d.ts

@@ -10,7 +10,7 @@ declare module "@fairblock/stabletrust" {
     chainId: number;
   }
 
-  export type StableTrustChainId =
+  export type StabletrustChainId =
     | 1244
     | 2201
     | 42431
@@ -82,7 +82,7 @@ declare module "@fairblock/stabletrust" {
     /**
      * Create a new ConfidentialTransferClient
      * @param rpcUrl RPC endpoint URL
-     * @param chainId Chain ID (uses default StableTrust contract for known networks)
+     * @param chainId Chain ID (uses default Stabletrust contract for known networks)
      */
     constructor(rpcUrl: string, chainId: number);
 
@@ -233,12 +233,12 @@ declare module "@fairblock/stabletrust" {
   export const ERC20_ABI: any[];
 
   /**
-   * StableTrust contract addresses by chain id
+   * Stabletrust contract addresses by chain id
    */
   export const STABLETRUST_CONTRACTS_BY_CHAIN_ID: Record<number, string>;
 
   /**
-   * Resolve StableTrust contract address by chain id
+   * Resolve Stabletrust contract address by chain id
    */
-  export function getStableTrustContractAddress(chainId: number): string | null;
+  export function getStabletrustContractAddress(chainId: number): string | null;
 }

package/src/index.js

@@ -5,6 +5,6 @@ export {
   CONTRACT_ABI,
   ERC20_ABI,
   STABLETRUST_CONTRACTS_BY_CHAIN_ID,
-  getStableTrustContractAddress,
+  getStabletrustContractAddress,
 } from "./constants.js";
 // Note: initializeWasm is now internal - WASM auto-initializes on first client use

package/src/utils.js

@@ -56,7 +56,7 @@ export function logTransaction(hash, explorerUrl, isConfidential = false) {
   console.log(`Transaction submitted: ${explorerUrl}${hash}`);
   if (isConfidential) {
     console.log(
-      `Note: This is a confidential transaction - the amount is not visible on-chain.`,
+      `Note: This is a confidential transaction - the amount is not visible onchain.`,
     );
   }
 }