@chipi-stack/types 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,274 @@
+import { TypedData, Call } from 'starknet';
+
+/**
+ * Core configuration and environment types
+ */
+interface ChipiSDKConfig {
+    apiPublicKey: string;
+    environment?: 'development' | 'production';
+    nodeUrl?: string;
+}
+type Environment = 'development' | 'production';
+type Chain = 'STARKNET_MAINNET' | 'STARKNET_SEPOLIA';
+type ChainToken = 'USDC' | 'USDT' | 'ETH' | 'STRK' | 'DAI';
+interface PaginationQuery {
+    page?: number;
+    limit?: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+
+/**
+ * Wallet-related types
+ */
+interface WalletData {
+    publicKey: string;
+    encryptedPrivateKey: string;
+}
+interface CreateWalletParams {
+    encryptKey: string;
+    apiPublicKey: string;
+    bearerToken: string;
+}
+interface CreateWalletParams {
+    encryptKey: string;
+    bearerToken: string;
+    apiPublicKey: string;
+    nodeUrl?: string;
+}
+interface CreateWalletResponse {
+    success: boolean;
+    txHash: string;
+    walletPublicKey: string;
+    wallet: WalletData;
+}
+interface PrepareWalletCreationParams {
+    encryptKey: string;
+    apiPublicKey: string;
+}
+interface PrepareWalletCreationResponse {
+    typeData: TypedData;
+    accountClassHash: string;
+}
+interface CreateCustodialWalletParams {
+    chain: Chain;
+    orgId: string;
+}
+interface GetMerchantWalletParams {
+    apiKeyId: string;
+    chain: Chain;
+    orgId: string;
+}
+
+/**
+ * Transaction-related types
+ */
+interface ExecuteTransactionParams {
+    encryptKey: string;
+    wallet: WalletData;
+    calls: Call[];
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface Transaction {
+    id: string;
+    chain: 'STARKNET' | 'BASE' | 'ARBITRUM' | 'OPTIMISM' | 'ROOTSTOCK' | 'SCROLL' | 'WORLDCHAIN';
+    apiPublicKey: string;
+    transactionHash: string;
+    blockNumber: number;
+    senderAddress: string;
+    destinationAddress: string;
+    amount: string;
+    token: 'USDC' | 'USDT' | 'DAI' | 'ETH' | 'STRK' | 'SLINK' | 'ALF' | 'BROTHER' | 'ARB' | 'DOC' | 'MXNB' | 'WLD';
+    calledFunction?: string;
+    amountInUSD: number;
+    status: string;
+    isChipiWallet: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface PrepareTypedDataParams {
+    calls: Call[];
+    walletAddress: string;
+}
+interface ExecuteSponsoredTransactionParams {
+    calls: Call[];
+    walletAddress: string;
+    signature: string[];
+    apiPublicKey: string;
+}
+interface ExecuteSponsoredTransactionResponse {
+    transactionHash: string;
+    success: boolean;
+}
+interface RecordSendTransactionParams {
+    walletAddress: string;
+    transactionHash: string;
+    amount: number;
+    chain: Chain;
+    chainToken: ChainToken;
+    apiKey: any;
+}
+interface TransferParams {
+    encryptKey: string;
+    wallet: WalletData;
+    contractAddress: string;
+    recipient: string;
+    amount: string | number;
+    decimals?: number;
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface ApproveParams {
+    encryptKey: string;
+    wallet: WalletData;
+    contractAddress: string;
+    spender: string;
+    amount: string | number;
+    decimals?: number;
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface StakeVesuUsdcParams {
+    encryptKey: string;
+    wallet: WalletData;
+    amount: string | number;
+    receiverWallet: string;
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface WithdrawVesuUsdcParams {
+    encryptKey: string;
+    wallet: WalletData;
+    amount: string | number;
+    recipient: string;
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface CallAnyContractParams {
+    encryptKey: string;
+    wallet: WalletData;
+    contractAddress: string;
+    calls: Call[];
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface GetTransactionsParams {
+    page?: number;
+    limit?: number;
+    orgId: string;
+}
+
+/**
+ * SKU (Stock Keeping Unit) related types
+ */
+type SkuCategory = 'MOBILE_RECHARGE' | 'UTILITIES' | 'ENTERTAINMENT' | 'GIFT_CARDS' | 'TRANSPORTATION';
+interface Sku {
+    id: string;
+    name: string;
+    description?: string;
+    category: SkuCategory;
+    price: number;
+    currency: string;
+    isActive: boolean;
+    metadata?: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface FindSkusParams {
+    categories?: SkuCategory[];
+}
+interface FindSkusResponse {
+    skus: Sku[];
+}
+interface CreateSkuTransactionParams {
+    walletAddress: string;
+    skuId: string;
+    chain: Chain;
+    chainToken: ChainToken;
+    mxnAmount: number;
+    reference: string;
+    transactionHash: string;
+    apiKey: any;
+}
+interface SkuTransaction {
+    id: string;
+    walletAddress: string;
+    skuId: string;
+    sku?: Sku;
+    chain: Chain;
+    chainToken: ChainToken;
+    mxnAmount: number;
+    reference: string;
+    transactionHash: string;
+    status: 'PENDING' | 'COMPLETED' | 'FAILED' | 'CANCELLED';
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+/**
+ * API-related types and interfaces
+ */
+interface ApiKey {
+    id: string;
+    publicKey: string;
+    secretKey: string;
+    environment: 'development' | 'production';
+    isActive: boolean;
+    orgId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface ApiResponse<T = any> {
+    success: boolean;
+    data?: T;
+    error?: string;
+    message?: string;
+}
+interface ApiError {
+    code: string;
+    message: string;
+    details?: any;
+}
+interface AuthContext {
+    apiKey: ApiKey;
+    orgId: string;
+    userId?: string;
+}
+interface JwtPayload {
+    sub: string;
+    iss: string;
+    aud: string;
+    exp: number;
+    iat: number;
+    [key: string]: any;
+}
+
+/**
+ * Utility types and helper interfaces
+ */
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+type NonEmptyArray<T> = [T, ...T[]];
+interface ErrorWithCode extends Error {
+    code?: string;
+    status?: number;
+}
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (...args: any) => Promise<infer R> ? R : any;
+type ValueOrFunction<T> = T | (() => T);
+type MaybePromise<T> = T | Promise<T>;
+
+export type { ApiError, ApiKey, ApiResponse, ApproveParams, AsyncReturnType, AuthContext, CallAnyContractParams, Chain, ChainToken, ChipiSDKConfig, CreateCustodialWalletParams, CreateSkuTransactionParams, CreateWalletParams, CreateWalletResponse, DeepPartial, Environment, ErrorWithCode, ExecuteSponsoredTransactionParams, ExecuteSponsoredTransactionResponse, ExecuteTransactionParams, FindSkusParams, FindSkusResponse, GetMerchantWalletParams, GetTransactionsParams, JwtPayload, MaybePromise, NonEmptyArray, Optional, PaginatedResponse, PaginationQuery, PrepareTypedDataParams, PrepareWalletCreationParams, PrepareWalletCreationResponse, Prettify, RecordSendTransactionParams, RequireAtLeastOne, Sku, SkuCategory, SkuTransaction, StakeVesuUsdcParams, Transaction, TransferParams, ValueOrFunction, WalletData, WithdrawVesuUsdcParams };

package/dist/index.d.ts

@@ -0,0 +1,274 @@
+import { TypedData, Call } from 'starknet';
+
+/**
+ * Core configuration and environment types
+ */
+interface ChipiSDKConfig {
+    apiPublicKey: string;
+    environment?: 'development' | 'production';
+    nodeUrl?: string;
+}
+type Environment = 'development' | 'production';
+type Chain = 'STARKNET_MAINNET' | 'STARKNET_SEPOLIA';
+type ChainToken = 'USDC' | 'USDT' | 'ETH' | 'STRK' | 'DAI';
+interface PaginationQuery {
+    page?: number;
+    limit?: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+
+/**
+ * Wallet-related types
+ */
+interface WalletData {
+    publicKey: string;
+    encryptedPrivateKey: string;
+}
+interface CreateWalletParams {
+    encryptKey: string;
+    apiPublicKey: string;
+    bearerToken: string;
+}
+interface CreateWalletParams {
+    encryptKey: string;
+    bearerToken: string;
+    apiPublicKey: string;
+    nodeUrl?: string;
+}
+interface CreateWalletResponse {
+    success: boolean;
+    txHash: string;
+    walletPublicKey: string;
+    wallet: WalletData;
+}
+interface PrepareWalletCreationParams {
+    encryptKey: string;
+    apiPublicKey: string;
+}
+interface PrepareWalletCreationResponse {
+    typeData: TypedData;
+    accountClassHash: string;
+}
+interface CreateCustodialWalletParams {
+    chain: Chain;
+    orgId: string;
+}
+interface GetMerchantWalletParams {
+    apiKeyId: string;
+    chain: Chain;
+    orgId: string;
+}
+
+/**
+ * Transaction-related types
+ */
+interface ExecuteTransactionParams {
+    encryptKey: string;
+    wallet: WalletData;
+    calls: Call[];
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface Transaction {
+    id: string;
+    chain: 'STARKNET' | 'BASE' | 'ARBITRUM' | 'OPTIMISM' | 'ROOTSTOCK' | 'SCROLL' | 'WORLDCHAIN';
+    apiPublicKey: string;
+    transactionHash: string;
+    blockNumber: number;
+    senderAddress: string;
+    destinationAddress: string;
+    amount: string;
+    token: 'USDC' | 'USDT' | 'DAI' | 'ETH' | 'STRK' | 'SLINK' | 'ALF' | 'BROTHER' | 'ARB' | 'DOC' | 'MXNB' | 'WLD';
+    calledFunction?: string;
+    amountInUSD: number;
+    status: string;
+    isChipiWallet: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface PrepareTypedDataParams {
+    calls: Call[];
+    walletAddress: string;
+}
+interface ExecuteSponsoredTransactionParams {
+    calls: Call[];
+    walletAddress: string;
+    signature: string[];
+    apiPublicKey: string;
+}
+interface ExecuteSponsoredTransactionResponse {
+    transactionHash: string;
+    success: boolean;
+}
+interface RecordSendTransactionParams {
+    walletAddress: string;
+    transactionHash: string;
+    amount: number;
+    chain: Chain;
+    chainToken: ChainToken;
+    apiKey: any;
+}
+interface TransferParams {
+    encryptKey: string;
+    wallet: WalletData;
+    contractAddress: string;
+    recipient: string;
+    amount: string | number;
+    decimals?: number;
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface ApproveParams {
+    encryptKey: string;
+    wallet: WalletData;
+    contractAddress: string;
+    spender: string;
+    amount: string | number;
+    decimals?: number;
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface StakeVesuUsdcParams {
+    encryptKey: string;
+    wallet: WalletData;
+    amount: string | number;
+    receiverWallet: string;
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface WithdrawVesuUsdcParams {
+    encryptKey: string;
+    wallet: WalletData;
+    amount: string | number;
+    recipient: string;
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface CallAnyContractParams {
+    encryptKey: string;
+    wallet: WalletData;
+    contractAddress: string;
+    calls: Call[];
+    bearerToken: string;
+    apiPublicKey: string;
+}
+interface GetTransactionsParams {
+    page?: number;
+    limit?: number;
+    orgId: string;
+}
+
+/**
+ * SKU (Stock Keeping Unit) related types
+ */
+type SkuCategory = 'MOBILE_RECHARGE' | 'UTILITIES' | 'ENTERTAINMENT' | 'GIFT_CARDS' | 'TRANSPORTATION';
+interface Sku {
+    id: string;
+    name: string;
+    description?: string;
+    category: SkuCategory;
+    price: number;
+    currency: string;
+    isActive: boolean;
+    metadata?: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface FindSkusParams {
+    categories?: SkuCategory[];
+}
+interface FindSkusResponse {
+    skus: Sku[];
+}
+interface CreateSkuTransactionParams {
+    walletAddress: string;
+    skuId: string;
+    chain: Chain;
+    chainToken: ChainToken;
+    mxnAmount: number;
+    reference: string;
+    transactionHash: string;
+    apiKey: any;
+}
+interface SkuTransaction {
+    id: string;
+    walletAddress: string;
+    skuId: string;
+    sku?: Sku;
+    chain: Chain;
+    chainToken: ChainToken;
+    mxnAmount: number;
+    reference: string;
+    transactionHash: string;
+    status: 'PENDING' | 'COMPLETED' | 'FAILED' | 'CANCELLED';
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+/**
+ * API-related types and interfaces
+ */
+interface ApiKey {
+    id: string;
+    publicKey: string;
+    secretKey: string;
+    environment: 'development' | 'production';
+    isActive: boolean;
+    orgId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface ApiResponse<T = any> {
+    success: boolean;
+    data?: T;
+    error?: string;
+    message?: string;
+}
+interface ApiError {
+    code: string;
+    message: string;
+    details?: any;
+}
+interface AuthContext {
+    apiKey: ApiKey;
+    orgId: string;
+    userId?: string;
+}
+interface JwtPayload {
+    sub: string;
+    iss: string;
+    aud: string;
+    exp: number;
+    iat: number;
+    [key: string]: any;
+}
+
+/**
+ * Utility types and helper interfaces
+ */
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+type NonEmptyArray<T> = [T, ...T[]];
+interface ErrorWithCode extends Error {
+    code?: string;
+    status?: number;
+}
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (...args: any) => Promise<infer R> ? R : any;
+type ValueOrFunction<T> = T | (() => T);
+type MaybePromise<T> = T | Promise<T>;
+
+export type { ApiError, ApiKey, ApiResponse, ApproveParams, AsyncReturnType, AuthContext, CallAnyContractParams, Chain, ChainToken, ChipiSDKConfig, CreateCustodialWalletParams, CreateSkuTransactionParams, CreateWalletParams, CreateWalletResponse, DeepPartial, Environment, ErrorWithCode, ExecuteSponsoredTransactionParams, ExecuteSponsoredTransactionResponse, ExecuteTransactionParams, FindSkusParams, FindSkusResponse, GetMerchantWalletParams, GetTransactionsParams, JwtPayload, MaybePromise, NonEmptyArray, Optional, PaginatedResponse, PaginationQuery, PrepareTypedDataParams, PrepareWalletCreationParams, PrepareWalletCreationResponse, Prettify, RecordSendTransactionParams, RequireAtLeastOne, Sku, SkuCategory, SkuTransaction, StakeVesuUsdcParams, Transaction, TransferParams, ValueOrFunction, WalletData, WithdrawVesuUsdcParams };

package/dist/index.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/index.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.mjs"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@chipi-stack/types",
+  "version": "0.1.0",
+  "description": "Type definitions for Chipi SDK packages",
+  "keywords": [
+    "chipi",
+    "blockchain",
+    "starknet",
+    "wallet",
+    "types",
+    "typescript"
+  ],
+  "homepage": "https://github.com/chipi-pay/chipi-sdk",
+  "bugs": {
+    "url": "https://github.com/chipi-pay/chipi-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chipi-pay/chipi-sdk.git",
+    "directory": "sdks/types"
+  },
+  "license": "MIT",
+  "author": "Chipi Pay",
+  "main": "dist/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup --env.NODE_ENV production",
+    "build:declarations": "tsc -p tsconfig.declarations.json",
+    "clean": "rimraf ./dist",
+    "dev": "tsup --watch",
+    "format": "prettier --write src/**/*.ts",
+    "format:check": "prettier --check src/**/*.ts",
+    "lint": "eslint src",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "starknet": ">=6.23.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.15",
+    "eslint": "^9.33.0",
+    "prettier": "^3.0.0",
+    "rimraf": "^5.0.0",
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3"
+  },
+  "engines": {
+    "node": ">=18.17.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}