@mistcash/config 0.5.0 → 0.5.2

package/.turbo/turbo-build.log

@@ -0,0 +1,19 @@
+
+
+> @mistcash/config@0.5.1 build /Users/shramee/www/crypto/mono/sdk/config
+> tsup src/index.ts --format cjs,esm --dts
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.0
+CLI Target: es2020
+CJS Build start
+ESM Build start
+CJS dist/index.js 26.72 KB
+CJS ⚡️ Build success in 47ms
+ESM dist/index.mjs 25.58 KB
+ESM ⚡️ Build success in 47ms
+DTS Build start
+DTS ⚡️ Build success in 705ms
+DTS dist/index.d.ts  20.85 KB
+DTS dist/index.d.mts 20.85 KB

package/dist/index.d.mts

@@ -95,7 +95,7 @@ declare const CHAMBER_ABI: readonly [{
             readonly name: "claiming_key";
             readonly type: "core::integer::u256";
         }, {
-            readonly name: "recipient";
+            readonly name: "owner";
             readonly type: "core::starknet::contract_address::ContractAddress";
         }, {
             readonly name: "asset";
@@ -113,7 +113,7 @@ declare const CHAMBER_ABI: readonly [{
             readonly name: "claiming_key";
             readonly type: "core::integer::u256";
         }, {
-            readonly name: "recipient";
+            readonly name: "owner";
             readonly type: "core::starknet::contract_address::ContractAddress";
         }, {
             readonly name: "asset";

package/dist/index.d.ts

@@ -95,7 +95,7 @@ declare const CHAMBER_ABI: readonly [{
             readonly name: "claiming_key";
             readonly type: "core::integer::u256";
         }, {
-            readonly name: "recipient";
+            readonly name: "owner";
             readonly type: "core::starknet::contract_address::ContractAddress";
         }, {
             readonly name: "asset";
@@ -113,7 +113,7 @@ declare const CHAMBER_ABI: readonly [{
             readonly name: "claiming_key";
             readonly type: "core::integer::u256";
         }, {
-            readonly name: "recipient";
+            readonly name: "owner";
             readonly type: "core::starknet::contract_address::ContractAddress";
         }, {
             readonly name: "asset";

package/dist/index.js

@@ -29,7 +29,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/contracts.ts
-var CHAMBER_ADDR_MAINNET = process.env.CHAMBER_ADDR_MAINNET || "0x03a889eb7aecedcb76b987fc981ad3b92689cf45bffec8c1c409a4b0b79c3f31";
+var CHAMBER_ADDR_MAINNET = process.env.CHAMBER_ADDR_MAINNET || "0x06f8dcc500131b6be6b33f4534ec6d33df33e61083ec2b051555d52e75654444";
 var CHAMBER_ABI = [
   {
     "type": "impl",
@@ -160,7 +160,7 @@ var CHAMBER_ABI = [
             "type": "core::integer::u256"
           },
           {
-            "name": "recipient",
+            "name": "owner",
             "type": "core::starknet::contract_address::ContractAddress"
           },
           {
@@ -184,7 +184,7 @@ var CHAMBER_ABI = [
             "type": "core::integer::u256"
           },
           {
-            "name": "recipient",
+            "name": "owner",
             "type": "core::starknet::contract_address::ContractAddress"
           },
           {

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // src/contracts.ts
-var CHAMBER_ADDR_MAINNET = process.env.CHAMBER_ADDR_MAINNET || "0x03a889eb7aecedcb76b987fc981ad3b92689cf45bffec8c1c409a4b0b79c3f31";
+var CHAMBER_ADDR_MAINNET = process.env.CHAMBER_ADDR_MAINNET || "0x06f8dcc500131b6be6b33f4534ec6d33df33e61083ec2b051555d52e75654444";
 var CHAMBER_ABI = [
   {
     "type": "impl",
@@ -130,7 +130,7 @@ var CHAMBER_ABI = [
             "type": "core::integer::u256"
           },
           {
-            "name": "recipient",
+            "name": "owner",
             "type": "core::starknet::contract_address::ContractAddress"
           },
           {
@@ -154,7 +154,7 @@ var CHAMBER_ABI = [
             "type": "core::integer::u256"
           },
           {
-            "name": "recipient",
+            "name": "owner",
             "type": "core::starknet::contract_address::ContractAddress"
           },
           {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mistcash/config",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -18,7 +18,7 @@
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "starknet": "^8.9.0"
+    "starknet": "^9.2.1"
   },
   "devDependencies": {
     "@types/jest": "^29.5.0",

package/readme.md

@@ -1,25 +1,313 @@
 # @mistcash/config
 
-MIST SDK config
+Configuration package for MIST SDK providing contract ABIs, addresses, and token definitions for the Starknet ecosystem.
 
 ## Installation
 
-```sh
+```bash
+npm install @mistcash/config
+# or
 pnpm add @mistcash/config
+# or
+yarn add @mistcash/config
 ```
 
-## Usage
+## Overview
 
-```js
-import { CHAMBER_ABI, CHAMBER_ADDR_MAINNET, ChamberTypedContract } from '@mistcash/config';
+This package exports:
+- **Contract ABIs**: Chamber and ERC20 contract interfaces
+- **Contract Addresses**: Mainnet addresses for MIST contracts
+- **Token Definitions**: Supported tokens with metadata
+- **TypeScript Types**: Fully typed contract interfaces
 
-// Do something with the ABIs and other config data
+## Contract ABIs & Addresses
+
+### Chamber Contract
+
+The main MIST protocol contract for private transactions.
+
+#### `CHAMBER_ADDR_MAINNET`
+
+The Chamber contract address on Starknet mainnet.
+
+```typescript
+import { CHAMBER_ADDR_MAINNET } from '@mistcash/config';
+
+console.log(CHAMBER_ADDR_MAINNET);
+// '0x06f8dcc500131b6be6b33f4534ec6d33df33e61083ec2b051555d52e75654444'
+```
+
+**Type:** `0x${string}`
+
+**Environment Variable:** Can be overridden with `CHAMBER_ADDR_MAINNET` environment variable.
+
+---
+
+#### `CHAMBER_ABI`
+
+Complete ABI for the Chamber contract including all functions and events.
+
+```typescript
+import { CHAMBER_ABI } from '@mistcash/config';
+import { Contract } from 'starknet';
+
+const chamber = new Contract({
+  abi: CHAMBER_ABI,
+  address: CHAMBER_ADDR_MAINNET,
+  provider
+});
+```
+
+**Key Functions in Chamber ABI:**
+
+- `deposit(hash: u256, asset: Asset)` - Deposit tokens into the chamber
+- `withdraw_no_zk(claiming_key, owner, asset, proof)` - Withdraw without ZK proof
+- `seek_and_hide_no_zk(claiming_key, owner, asset, proof, new_tx_secret, new_tx_amount)` - Transfer without ZK
+- `handle_zkp(proof: Span<felt252>)` - Process ZK proof for private transactions
+- `tx_array()` - Get all transaction leaves
+- `merkle_root()` - Get current Merkle root
+- `merkle_proof(index: u32)` - Get Merkle proof for transaction at index
+- `merkle_leaves(height: u32)` - Get leaves at specific tree height
+- `assets_from_secret(tx_secret: u256)` - Retrieve asset info from transaction secret
+- `nullifiers_spent(nullifiers: Array<u256>)` - Check if nullifiers have been spent
+- `transactions_exist(transactions: Array<u256>)` - Check if transactions exist
+- `setVerifierAddress(verifier)` - Set the Groth16 verifier contract address
+- `recalculate_merkle_root()` - Recalculate Merkle root from leaves
+
+---
+
+#### `ChamberTypedContract`
+
+TypeScript type for the typed Chamber contract interface.
+
+```typescript
+import { ChamberTypedContract, CHAMBER_ABI, CHAMBER_ADDR_MAINNET } from '@mistcash/config';
+import { Contract, ProviderInterface } from 'starknet';
+
+function getChamber(provider: ProviderInterface): ChamberTypedContract {
+  return new Contract({
+    abi: CHAMBER_ABI,
+    address: CHAMBER_ADDR_MAINNET,
+    provider
+  }).typedv2(CHAMBER_ABI);
+}
 ```
 
-## Contributing
+**Type:** `TypedContractV2<typeof CHAMBER_ABI>`
 
-Head over to https://github.com/mistcash/sdk for details.
+---
+
+### ERC20 Contract
+
+Standard ERC20 token ABI for Starknet.
+
+#### `ERC20_ABI`
+
+Complete ERC20 ABI following OpenZeppelin standards.
+
+```typescript
+import { ERC20_ABI } from '@mistcash/config';
+import { Contract } from 'starknet';
+
+const token = new Contract({
+  abi: ERC20_ABI,
+  address: tokenAddress,
+  provider
+});
+
+const balance = await token.balance_of(userAddress);
+```
+
+**Key Functions:**
+
+- `total_supply()` - Get total token supply
+- `balance_of(account)` - Get account balance
+- `allowance(owner, spender)` - Get spending allowance
+- `transfer(recipient, amount)` - Transfer tokens
+- `transfer_from(sender, recipient, amount)` - Transfer from approved account
+- `approve(spender, amount)` - Approve spending allowance
+- `name()` - Get token name
+- `symbol()` - Get token symbol
+- `decimals()` - Get token decimals
+
+---
+
+## Token Definitions
+
+### Token Interface
+
+```typescript
+interface Token {
+  id: string;           // Contract address (hex string)
+  name: string;         // Token symbol (e.g., 'ETH', 'USDC')
+  icon?: string;        // SVG icon markup
+  color: string;        // Primary color for UI
+  textColor: string;    // Text color for contrast
+  decimals?: number;    // Token decimal places
+}
+```
+
+---
+
+### `tokensData`
+
+Array of supported tokens with metadata.
+
+```typescript
+import { tokensData } from '@mistcash/config';
+
+tokensData.forEach(token => {
+  console.log(`${token.name}: ${token.id}`);
+});
+```
+
+**Included Tokens Details:**
+
+MIST supports any ERC20 token, but here are popular ones for convenience
+
+| Name | Address                                                            | Decimals | Color       |
+| ---- | ------------------------------------------------------------------ | -------- | ----------- |
+| ETH  | 0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7 | 18       | #5f7edd     |
+| STRK | 0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d | 18       | #EC796B     |
+| USDC | 0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8 | 6        | #2775ca     |
+| USDT | 0x068f5c6a61780768455de69077e07e89787839bf8166decfbf92b645209c0fb8 | 6        | transparent |
+| DAI  | 0x00da114221cb83fa859dbdb4c44beeaa0bb37c7537ad5ae66fe5e0efd20e6eb3 | 18       | #F4B731     |
+
+---
+
+### `tokensMap`
+
+Map of token addresses to token objects for quick lookups.
+
+```typescript
+import { tokensMap } from '@mistcash/config';
+
+const tokenAddress = '0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7';
+const token = tokensMap[tokenAddress];
+
+console.log(token.name);      // 'ETH'
+console.log(token.decimals);  // 18
+console.log(token.color);     // '#5f7edd'
+```
+
+**Type:** `{ [key: string]: Token }`
+
+---
+
+## Complete Usage Example
+
+```typescript
+import { 
+  CHAMBER_ABI, 
+  CHAMBER_ADDR_MAINNET, 
+  ChamberTypedContract,
+  ERC20_ABI,
+  tokensData,
+  tokensMap,
+  Token
+} from '@mistcash/config';
+import { Contract, RpcProvider } from 'starknet';
+
+// Setup provider
+const provider = new RpcProvider({ 
+  nodeUrl: 'https://starknet-mainnet.public.blastapi.io' 
+});
+
+// Get typed Chamber contract
+const chamber: ChamberTypedContract = new Contract({
+  abi: CHAMBER_ABI,
+  address: CHAMBER_ADDR_MAINNET,
+  provider
+}).typedv2(CHAMBER_ABI);
+
+// Use chamber contract
+const txArray = await chamber.tx_array();
+const merkleRoot = await chamber.merkle_root();
+
+// Work with tokens
+const ethToken = tokensMap['0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7'];
+console.log(`${ethToken.name} has ${ethToken.decimals} decimals`);
+
+// Get ERC20 contract
+const erc20 = new Contract({
+  abi: ERC20_ABI,
+  address: ethToken.id,
+  provider
+});
+
+const balance = await erc20.balance_of(userAddress);
+```
+
+## UI Integration
+
+The token data includes SVG icons and colors for easy UI integration:
+
+```tsx
+import { tokensData } from '@mistcash/config';
+
+function TokenSelector() {
+  return (
+    <div>
+      {tokensData.map(token => (
+        <div 
+          key={token.id}
+          style={{ 
+            backgroundColor: token.color, 
+            color: token.textColor 
+          }}
+        >
+          {token.icon && (
+            <div dangerouslySetInnerHTML={{ __html: token.icon }} />
+          )}
+          <span>{token.name}</span>
+        </div>
+      ))}
+    </div>
+  );
+}
+```
+
+## TypeScript Support
+
+All exports are fully typed for excellent TypeScript support:
+
+```typescript
+import type { Token, ChamberTypedContract } from '@mistcash/config';
+
+// Token operations are type-safe
+const processToken = (token: Token) => {
+  const amount = BigInt(1000) * BigInt(10 ** (token.decimals || 18));
+  return amount;
+};
+
+// Contract calls are type-checked
+const queryContract = async (contract: ChamberTypedContract) => {
+  const root = await contract.merkle_root(); // Returns bigint
+  const leaves = await contract.tx_array();   // Returns bigint[]
+};
+```
+
+## Environment Variables
+
+- `CHAMBER_ADDR_MAINNET`: Override the default Chamber contract address
+
+```bash
+# .env
+CHAMBER_ADDR_MAINNET=0x1234567890abcdef...
+```
+
+## Dependencies
+
+- `starknet` ^9.2.1 - Starknet.js library for contract interactions
 
 ## License
 
 MIT
+
+## Repository
+
+https://github.com/mistcash/sdk
+
+## Issues
+
+https://github.com/mistcash/sdk/issues

package/src/contracts.ts

@@ -1,7 +1,7 @@
 import { Abi, TypedContractV2 } from 'starknet';
 
 export const CHAMBER_ADDR_MAINNET = (process.env.CHAMBER_ADDR_MAINNET ||
-  '0x03a889eb7aecedcb76b987fc981ad3b92689cf45bffec8c1c409a4b0b79c3f31') as `0x${string}`;
+  '0x06f8dcc500131b6be6b33f4534ec6d33df33e61083ec2b051555d52e75654444') as `0x${string}`;
 
 export const CHAMBER_ABI = [
   {
@@ -133,7 +133,7 @@ export const CHAMBER_ABI = [
             "type": "core::integer::u256"
           },
           {
-            "name": "recipient",
+            "name": "owner",
             "type": "core::starknet::contract_address::ContractAddress"
           },
           {
@@ -157,7 +157,7 @@ export const CHAMBER_ABI = [
             "type": "core::integer::u256"
           },
           {
-            "name": "recipient",
+            "name": "owner",
             "type": "core::starknet::contract_address::ContractAddress"
           },
           {

package/src/tokens.ts

@@ -7,6 +7,7 @@ export interface Token {
   decimals?: number;
 }
 
+// MIST supports any ERC20 token, but here are popular ones for convenience
 export const tokensData: Token[] = [
   {
     id: '0x49d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7',