Skip to content

FAQ.md

Latest commit

 

History

History
182 lines (131 loc) · 6.37 KB

FAQ.md

File metadata and controls

182 lines (131 loc) · 6.37 KB
Raw

FREQUENTLY ASKED QUESTIONS (FAQ)

❓ GENERAL QUESTIONS

WHAT IS XAH PAYROLL?

XAH PAYROLL IS A DECENTRALIZED HOURLY PAYROLL SYSTEM BUILT ON XAHAU (AN XRPL SIDECHAIN). IT ENABLES NGOS AND EMPLOYERS TO PAY WORKERS HOURLY WAGES USING PAYMENT CHANNELS WITH ESCROW PROTECTION.

HOW DOES IT WORK?

  1. NGOS/EMPLOYERS CREATE PAYMENT CHANNELS WITH ESCROW FUNDS
  2. WORKERS CLOCK IN/OUT TO TRACK WORK HOURS
  3. EARNINGS ACCUMULATE OFF-CHAIN IN THE DATABASE (NO LEDGER TRANSACTIONS)
  4. WHEN CHANNEL CLOSES, WORKERS RECEIVE ALL ACCUMULATED EARNINGS IN A SINGLE ON-CHAIN TRANSACTION

WHAT WALLET DO I NEED?

YOU NEED A XAMAN WALLET (DOWNLOAD HERE). XAMAN IS THE ONLY SUPPORTED WALLET FOR PRODUCTION USE.

IS IT FREE TO USE?

YES, THE SOFTWARE IS OPEN SOURCE (MIT LICENSE). YOU ONLY PAY MINIMAL XAHAU NETWORK TRANSACTION FEES (~0.000001 XAH PER TRANSACTION).

WHAT NETWORK DOES IT USE?

XAH PAYROLL SUPPORTS BOTH:

  • TESTNET (FOR DEVELOPMENT AND TESTING)
  • MAINNET (FOR PRODUCTION USE)

SEE NETWORK_CONFIG.md FOR SWITCHING INSTRUCTIONS.

🎯 USE CASES

NGO FIELD WORKERS

SCENARIO: AN NGO HIRES TEMPORARY FIELD WORKERS FOR A 2-WEEK COMMUNITY PROJECT.

SOLUTION:

  • NGO CREATES PAYMENT CHANNEL WITH 200 XAH ESCROW
  • WORKER HOURLY RATE: 5 XAH/HOUR
  • WORKERS CLOCK IN/OUT VIA MOBILE DEVICE
  • AT PROJECT END (80 HOURS WORKED = 400 XAH EARNED)
  • NGO CLOSES CHANNEL → WORKER RECEIVES 400 XAH IN ONE TRANSACTION
  • UNUSED ESCROW (0 XAH) RETURNS TO NGO AUTOMATICALLY

FREELANCE CONTRACTORS

SCENARIO: A BUSINESS HIRES A DEVELOPER FOR HOURLY CONSULTING WORK.

SOLUTION:

  • EMPLOYER CREATES PAYMENT CHANNEL WITH 1000 XAH ESCROW
  • DEVELOPER HOURLY RATE: 50 XAH/HOUR
  • DEVELOPER TRACKS TIME ACROSS MULTIPLE WORK SESSIONS
  • AFTER 15 HOURS (750 XAH EARNED)
  • EITHER PARTY CLOSES CHANNEL → DEVELOPER RECEIVES 750 XAH
  • UNUSED ESCROW (250 XAH) RETURNS TO EMPLOYER AUTOMATICALLY

MULTI-ORGANIZATION WORKERS

SCENARIO: A WORKER PROVIDES SERVICES TO 3 DIFFERENT NGOS SIMULTANEOUSLY.

SOLUTION:

  • WORKER HAS SEPARATE PAYMENT CHANNELS WITH EACH NGO
  • DIFFERENT HOURLY RATES PER ORGANIZATION (NGO A: 10 XAH/HR, NGO B: 8 XAH/HR, NGO C: 12 XAH/HR)
  • WORKER DASHBOARD SHOWS ALL ACTIVE CHANNELS
  • WORKER SELECTS WHICH CHANNEL TO CLOCK INTO FOR EACH WORK SESSION
  • EACH NGO MANAGES AND CLOSES THEIR OWN PAYMENT CHANNEL INDEPENDENTLY

SEASONAL AGRICULTURAL WORKERS

SCENARIO: A FARM HIRES WORKERS FOR HARVEST SEASON (3 MONTHS).

SOLUTION:

  • FARM CREATES PAYMENT CHANNELS FOR EACH WORKER
  • WORKERS TRACK DAILY HOURS (VARIABLE HOURS PER DAY)
  • REAL-TIME BALANCE TRACKING SHOWS ACCUMULATED EARNINGS
  • AT SEASON END, FARM CLOSES ALL CHANNELS
  • WORKERS RECEIVE FULL PAYMENT IN ONE TRANSACTION
  • TRANSPARENT RECORDS (PDF EXPORT) FOR TAX PURPOSES

⚠️ KNOWN LIMITATIONS

WHAT FEATURES ARE MISSING?

1. TAX CALCULATIONS

STATUS: NOT IMPLEMENTED IN V1.0.0

WORKAROUND:

  • EXPORT PAYMENT HISTORY AS PDF (FEATURE AVAILABLE)
  • USE PDF RECORDS FOR MANUAL TAX CALCULATIONS
  • CONSULT TAX PROFESSIONAL FOR COMPLIANCE

2. NGO/EMPLOYER PROFILE DELETION

STATUS: NOT IMPLEMENTED IN V1.0.0

CURRENT BEHAVIOR:

  • WORKERS CAN DELETE THEIR PROFILES (FEATURE AVAILABLE)
  • NGO/EMPLOYER ACCOUNTS CANNOT BE DELETED VIA UI

WORKAROUND:

  • CONTACT SUPPORT: [email protected] FOR MANUAL ACCOUNT REMOVAL
  • OR SIMPLY STOP USING THE ACCOUNT (NO ONGOING FEES)

3. EDIT WORK HOURS

STATUS: NOT IMPLEMENTED IN V1.0.0

CURRENT BEHAVIOR:

  • WORK SESSIONS ARE PERMANENTLY RECORDED AFTER CLOCK OUT
  • WORKERS AND EMPLOYERS CANNOT EDIT CLOCK IN/OUT TIMES OR HOURS

WORKAROUND:

  • IF HOURS INCORRECT BEFORE CLOCK OUT: CLOCK OUT AND START NEW SESSION
  • IF HOURS INCORRECT AFTER CLOCK OUT: CONTACT EMPLOYER/NGO TO RESOLVE MANUALLY
  • EMPLOYERS CAN MONITOR ACTIVE SESSIONS IN REAL-TIME VIA DASHBOARD

🔧 TECHNICAL QUESTIONS

CAN I RUN MY OWN INSTANCE?

YES! XAH PAYROLL IS FULLY OPEN SOURCE. SEE QUICKSTART.md FOR SELF-HOSTING INSTRUCTIONS.

WHAT ARE THE TRANSACTION FEES?

XAHAU NETWORK FEES ARE MINIMAL:

  • PAYMENT CHANNEL CREATION: ~0.000001 XAH
  • PAYMENT CHANNEL CLOSURE: ~0.000001 XAH
  • TOTAL COST PER PAYMENT CYCLE: ~0.000002 XAH (LESS THAN $0.0001 USD)

HOW IS DATA STORED?

  • ON-CHAIN: PAYMENT CHANNEL CREATION, CLOSURE, AND ESCROW TRANSACTIONS
  • OFF-CHAIN: WORK HOURS, TIME TRACKING, USER PROFILES (POSTGRESQL DATABASE)
  • HYBRID APPROACH: MINIMIZES TRANSACTION FEES WHILE MAINTAINING TRANSPARENCY

IS IT SECURE?

YES. KEY SECURITY FEATURES:

  • NON-CUSTODIAL: USERS CONTROL THEIR PRIVATE KEYS (XAMAN WALLET)
  • ESCROW PROTECTION: FUNDS LOCKED ON XAHAU LEDGER UNTIL CHANNEL CLOSES
  • SETTLEDELAY PROTECTION: WORKERS GET 24+ HOURS TO CLAIM FUNDS DURING CLOSURE
  • OPEN SOURCE: ALL CODE IS PUBLICLY AUDITABLE

SEE SECURITY.md FOR COMPLETE SECURITY POLICY.

CAN WORKERS BE PAID IN REAL-TIME?

NO. EARNINGS ACCUMULATE IN THE DATABASE AND ARE PAID IN A SINGLE TRANSACTION WHEN THE PAYMENT CHANNEL CLOSES. THIS DESIGN:

  • MINIMIZES TRANSACTION FEES (2 TRANSACTIONS TOTAL VS HUNDREDS)
  • REDUCES NETWORK CONGESTION
  • SIMPLIFIES ACCOUNTING AND RECORD-KEEPING

🆘 SUPPORT

WHERE CAN I GET HELP?

DOCUMENTATION:

COMMUNITY SUPPORT:

SECURITY ISSUES:

  • DO NOT CREATE PUBLIC GITHUB ISSUES FOR SECURITY VULNERABILITIES
  • EMAIL: [email protected] WITH DETAILS
  • SEE SECURITY.md FOR RESPONSIBLE DISCLOSURE GUIDELINES

📚 ADDITIONAL RESOURCES