Lightweight TypeScript client extracted from Stake Engine web-sdk for RGS (Remote Gaming Server) API communication. Contains only essential backend communication code without Svelte dependencies or slot game scripts.
Live Demo | Getting Started Guide | API Documentation
- 🚀 Lightweight: Only essential RGS communication code
- 📱 Framework Agnostic: Works with any JavaScript framework
- 🔒 Type Safe: Full TypeScript support with auto-generated types
- 🎯 Simple API: High-level methods for common operations
- 🔧 Configurable: Low-level access for custom implementations
- 💰 Smart Conversion: Automatic amount conversion between formats
npm install stake-engine-clientIf your URL contains the required parameters (?sessionID=player-123&rgs_url=api.stakeengine.com&lang=en¤cy=USD), you can call functions without options:
import { authenticate, play } from 'stake-engine-client';
// Authenticate player (uses URL params automatically)
const auth = await authenticate();
console.log('Player balance:', auth.balance?.amount);
console.log('Available bet levels:', auth.config?.betLevels);
// Place a bet (only specify required bet details)
const bet = await play({
amount: 1.00, // $1.00 (automatically converted)
mode: 'base'
// currency defaults to USD from URL param or 'USD'
});
console.log('Round ID:', bet.round?.roundID);
console.log('Payout multiplier:', bet.round?.payoutMultiplier);import { authenticate, play } from 'stake-engine-client';
// Authenticate player
const auth = await authenticate({
sessionID: 'player-session-123',
rgsUrl: 'api.stakeengine.com',
language: 'en'
});
console.log('Player balance:', auth.balance?.amount);
console.log('Available bet levels:', auth.config?.betLevels);
// Place a bet
const bet = await play({
sessionID: 'player-session-123',
currency: 'USD',
amount: 1.00, // $1.00 (automatically converted)
mode: 'base',
rgsUrl: 'api.stakeengine.com'
});
console.log('Round ID:', bet.round?.roundID);
console.log('Payout multiplier:', bet.round?.payoutMultiplier);Authenticate a player session with the RGS.
// Uses URL parameters automatically
const auth = await authenticate();
// Or provide explicit options
const auth = await authenticate({
sessionID?: string, // From URL param 'sessionID' if not provided
rgsUrl?: string, // From URL param 'rgs_url' if not provided
language?: string // From URL param 'lang' if not provided (defaults to 'en')
});URL Parameters:
sessionID- Player session IDrgs_url- RGS server URLlang- Language code (optional, defaults to 'en')currency- Currency code (optional, defaults to 'USD')
Returns: AuthenticateResponse
balance- Player's current balanceconfig- Game configuration including bet levelsround- Active round information (if any)status- Operation status
Place a bet and start a new round.
// Uses URL parameters for sessionID/rgsUrl/currency automatically
const bet = await play({
amount: number, // Required: Dollar amount (e.g., 1.00 for $1)
mode: string, // Required: Bet mode (e.g., 'base')
currency?: string, // From URL param 'currency' if not provided (defaults to 'USD')
sessionID?: string, // From URL param 'sessionID' if not provided
rgsUrl?: string // From URL param 'rgs_url' if not provided
});Returns: PlayResponse
round- Round details including payout and multiplierbalance- Updated player balancestatus- Operation status
End the current betting round.
// Uses URL parameters automatically
const result = await endRound();
// Or provide explicit options
const result = await endRound({
sessionID?: string, // From URL param 'sessionID' if not provided
rgsUrl?: string // From URL param 'rgs_url' if not provided
});Get current player balance.
// Uses URL parameters automatically
const balance = await getBalance();
// Or provide explicit options
const balance = await getBalance({
sessionID?: string, // From URL param 'sessionID' if not provided
rgsUrl?: string // From URL param 'rgs_url' if not provided
});Track a game event for bet progress.
const result = await endEvent({
eventIndex: number, // Required: Event index number
sessionID?: string, // From URL param 'sessionID' if not provided
rgsUrl?: string // From URL param 'rgs_url' if not provided
});Fetch historical bet data for replay/review purposes.
const replay = await replay({
game: string, // Required: Game identifier
version: string, // Required: Game version
mode: string, // Required: Bet mode
event: string, // Required: Event identifier
rgsUrl?: string // From URL param 'rgs_url' if not provided
});Returns: ReplayResponse
round- Historical round details including game statestatus- Operation status
Check if the current session is in replay mode.
if (isReplayMode()) {
// Handle replay mode
}Get all replay-related URL parameters.
const params = getReplayUrlParams();
// Returns: { replay, amount, game, version, mode, event }URL Parameters for Replay:
replay- Set to 'true' to enable replay modeamount- Original bet amountgame- Game identifierversion- Game versionmode- Bet modeevent- Event identifier
Search for specific game results (useful for testing).
const results = await forceResult({
mode: string, // Required: Search mode
search: { // Required: Search criteria
bookID?: number,
kind?: number,
symbol?: string,
hasWild?: boolean,
wildMult?: number,
gameType?: string
},
rgsUrl?: string // From URL param 'rgs_url' if not provided
});import { StakeEngineClient } from 'stake-engine-client';
const client = new StakeEngineClient();
// Make custom API calls with full type safety
const response = await client.post({
url: '/wallet/authenticate',
rgsUrl: 'api.stakeengine.com',
variables: {
sessionID: 'player-123',
language: 'en'
}
});import { fetcher } from 'stake-engine-client';
const response = await fetcher({
method: 'POST',
endpoint: 'https://api.stakeengine.com/wallet/play',
variables: { sessionID: 'abc123', amount: 1000000 }
});
const data = await response.json();The client automatically handles amount conversion between different formats:
import { API_AMOUNT_MULTIPLIER, BOOK_AMOUNT_MULTIPLIER } from 'stake-engine-client';
// API format: 1,000,000 = $1.00
const apiAmount = 1.00 * API_AMOUNT_MULTIPLIER; // 1000000
// Book format: 100 = $1.00
const bookAmount = 1.00 * BOOK_AMOUNT_MULTIPLIER; // 100The package includes comprehensive TypeScript definitions:
import type {
StatusCode,
BalanceObject,
RoundDetailObject,
ConfigObject,
AuthenticateResponse,
PlayResponse,
ReplayResponse,
BetType,
BaseBetType
} from 'stake-engine-client';The RGS API returns standard status codes:
SUCCESS- Operation completed successfullyERR_IPB- Insufficient player balanceERR_IS- Invalid session token/timeoutERR_ATE- Authentication failed/expiredERR_GLE- Gambling limits exceededERR_BNF- Bet not foundERR_UE- Unknown server error- And more...
For game-specific betting logic:
interface MyGameEvent {
symbol: string;
multiplier: number;
position: [number, number];
}
type MyGameBet = BetType<MyGameEvent>;
// Use in your game logic
const processBet = (bet: MyGameBet) => {
bet.state.forEach(event => {
console.log(`Symbol ${event.symbol} at ${event.position}`);
});
};All methods return responses with status information:
const bet = await play({
sessionID: 'player-123',
currency: 'USD',
amount: 1.00,
mode: 'base',
rgsUrl: 'api.stakeengine.com'
});
if (bet.status?.statusCode === 'SUCCESS') {
// Handle successful bet
console.log('Bet placed successfully!');
} else if (bet.status?.statusCode === 'ERR_IPB') {
// Handle insufficient balance
console.log('Insufficient balance');
} else {
// Handle other errors
console.log('Error:', bet.status?.statusMessage);
}This package was extracted from the official Stake Engine web-sdk to provide:
✅ Included:
- RGS API client with full type safety
- Authentication and session management
- Betting and balance operations
- Game event tracking
- Amount conversion utilities
- TypeScript definitions
❌ Removed:
- Svelte framework dependencies
- Slot game specific scripts
- UI components and styling
- Audio/visual effects
- Game-specific logic
This makes the package much lighter and suitable for any JavaScript framework or backend usage.
MIT
This package is extracted from Stake Engine web-sdk. For updates to the core functionality, please refer to the original repository.
For issues specific to this extraction or TypeScript definitions, please file issues in this repository.
