A command-line interface for Pirichain Smart Scenarios (PSCE). Create, manage, and test blockchain development workspaces with smart contract scenarios.
npm install -g pscenpx psce new my-workspace# Create a new PSCE workspace
psce new my-workspace
cd my-workspace
# Add and set network
psce network add --name testnet --url https://testnet.pirichain.com
psce network set testnet
# Generate and set address
psce address generate --name wallet1
psce address set wallet1
# OR import existing wallet from mnemonic
# psce address import --name my-wallet --network testnet
# Add a new scenario
psce scenario add payment --tags "finance,payment" --network https://testnet.pirichain.com
# Test your scenario
psce test payment -m init
psce test payment -m transfer -p "100,TZ123abc"# Create new workspace
psce new <workspace-name># Network commands (can use 'n' as shorthand)
psce network|n add --name <name> --url <url> # Add network
psce network|n list [--json] # List networks
psce network|n set <name> # Set active network
psce network|n current # Show current network
psce network|n test <name> # Test network connection
psce network|n remove <name> # Remove network
# Examples
psce n add --name mainnet --url https://mainnet.pirichain.com
psce n list # Show networks in table format
psce n list --json # Show networks in JSON format
psce n set mainnet
psce n current# Address commands (can use 'a' as shorthand)
psce address|a generate [--name <name>] # Generate new address (auto-saves as temp-* or custom name)
psce address|a import [--name <name>] # Import address from 24-word mnemonic
psce address|a validate <address> # Validate a Pirichain address
psce address|a list [--json] # List all addresses
psce address|a set <name> # Set active address
psce address|a current # Show current address
psce address|a rename <oldName> <newName> # Rename address
psce address|a remove <name> # Remove address
# Examples
psce a generate # Auto-saves as temp-1699123456
psce a generate --name wallet1 # Saves as wallet1
psce a generate --json # Output in JSON format
psce a import --name imported-wallet # Import from mnemonic (will prompt securely)
psce a import --mnemonic "word1 word2 ... word24" --name my-wallet # Import with mnemonic
psce a validate TZ123abc... # Check if address is valid
psce a list # Show addresses in table format
psce a list --json # Show addresses in JSON format
psce a rename temp-1699123456 mainwallet # Rename temp to permanent name
psce a set mainwallet
psce a current# Add new scenario
psce scenario add [options]
--name <name> Scenario name
--tags <tags> Comma-separated tags
--network <url> Target network URL
# Examples
psce scenario add payment
psce scenario add --name nft-market --tags "nft,marketplace" --network https://mainnet.pirichain.com# Test scenario methods
psce test <scenario> -m <method> [options]
-m, --method <method> Method name to execute (required)
-p, --params <params> Method parameters (comma-separated)
-n, --network <network> Network name (uses current if not specified)
-a, --address <address> Address name (uses current if not specified)
# Examples
psce test payment -m init
psce test token -m transfer -p "100,TZ123abc"
psce test nft -m mint -n mainnet -a wallet1my-workspace/
├── package.json # PSCE configuration
├── scenarios/ # Smart contract scenarios
│ └── example/ # Example scenario
│ ├── example.psce # Scenario code
│ ├── tests/ # Scenario-specific tests
│ │ ├── example.test.js
│ │ └── README.md
│ ├── .scenario-config.json
│ └── README.md
├── psce.json # PSCE workspace configuration
├── README.md # Workspace documentation
└── .gitignore
Each scenario includes:
{
"name": "payment",
"description": "PSCE scenario: payment",
"version": "1.0.0",
"author": "",
"networks": ["https://testnet.pirichain.com"],
"dependencies": [],
"testDir": "tests",
"tags": ["finance", "payment"],
"methods": [
{
"method": "init",
"description": "Initialize the scenario"
}
]
}PSCE tests work by sending requests to the active network's /previewScenario endpoint:
- scenarioText: Complete scenario code
- address: Active selected address
- privateKey: Private key (master password may be required)
- method: Method name to execute
- params: Parameter values
Test responses: {error: number, returnedData: any}
- error: 0 = Success
- error: > 0 = Error occurred
- 🔗 Workspace Creation: Generate complete PSCE development environments
- 📝 Scenario Management: Create scenarios with customizable tags and networks
- 🌐 Network Management: Add, test, and manage multiple blockchain networks
- 👤 Address Management: Generate, import from mnemonic, manage, and secure blockchain addresses with auto-save functionality
- 🧪 Integrated Testing: Built-in test framework using real PSCE API endpoints
- ⚡ Dynamic Configuration: Auto-detects workspace type and structure
- 🎯 VS Code Ready: Works with PSCE VS Code extension
The CLI automatically detects network properties:
- Tests
/getStatsendpoint for connectivity - Extracts address prefix from genesis block
- Stores network metadata for future use
git clone <repository-url>
cd psce-cli
npm install
npm link
# Test CLI
psce new test-workspacepsce-cli/
├── bin/
│ └── psce.js # CLI entry point
├── commands/
│ ├── new.js # Workspace creation
│ ├── scenario.js # Scenario management
│ ├── network.js # Network management
│ ├── address.js # Address management
│ └── test.js # Testing framework
├── lib/
│ ├── utils.js # Utility functions
│ ├── security-manager.js # Network/security management
│ └── wallet/ # Wallet functionality
│ ├── createNewAddress.js # Address generation
│ ├── getMnemonic.js # Mnemonic handling
│ ├── index.js # Wallet exports
│ ├── isValidAddress.js # Address validation
│ ├── rescuePrivateKey.js # Key recovery
│ └── utility.js # Wallet utilities
└── package.json
# Create workspace
psce new my-dapp
cd my-dapp
# Add and set network
psce n add --name PirichainTestnet --url https://testnet.pirichain.com
psce n add --name PirichainMainnet --url https://core.pirichain.com
# You can also add custom or local networks
psce n add --name local --url http://localhost:8080
psce n add --name custom --url https://my-custom-network.com
# Set active network
psce n set PirichainTestnet
# Generate and set active address
psce a generate --name wallet1
psce a set wallet1
# OR import existing address from mnemonic
# psce a import --name imported-wallet --network PirichainTestnet
# psce a set imported-wallet
# Create scenarios
psce scenario add --name token --tags "token,erc20" --network https://testnet.pirichain.com
psce scenario add --name nft --tags "nft,collectibles" --network https://core.pirichain.com
# Test scenarios
psce test token -m init
psce test token -m transfer -p "100,TZ123abc"
psce test nft -m mint -n mainnet -a wallet1