Developer Documentation
Comprehensive API reference, SDK guides, and code examples to integrate QVTX into your applications.
API Reference
Quaternary Compression
ByteID
Network
SDK Guides
Language-specific tutorials and implementation guides
JavaScript/TypeScript
npm install @qvtx/sdk --registry https://registry.qvtx.netQuick Start
import { QVTX } from '@qvtx/sdk';
const client = new QVTX({
apiKey: process.env.QVTX_API_KEY,
chain: 20232 // QVTX Mainnet
});
// Compress data with four-level quaternary encoding
const encoded = await client.quaternary.encode({
data: "Your data here",
format: "base64"
});
console.log('Encoded:', encoded.encoded); // 032120312...
console.log('Ratio:', encoded.ratio); // 4:1
console.log('Words:', encoded.words_used);
// Generate ByteID via encounter system
const byteId = await client.byteId.encounter({
data: encoded.encoded,
entity_type: "document"
});
// Format: QVTX-[PROPRIETARY]
console.log('ByteID:', byteId.byteid);
console.log('Chain:', byteId.chain); // 42000
console.log('Frequency:', byteId.frequency_hz); // F_BTutorials
Getting Started
Initialize SDK and connect to Chain 20232
Quaternary Compression
four-level quaternary encoding (proprietary ratio)
ByteID System
Generate 39-char identifiers via encounter system
Chain Integration
Work with Chain 20232 (Mainnet) & 42000 (Expression)
Python
pip install qvtx --index-url https://pypi.qvtx.net/simpleQuick Start
from qvtx import QVTX
import os
client = QVTX(
api_key=os.environ['QVTX_API_KEY'],
chain=20232 # QVTX Mainnet
)
# Compress data with four-level quaternary encoding
encoded = client.quaternary.encode(
data="Your data here",
format="base64"
)
print(f'Encoded: {encoded.encoded}') # 032120312...
print(f'Ratio: {encoded.ratio}') # 4:1
print(f'Words: {encoded.words_used}')
# Generate ByteID via encounter system
byte_id = client.byte_id.encounter(
data=encoded.encoded,
entity_type="document"
)
# Format: QVTX-[PROPRIETARY]
print(f'ByteID: {byte_id.byteid}')
print(f'Chain: {byte_id.chain}') # 42000
print(f'Frequency: {byte_id.frequency_hz}') # F_BTutorials
Getting Started
Install SDK and connect to QVTX quaternary chains
Data Compression
four-level quaternary encoding with 64-word instruction set
Identity Management
ByteID encounter and resolution
Network Operations
Chain status and instruction word execution
Go
go get github.com/Quantvestrix-Official/qvtx-goQuick Start
package main
import (
"fmt"
"os"
qvtx "github.com/Quantvestrix-Official/qvtx-go"
)
func main() {
client := qvtx.NewClient(
qvtx.WithAPIKey(os.Getenv("QVTX_API_KEY")),
qvtx.WithChain(20232), // QVTX Mainnet
)
// Compress data with four-level quaternary encoding
encoded, _ := client.Quaternary.Encode(qvtx.EncodeOptions{
Data: []byte("Your data here"),
Format: "base64",
})
fmt.Printf("Encoded: %s\n", encoded.Encoded) // 032120312...
fmt.Printf("Ratio: %s\n", encoded.Ratio) // 4:1
// Generate ByteID via encounter system
byteID, _ := client.ByteID.Encounter(qvtx.EncounterOptions{
Data: encoded.Encoded,
EntityType: "document",
})
// Format: QVTX-[PROPRIETARY]
fmt.Printf("ByteID: %s\n", byteID.ByteID)
fmt.Printf("Chain: %d\n", byteID.Chain) // 42000
fmt.Printf("Frequency: %d Hz\n", byteID.FrequencyHz) // F_B
}Tutorials
Getting Started
Setup Go SDK and connect to quaternary chains
Encoding & Compression
four-level quaternary compression in Go
ByteID Integration
Encounter system for identity generation
Concurrent Operations
Parallel instruction word execution at 4,630/sec
Need Help?
Join our developer community or contact support for assistance.