How jhad00/shamy works
Shamy is a Node.js client library for ShamCash. Applications initialize ShamClient, which restores a saved session or creates QR credentials and polls ShamCash until authentication succeeds; its events report connection state and readiness. Once authenticated, callers use account, transfer, history, and wallet managers for profile and balance retrieval, receiving QR codes, transfers, transaction logs and monitoring, and external-wallet cash-in or Syriatel recharge. API managers encrypt requests and decrypt responses through ShamCrypto. Source excerpts support the main calls and data transfers; some documented capabilities are not independently visible in sampled implementation details.
Main entry points: Client.js ShamClient · Account.js Account services · History.js History and monitoring · Transfer.js Transfer services
Components 13
Client and sessions
- ShamClient
src/Client.js - Session file
src/Client.js - ShamCash session API
Payload security
- ShamCrypto
src/Crypto.js - Endpoint and key constants
src/Constants.js
Account services
- Account services
src/api/Account.js - Receive QR
src/api/Account.js - ShamCash API
Payments and activity
- Transfer services
src/api/Transfer.js - History and monitoring
src/api/History.js - Wallet and recharge services
src/api/Wallets.js - ShamCash bank API
Other components
- Node.js application
Connections 28
- Node.js application → ShamClient: initializes
README.md - ShamClient → Session file: loads and saves
src/Client.js - ShamClient → ShamCrypto: encrypts and decrypts
src/Client.js - ShamClient → ShamCash session API: polls
src/Client.js - ShamClient → Endpoint and key constants: reads endpoints and key
src/Client.js - ShamClient → Account services: creates manager
src/Client.js - ShamClient → Transfer services: creates manager
src/Client.js - ShamClient → History and monitoring: creates manager
src/Client.js - ShamClient → Wallet and recharge services: creates manager
src/Client.js - Node.js application → Account services: requests account data
README.md - Node.js application → Transfer services: requests transfers
README.md - Node.js application → History and monitoring: requests logs or monitoring
README.md - Node.js application → Wallet and recharge services: requests wallet operations
README.md - Account services → ShamCrypto: encrypts and decrypts
src/api/Account.js - Account services → Endpoint and key constants: reads API endpoint
src/api/Account.js - Account services → ShamCash API: requests account data
src/api/Account.js - Account services → Receive QR: fetches address for
src/api/Account.js - Receive QR → Account services: gets profile
src/api/Account.js - Transfer services → ShamCrypto: encrypts and decrypts
src/api/Transfer.js - Transfer services → Endpoint and key constants: reads API endpoint
src/api/Transfer.js - Transfer services → ShamCash API: resolves and transfers
src/api/Transfer.js - History and monitoring → ShamCrypto: encrypts and decrypts
src/api/History.js - History and monitoring → Endpoint and key constants: reads API endpoint
src/api/History.js - History and monitoring → ShamCash API: fetches transaction logs
src/api/History.js - History and monitoring → History and monitoring: emits new transactions
src/api/History.js - Wallet and recharge services → ShamCrypto: encrypts and decrypts
src/api/Wallets.js - Wallet and recharge services → Endpoint and key constants: reads bank endpoint
src/api/Wallets.js - Wallet and recharge services → ShamCash bank API: sends wallet operations
src/api/Wallets.js