Overview
Pyth Entropy is an on-chain random number generator (RNG) that provides cryptographically secure, verifiable randomness for blockchain applications. Entropy uses a two-party commit-reveal protocol, a well-known protocol in the cryptography space for generating a random number, offering lower fees, direct integration with Pyth Network, scalability, and faster response times compared to traditional VRF solutions. Entropy delivers randomness that is trustless, low-latency, cost-efficient, and requires no registration.
What You’ll Be Doing in This Guide
In this tutorial, you’ll learn how to:
- Integrate Pyth Entropy’s commit-reveal randomness system into your Sei EVM application
- Create smart contracts that request and consume verifiable random numbers using the Entropy protocol
- Implement a complete gaming application with fair, transparent randomness
- Handle fees, callbacks, and error management for production-ready randomness
By the end of this guide, you’ll have a working demo that can request cryptographically secure random numbers on the Sei network with proper verification mechanisms using Pyth Entropy.
Prerequisites
Before starting this tutorial, ensure you have:
Technical Requirements
- Solidity Knowledge: Basic understanding of Solidity smart contract development
- JavaScript/Node.js: For off-chain interaction and frontend integration
- Development Environment: Remix IDE, Hardhat, Foundry, or similar Solidity development setup
- Sei Network Access: RPC endpoint and familiarity with Sei’s EVM environment
- Native Tokens: SEI tokens required for paying Entropy request fees
Required Dependencies
- Pyth Entropy Solidity SDK (
@pythnetwork/entropy-sdk-solidity)
Install
# npm
npm install @pythnetwork/entropy-sdk-solidity
# yarn
yarn add @pythnetwork/entropy-sdk-solidity
# pnpm
pnpm add @pythnetwork/entropy-sdk-soliditySei Network Configuration
Make sure your development environment is configured for Sei:
- Mainnet RPC:
https://evm-rpc.sei-apis.com - Chain ID: 1329 (mainnet)
- Testnet RPC:
https://evm-rpc-testnet.sei-apis.com - Testnet Chain ID: 1328 (testnet)
Pyth Entropy Architecture Overview
Entropy uses a two-party commit-reveal protocol consisting of:
- Entropy Provider: Off-chain service that commits to a sequence of random numbers using hash chains
- User Commitment: Users contribute their own random input to ensure unpredictability
- Commit-Reveal Protocol: Two-party system where both parties contribute to final randomness
- On-Chain Verification: Smart contracts verify the randomness proofs and execute callbacks
- Keeper Network: Decentralized bots that fulfill randomness requests by revealing provider commitments
Key Concepts
Before implementing, it’s important to understand the key aspects of working with Pyth Entropy:
Two-Phase Process
Entropy uses a two-phase approach:
- Request Phase: Your contract calls
entropy.requestV2()and receives asequenceNumber - Fulfillment Phase: Off-chain keepers fulfill the request by calling your contract’s
entropyCallback()method
Asynchronous Nature
Unlike synchronous random number generation, Entropy requests are asynchronous:
- The random number is not available immediately after the request
- Your application must handle the waiting period (typically 1-3 blocks)
- Use events and polling to know when randomness is fulfilled
Fee Management
Entropy requires payment for each randomness request:
- Always call
getFeeV2()to get the current fee before making requests - Fees are paid in the native token (SEI) as
msg.value - Fees are dynamic and may change based on network conditions
Callback Implementation
Your contract must implement the entropyCallback function:
- This method is called automatically when randomness is fulfilled
- It receives the
sequenceNumber,providerAddress, andrandomNumber - All your game logic should be handled in this callback
Sequence Number Tracking
Each request has a unique sequenceNumber:
- Use this to map requests to your application state
- Store game/request data using the sequence number as the key
- Multiple requests can be pending simultaneously
Error Handling
Always implement proper error handling:
- Requests can fail or timeout
- Network issues may prevent fulfillment
- Have fallback mechanisms for failed requests
Gas Considerations
The callback execution has gas limits:
- Keep callback logic simple to avoid out-of-gas errors
- For complex logic, consider using custom gas limits with
requestV2variants - Store expensive computations for later execution
Steps to Integrate Pyth Entropy into Sei
Step 1: Smart Contract Integration
Create a consumer contract that integrates with Pyth Entropy:
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.13;
import "@pythnetwork/entropy-sdk-solidity/IEntropyV2.sol";
import "@pythnetwork/entropy-sdk-solidity/IEntropyConsumer.sol";
contract SeiEntropyDemo is IEntropyConsumer {
// Entropy configuration
IEntropyV2 entropy;
// Game state
struct DiceGame {
address player;
uint256 betAmount;
uint256 targetNumber;
bool fulfilled;
bool won;
uint256 diceRoll;
uint256 timestamp;
}
mapping(uint64 => DiceGame) public games;
mapping(address => uint256) public playerBalances;
uint256 public gameCounter;
// Events
event GameRequested(uint64 indexed sequenceNumber, address indexed player, uint256 betAmount, uint256 targetNumber);
event GameResolved(uint64 indexed sequenceNumber, address indexed player, bool won, uint256 diceRoll);
event RandomnessRequested(uint64 indexed sequenceNumber);
event RandomnessFulfilled(uint64 indexed sequenceNumber, bytes32 randomNumber);
constructor(address _entropy) {
entropy = IEntropyV2(_entropy);
}
// This method is required by the IEntropyConsumer interface
function getEntropy() internal view override returns (address) {
return address(entropy);
}
/**
* @notice Start a new dice game with Entropy randomness
* @param targetNumber The number to roll (1-6) to win
*/
function playDiceGame(uint256 targetNumber) external payable returns (uint64 sequenceNumber) {
require(targetNumber >= 1 && targetNumber <= 6, "Target must be 1-6");
// Get fee for entropy request
uint128 requestFee = entropy.getFeeV2();
require(msg.value >= requestFee, "Insufficient fee for randomness");
// Calculate bet amount (total payment minus entropy fee)
uint256 betAmount = msg.value - requestFee;
require(betAmount > 0, "Must send more than just the entropy fee");
// Store player balance
playerBalances[msg.sender] += betAmount;
// Request randomness from Entropy (V2 doesn't require user random number)
sequenceNumber = entropy.requestV2{value: requestFee}();
// Store game session
games[sequenceNumber] = DiceGame({
player: msg.sender,
betAmount: betAmount,
targetNumber: targetNumber,
fulfilled: false,
won: false,
diceRoll: 0,
timestamp: block.timestamp
});
gameCounter++;
emit GameRequested(sequenceNumber, msg.sender, betAmount, targetNumber);
emit RandomnessRequested(sequenceNumber);
return sequenceNumber;
}
/**
* @notice Callback function used by Entropy when randomness is fulfilled
* @param sequenceNumber The sequence number of the request
* @param providerAddress The randomness provider address
* @param randomNumber The generated random number
*/
function entropyCallback(
uint64 sequenceNumber,
address providerAddress,
bytes32 randomNumber
) internal override {
DiceGame storage game = games[sequenceNumber];
require(game.player != address(0), "Game not found");
require(!game.fulfilled, "Game already fulfilled");
game.fulfilled = true;
// Convert random number to dice roll (1-6)
uint256 diceRoll = (uint256(randomNumber) % 6) + 1;
game.diceRoll = diceRoll;
// Determine if player won
bool won = diceRoll == game.targetNumber;
game.won = won;
if (won) {
// Player wins 5x their bet
uint256 winnings = game.betAmount * 5;
playerBalances[game.player] += winnings;
}
emit RandomnessFulfilled(sequenceNumber, randomNumber);
emit GameResolved(sequenceNumber, game.player, won, diceRoll);
}
/**
* @notice Get game details by sequence number
* @param sequenceNumber The Entropy sequence number
* @return Game session details
*/
function getGameDetails(uint64 sequenceNumber) external view returns (DiceGame memory) {
return games[sequenceNumber];
}
/**
* @notice Check if randomness has been fulfilled for a request
* @param sequenceNumber The Entropy sequence number
* @return True if randomness has been fulfilled
*/
function isRequestFulfilled(uint64 sequenceNumber) external view returns (bool) {
return games[sequenceNumber].fulfilled;
}
/**
* @notice Get player's current balance
* @param player Player address
* @return Current balance
*/
function getPlayerBalance(address player) external view returns (uint256) {
return playerBalances[player];
}
/**
* @notice Withdraw player balance
*/
function withdraw() external {
uint256 balance = playerBalances[msg.sender];
require(balance > 0, "No balance to withdraw");
playerBalances[msg.sender] = 0;
payable(msg.sender).transfer(balance);
}
/**
* @notice Get the current fee for entropy requests
* @return fee The current fee amount in wei
*/
function getEntropyFee() external view returns (uint128) {
return entropy.getFeeV2();
}
/**
* @notice Play multiple dice games in batch
* @param targetNumbers Array of target numbers
*/
function playMultipleDiceGames(
uint256[] calldata targetNumbers
) external payable returns (uint64[] memory sequenceNumbers) {
require(targetNumbers.length > 0 && targetNumbers.length <= 10, "Invalid array length");
uint128 requestFee = entropy.getFeeV2();
uint256 totalFee = uint256(requestFee) * targetNumbers.length;
require(msg.value >= totalFee, "Insufficient fee for batch randomness");
uint256 betPerGame = (msg.value - totalFee) / targetNumbers.length;
require(betPerGame > 0, "Insufficient funds for bets");
sequenceNumbers = new uint64[](targetNumbers.length);
for (uint i = 0; i < targetNumbers.length; i++) {
require(targetNumbers[i] >= 1 && targetNumbers[i] <= 6, "Target must be 1-6");
playerBalances[msg.sender] += betPerGame;
uint64 sequenceNumber = entropy.requestV2{value: requestFee}();
games[sequenceNumber] = DiceGame({
player: msg.sender,
betAmount: betPerGame,
targetNumber: targetNumbers[i],
fulfilled: false,
won: false,
diceRoll: 0,
timestamp: block.timestamp
});
sequenceNumbers[i] = sequenceNumber;
gameCounter++;
emit GameRequested(sequenceNumber, msg.sender, betPerGame, targetNumbers[i]);
emit RandomnessRequested(sequenceNumber);
}
return sequenceNumbers;
}
receive() external payable {}
}Deploy this contract using Remix with the Entropy contract address for your target network:
| Network | Entropy Contract Address |
|---|---|
| Sei Mainnet | 0x98046bd286715d3b0bc227dd7a956b83d8978603 |
| Sei Testnet | 0x36825bf3fbdf5a29e2d5148bfe7dcf7b5639e320 |
Note: Entropy V2 uses a default provider system, so you no longer need to specify a provider address in the constructor.
Step 2: JavaScript Integration for Entropy Management
Create a module to interact with Entropy and manage randomness requests:
Note: The JavaScript examples below use CommonJS (require/module.exports). If your project uses "type": "module", rename these files to .cjs or convert the snippets to ES Modules.
const { ethers } = require('ethers');
const dotenv = require('dotenv');
dotenv.config();
// Contract ABI (simplified for key functions)
const ENTROPY_DEMO_ABI = ['function playDiceGame(uint256 targetNumber) external payable returns (uint64)', 'function getGameDetails(uint64 sequenceNumber) external view returns (tuple(address player, uint256 betAmount, uint256 targetNumber, bool fulfilled, bool won, uint256 diceRoll, uint256 timestamp))', 'function isRequestFulfilled(uint64 sequenceNumber) external view returns (bool)', 'function getPlayerBalance(address player) external view returns (uint256)', 'function withdraw() external', 'function getEntropyFee() external view returns (uint128)', 'function gameCounter() external view returns (uint256)', 'event GameRequested(uint64 indexed sequenceNumber, address indexed player, uint256 betAmount, uint256 targetNumber)', 'event GameResolved(uint64 indexed sequenceNumber, address indexed player, bool won, uint256 diceRoll)', 'event RandomnessRequested(uint64 indexed sequenceNumber)', 'event RandomnessFulfilled(uint64 indexed sequenceNumber, bytes32 randomNumber)'];
/**
* Play a dice game using Pyth Entropy randomness
* @param {string} contractAddress Deployed Entropy demo contract address
* @param {string} privateKey Player's private key
* @param {number} targetNumber Target dice number (1-6)
* @param {string} betAmount Bet amount in SEI
* @param {string} rpcUrl RPC endpoint URL
*/
async function playEntropyDiceGame(contractAddress, privateKey, targetNumber, betAmount, rpcUrl = 'https://evm-rpc.sei-apis.com') {
try {
console.log('🎲 Starting Pyth Entropy Dice Game...');
// Setup provider and wallet
const provider = new ethers.JsonRpcProvider(rpcUrl);
const wallet = new ethers.Wallet(privateKey, provider);
// Create contract instance
const contract = new ethers.Contract(contractAddress, ENTROPY_DEMO_ABI, wallet);
const balance = await provider.getBalance(wallet.address);
console.log(`💼 Player Wallet: ${wallet.address} | Balance: ${ethers.formatEther(balance)} SEI`);
console.log(`🎯 Player: ${wallet.address}`);
console.log(`💰 Bet Amount: ${betAmount} SEI`);
console.log(`🎲 Target Number: ${targetNumber}`);
// Get current entropy fee
const entropyFee = await contract.getEntropyFee();
console.log(`⚡ Entropy Fee: ${ethers.formatEther(entropyFee)} SEI`);
// Check current balance
const currentBalance = await contract.getPlayerBalance(wallet.address);
console.log(`💳 Current Contract Balance: ${ethers.formatEther(currentBalance)} SEI`);
// Calculate total payment (bet + entropy fee)
const betInWei = ethers.parseEther(betAmount);
const totalPayment = betInWei + entropyFee;
console.log('\n🔄 Submitting game transaction...');
const tx = await contract.playDiceGame(targetNumber, {
value: totalPayment,
gasLimit: 300000
});
console.log(`📝 Transaction Hash: ${tx.hash}`);
// Wait for confirmation and get receipt
const receipt = await tx.wait();
console.log(`✅ Transaction confirmed in block: ${receipt.blockNumber}`);
// Extract sequence number from events
const gameRequestedEvent = receipt.logs.find((log) => {
try {
const decoded = contract.interface.parseLog({
topics: log.topics,
data: log.data
});
return decoded.name === 'GameRequested';
} catch {
return false;
}
});
if (!gameRequestedEvent) {
throw new Error('GameRequested event not found');
}
const decodedEvent = contract.interface.parseLog({
topics: gameRequestedEvent.topics,
data: gameRequestedEvent.data
});
const sequenceNumber = decodedEvent.args[0];
console.log(`🎟️ Sequence Number: ${sequenceNumber.toString()}`);
// Wait for Entropy fulfillment
console.log('\n⏳ Waiting for Entropy fulfillment...');
await waitForEntropyFulfillment(contract, sequenceNumber);
// Get final game results
const gameDetails = await contract.getGameDetails(sequenceNumber);
console.log('\n🎯 GAME RESULTS:');
console.log(`🎲 Dice Roll: ${gameDetails.diceRoll}`);
console.log(`🎯 Target: ${gameDetails.targetNumber}`);
console.log(`${gameDetails.won ? '🎉 WINNER!' : '💔 Better luck next time!'}`);
console.log(`💰 Bet Amount: ${ethers.formatEther(gameDetails.betAmount)} SEI`);
if (gameDetails.won) {
const winAmount = gameDetails.betAmount * BigInt(5);
console.log(`💸 Winnings: ${ethers.formatEther(winAmount)} SEI`);
}
// Check updated balance
const newBalance = await contract.getPlayerBalance(wallet.address);
console.log(`💳 New Balance: ${ethers.formatEther(newBalance)} SEI`);
return {
sequenceNumber: sequenceNumber.toString(),
diceRoll: Number(gameDetails.diceRoll),
targetNumber: Number(gameDetails.targetNumber),
won: gameDetails.won,
txHash: receipt.transactionHash,
blockNumber: receipt.blockNumber
};
} catch (error) {
console.error('❌ Error playing Entropy dice game:', error.message);
throw error;
}
}
/**
* Wait for Entropy fulfillment with timeout
* @param {Contract} contract Contract instance
* @param {BigInt} sequenceNumber Entropy sequence number
* @param {number} timeoutMs Timeout in milliseconds
*/
async function waitForEntropyFulfillment(contract, sequenceNumber, timeoutMs = 120000) {
const startTime = Date.now();
while (Date.now() - startTime < timeoutMs) {
try {
const fulfilled = await contract.isRequestFulfilled(sequenceNumber);
if (fulfilled) {
console.log('✅ Entropy request fulfilled!');
return;
}
process.stdout.write('.');
await new Promise((resolve) => setTimeout(resolve, 3000)); // Wait 3 seconds
} catch (error) {
console.error('Error checking fulfillment:', error.message);
await new Promise((resolve) => setTimeout(resolve, 3000));
}
}
throw new Error('Entropy fulfillment timed out');
}
/**
* Monitor Entropy events in real-time
* @param {string} contractAddress Contract address
* @param {string} rpcUrl RPC URL
*/
async function monitorEntropyEvents(contractAddress, rpcUrl = 'https://evm-rpc.sei-apis.com') {
try {
console.log('👂 Starting Entropy event monitoring...');
const provider = new ethers.JsonRpcProvider(rpcUrl);
const contract = new ethers.Contract(contractAddress, ENTROPY_DEMO_ABI, provider);
// Listen for game events
contract.on('GameRequested', (sequenceNumber, player, betAmount, targetNumber) => {
console.log(`🎮 Game Requested - Sequence: ${sequenceNumber}, Player: ${player}, Target: ${targetNumber}, Bet: ${ethers.formatEther(betAmount)} SEI`);
});
contract.on('RandomnessRequested', (sequenceNumber) => {
console.log(`🔄 Entropy Randomness Requested - Sequence: ${sequenceNumber}`);
});
contract.on('RandomnessFulfilled', (sequenceNumber, randomNumber) => {
console.log(`✅ Entropy Randomness Fulfilled - Sequence: ${sequenceNumber}, Random: ${randomNumber}`);
});
contract.on('GameResolved', (sequenceNumber, player, won, diceRoll) => {
console.log(`🎯 Game Resolved - Sequence: ${sequenceNumber}, Player: ${player}, Won: ${won}, Roll: ${diceRoll}`);
});
console.log('✅ Event monitoring active. Press Ctrl+C to stop.');
} catch (error) {
console.error('Error monitoring events:', error.message);
throw error;
}
}
/**
* Simple Pyth Entropy demonstration
*/
async function demonstratePythEntropyIntegration() {
const contractAddress = process.env.CONTRACT_ADDRESS;
const privateKey = process.env.PRIVATE_KEY;
const rpcUrl = 'https://evm-rpc.sei-apis.com';
console.log('🚀 Starting Sei Pyth Entropy Integration Demo...');
console.log(`📍 Contract Address: ${contractAddress}`);
console.log(`🌐 RPC URL: ${rpcUrl}\n`);
try {
// Play a single dice game
const result = await playEntropyDiceGame(contractAddress, privateKey, 3, '0.1', rpcUrl);
console.log('\n🎉 Pyth Entropy Demo completed successfully!');
console.log(`📋 Game Summary:`);
console.log(` - Sequence: ${result.sequenceNumber}`);
console.log(` - Target: ${result.targetNumber}, Roll: ${result.diceRoll}`);
console.log(` - Result: ${result.won ? 'WON' : 'LOST'}`);
console.log(` - Transaction: ${result.txHash}`);
console.log(` - Block: ${result.blockNumber}`);
} catch (error) {
console.error('❌ Demo failed:', error.message);
}
}
// Export functions for use in other modules
module.exports = {
playEntropyDiceGame,
waitForEntropyFulfillment,
monitorEntropyEvents,
demonstratePythEntropyIntegration
};
// Run demo if this file is executed directly
// Usage: node SeiPythEntropyIntegration.js
if (require.main === module) {
demonstratePythEntropyIntegration();
}Step 3: Complete Integration Example
Here’s a simple usage example that puts it all together:
First, create a .env file in your project root (never commit this file):
# .env - NEVER commit this file to version control!
PRIVATE_KEY=your_private_key_here
CONTRACT_ADDRESS=your_deployed_entropy_contract_addressThen create the demo script:
// demo.js - Complete Pyth Entropy demonstration
const { demonstratePythEntropyIntegration, monitorEntropyEvents } = require('./SeiPythEntropyIntegration.js');
const dotenv = require('dotenv');
dotenv.config();
// Validate required environment variables
if (!process.env.PRIVATE_KEY || !process.env.CONTRACT_ADDRESS) {
console.error('❌ Missing required environment variables!');
console.error('Please create a .env file with PRIVATE_KEY and CONTRACT_ADDRESS');
process.exit(1);
}
// Option 1: Run the complete demo
demonstratePythEntropyIntegration()
.then(() => {
console.log('🎯 Pyth Entropy integration demo completed successfully!');
})
.catch((error) => {
console.error('❌ Demo failed:', error);
});
// Option 2: Monitor events in real-time
// monitorEntropyEvents(process.env.CONTRACT_ADDRESS);Expected Output
To run the complete demo, execute the demo.js script:
node demo.jsWhen you run the Pyth Entropy integration, you should see output similar to:
🚀 Starting Sei Pyth Entropy Integration Demo...
📍 Contract Address: 0xb879CEabC035CF1ACb95A2A9D679Be633BAa6BD0
🌐 RPC URL: https://evm-rpc.sei-apis.com
🎲 Starting Pyth Entropy Dice Game...
💼 Player Wallet: 0x232d055936450052c3df9B8064b2B56B01c49DEc | Balance: 0.931653993763751675 SEI
🎯 Player: 0x232d055936450052c3df9B8064b2B56B01c49DEc
💰 Bet Amount: 0.1 SEI
🎲 Target Number: 3
⚡ Entropy Fee: 0.050000000000000001 SEI
💳 Current Contract Balance: 1.532691867344799999 SEI
🔄 Submitting game transaction...
📝 Transaction Hash: 0x248d1b2b9fd5df95bc0ac6e67179e7e1c50e0a557c6acb9be790f7e2dacecab4
✅ Transaction confirmed in block: 184783333
🎟️ Sequence Number: 7547
⏳ Waiting for Entropy fulfillment...
.✅ Entropy request fulfilled!
🎯 GAME RESULTS:
🎲 Dice Roll: 4
🎯 Target: 3
💔 Better luck next time!
💰 Bet Amount: 0.1 SEI
💳 New Balance: 1.632691867344799999 SEI
🎉 Pyth Entropy Demo completed successfully!
📋 Game Summary:
- Sequence: 7547
- Target: 3, Roll: 4
- Result: LOST
- Transaction: 0x248d1b2b9fd5df95bc0ac6e67179e7e1c50e0a557c6acb9be790f7e2dacecab4
- Block: 184783333Data Structure Details
Pyth Entropy V2 responses include several important fields:
- sequenceNumber: Unique identifier for the randomness request (uint64)
- randomNumber: The cryptographically secure random bytes32 value
- providerAddress: Address of the entropy provider that fulfilled the request
- blockNumber: Block number when the request was fulfilled
Fee Structure
- Dynamic Fees: Always use the on-chain method
entropy.getFeeV2()to get the current fee - Native Token Payment: Fees are paid in the native blockchain token (SEI)
- Per-Request Basis: Each randomness request has its own fee
- No User Commitment Required: Entropy V2 simplifies the process by removing the need for user random numbers
Best Practices
- Fee Management: Always check current fees using
getFeeV2()before submitting requests - Callback Gas Limits: Set appropriate gas limits for complex callback logic using Entropy V2’s custom gas limit features
- Error Handling: Implement proper timeout and error handling for unfulfilled requests
- Sequential Processing: Handle multiple requests appropriately as they may be fulfilled out of order
- Storage Optimization: Remember that fulfilled randomness is not stored by the contract - save it if needed for multiple uses