SDK Packages
The Penverse SDK allows developers to seamlessly integrate with the Penverse ecosystem, enabling decentralized research access, AI-powered insights, blockchain-based governance, and tokenized marketplace interactions. This document outlines the SDK package, its capabilities, available functions, request formats, and expected responses.
The SDK provides a high-level abstraction over the Penverse APIs, simplifying integration for developers by handling authentication, data retrieval, contract execution, and marketplace transactions.
Installation
To install the Penverse SDK:
npm install @penverse/sdk # For JavaScript/Node.js
pip install penverse-sdk # For PythonSDK Initialization
import Penverse from '@penverse/sdk';
const penverse = new Penverse({ apiKey: 'your-api-key' });from penverse_sdk import Penverse
penverse = Penverse(api_key='your-api-key')SDK Functions
Function
Description
authenticate(api_key)
Authenticates the user via API key.
login(username, password)
Logs in a user and retrieves an authentication token.
get_research_papers(query_params)
Fetches research papers based on search parameters.
upload_research(data)
Uploads research data to the decentralized storage.
retrieve_research(data_id)
Retrieves research data by ID.
analyze_research(query)
AI-powered literature analysis of research queries.
execute_smart_contract(payload)
Executes blockchain smart contracts.
purchase_dataset(dataset_id)
Buys access to a research dataset from the marketplace.
trade_marketplace(item_id, buyer, seller)
Facilitates a marketplace transaction.
vote_governance(proposal_id, vote)
Participates in DAO governance voting.
participate_governance(proposal_id, action)
Engages in governance activities beyond voting.
stake_tokens(amount, wallet)
Stakes tokens into the Penverse staking system.
track_citations(research_id)
Retrieves citation data for a research paper.
encrypt_data(data)
Encrypts research data for privacy protection.
get_ui_component(component_name)
Retrieves UI components for integration.
control_access(user_id, level)
Manages user access levels in the system.
activate_subscription(plan, payment_method, wallet)
Activates a subscription plan.
get_subscription_status(user_id)
Retrieves the subscription status of a user.
SDK Details
1. Authentication
authenticate(api_key)
Authenticates using an API key.
const auth = penverse.authenticate('your-api-key');auth = penverse.authenticate('your-api-key')Response:
{ "status": "authenticated", "token": "abcdef123456" }login(username, password)
Logs in a user.
const login = penverse.login('[email protected]', 'password123');login = penverse.login('[email protected]', 'password123')Response:
{ "token": "abcdef123456", "expires_in": 86400 }2. Research Data Management
get_research_papers(query_params)
Fetches research papers.
const papers = penverse.get_research_papers({ keyword: 'AI', year: 2023 });papers = penverse.get_research_papers({ 'keyword': 'AI', 'year': 2023 })Response:
{ "papers": [{ "title": "Decentralized AI", "year": 2023 }] }upload_research(data)
Uploads research data.
const upload = penverse.upload_research({ title: 'AI Research', content: 'Base64 encoded data' });upload = penverse.upload_research({ 'title': 'AI Research', 'content': 'Base64 encoded data' })Response:
{ "data_id": "12345", "status": "uploaded" }retrieve_research(data_id)
Retrieves research data by ID.
const research = penverse.retrieve_research('12345');research = penverse.retrieve_research('12345')Response:
{ "title": "AI Research", "content": "Base64 encoded data" }analyze_research(query)
AI-powered research analysis.
const analysis = penverse.analyze_research('Impact of AI on decentralization');analysis = penverse.analyze_research('Impact of AI on decentralization')Response:
{ "summary": "AI improves decision-making in decentralized systems..." }3. Blockchain & Marketplace
execute_smart_contract(payload)
Executes a smart contract.
const contract = penverse.execute_smart_contract({ contract_id: 'SC-001', parameters: {} });contract = penverse.execute_smart_contract({ 'contract_id': 'SC-001', 'parameters': {} })Response:
{ "transaction_hash": "0xabcdef123456" }purchase_dataset(dataset_id)
Buys a dataset.
const purchase = penverse.purchase_dataset('DS-2024-001');purchase = penverse.purchase_dataset('DS-2024-001')Response:
{ "transaction_hash": "0xabcdef123456", "access_url": "ipfs://QmDatasetHash" }trade_marketplace(item_id, buyer, seller)
Facilitates a marketplace transaction.
const trade = penverse.trade_marketplace('NFT-001', '0xBuyerWallet', '0xSellerWallet');trade = penverse.trade_marketplace('NFT-001', '0xBuyerWallet', '0xSellerWallet')Response:
{ "transaction_hash": "0x9876543210abcdef" }4. Governance & Staking
vote_governance(proposal_id, vote)
Votes in DAO governance.
const vote = penverse.vote_governance('42', 'yes');vote = penverse.vote_governance('42', 'yes')Response:
{ "transaction_hash": "0xabcdef123456", "status": "vote_recorded" }participate_governance(proposal_id, action)
Engages in governance activities beyond voting.
const participation = penverse.participate_governance('42', 'comment');participation = penverse.participate_governance('42', 'comment')Response:
{ "status": "participation recorded" }stake_tokens(amount, wallet)
Stakes tokens into the Penverse staking system.
const stake = penverse.stake_tokens(1000, '0xWallet');stake = penverse.stake_tokens(1000, '0xWallet')Response:
{ "status": "staked", "amount": "1000 PENSO" }5. Additional Features
track_citations(research_id)
Retrieves citation data for a research paper.
const citations = penverse.track_citations('12345');citations = penverse.track_citations('12345')Response:
{ "citations": [{ "title": "AI in Blockchain", "author": "Dr. Jane Doe", "year": 2023 }] }encrypt_data(data)
Encrypts research data for privacy protection.
const encrypted = penverse.encrypt_data('Sensitive research content');encrypted = penverse.encrypt_data('Sensitive research content')Response:
{ "encrypted_data": "EncryptedStringHere" }get_ui_component(component_name)
Retrieves UI components for integration.
const uiComponent = penverse.get_ui_component('search-bar');uiComponent = penverse.get_ui_component('search-bar')Response:
{ "html": "<div>Search Bar Component</div>" }control_access(user_id, level)
Manages user access levels in the system.
const access = penverse.control_access('user123', 'premium');access = penverse.control_access('user123', 'premium')Response:
{ "status": "updated" }activate_subscription(plan, payment_method, wallet)
Activates a subscription plan.
const subscription = penverse.activate_subscription('Pro', 'crypto', '0xWallet');subscription = penverse.activate_subscription('Pro', 'crypto', '0xWallet')Response:
{ "subscription_id": "sub-001", "status": "active" }get_subscription_status(user_id)
Retrieves the subscription status of a user.
const status = penverse.get_subscription_status('user123');status = penverse.get_subscription_status('user123')Response:
{ "user_id": "user123", "plan": "Pro", "status": "active" }Last updated