OmniFlix Channel Contract

Overview

The OmniFlix Channel Contract is a CosmWasm-based smart contract deployed on the OmniFlix Hub that enables creators to publish and manage video content in a decentralized manner. This contract serves as the foundation for OmniFlix's content ecosystem, supporting VOD (video-on-demand), live streams, and more.

Features

Channel Management

• Channel Creation: Create your own personalized channel with a unique username that becomes your digital identity in the OmniFlix ecosystem. Customize with channel name, description, profile picture, and banner image.
• Channel Ownership: Each channel is represented by an ONFT (OmniFlix Non-Fungible Token) that proves ownership and enables seamless transfers between accounts.
• Channel Metadata: Easily update your channel's appearance and information at any time, including name, description, profile picture, and banner.
• Channel Deletion: Full control over your content with the ability to remove a channel and all associated content when needed.

Content Publishing

• Asset Publishing: Publish content in multiple formats with comprehensive metadata support. Add titles, descriptions, and media URIs for your content, whether as NFTs with ownership rights or as off-chain media hosted on decentralized storage.
• Asset Visibility: Granular control over content visibility, allowing you to make specific assets public or private with a simple toggle.
• Asset Management: Comprehensive tools to update all aspects of your content including titles, descriptions, media URIs, and visibility settings - or completely remove published content from your channel.

Collaboration

• Collaborator Management: Add team members to your channel with specific roles (Moderator, Publisher) to help manage content and operations.
• Revenue Sharing: Sophisticated built-in mechanism for distributing revenue among collaborators based on customizable percentage shares.
• Role-Based Permissions: Different access levels ensure collaborators can only perform actions appropriate to their role, maintaining channel security.

Playlists

• Playlist Creation: Organize your content into themed playlists to enhance viewer experience and content discovery.
• Playlist Management: Easily add, remove, or refresh assets in playlists to keep your content organized and up-to-date.
• Cross-Channel Playlists: Create curated experiences by including content from other channels in your playlists, fostering community collaboration.

Community Engagement

• Channel Following: Build your audience with a following system that allows users to stay updated with your latest content.
• Content Flagging: Community-driven moderation through a sophisticated flagging system that helps maintain content quality.
• Creator Tipping: Direct financial support mechanism allowing viewers to tip creators with native tokens, creating additional revenue streams.

Administration

• Reserved Usernames: Advanced system for reserving and managing usernames, protecting brand identities and premium handles.
• Contract Configuration: Flexible configuration options for fees, administrative settings, and operational parameters.
• Pause Mechanism: Emergency safety feature to pause contract operations if needed, protecting both creators and users.

Getting Started

Prerequisites

• CosmWasm-compatible blockchain (OmniFlix Hub)
• Rust toolchain for development
• Access to OmniFlix Studio UI (recommended)

Installation

git clone https://github.com/OmniFlix/omniflix-channel.git
cd omniflix-channel
cargo build

Deployment

The contract can be deployed using standard CosmWasm deployment procedures:

# Example deployment command
omniflixhubd tx wasm store artifacts/omniflix_channel.wasm --from <your-key> --chain-id <chain-id> --gas auto --gas-adjustment 1.3 -y

Initialization

Initialize the contract with the following parameters:

{
  "protocol_admin": "<admin-address>",
  "fee_collector": "<fee-collector-address>",
  "channels_collection_details": {
    "collection_id": "<collection-id>",
    "collection_name": "OmniFlix Channels",
    "collection_symbol": "OFXC",
    "description": "Collection of OmniFlix channels",
    "preview_uri": "https://example.com/preview.jpg",
    "schema": "https://example.com/schema.json",
    "uri": "https://example.com/metadata.json",
    "uri_hash": "",
    "data": ""
  },
  "channel_token_details": {
    "description": "OmniFlix channel token",
    "media_uri": "https://example.com/media.jpg",
    "preview_uri": "https://example.com/preview.jpg",
    "uri_hash": "",
    "transferable": true,
    "extensible": true,
    "nsfw": false,
    "royalty_share": "0"
  },
  "channel_creation_fee": [{"denom": "uflix", "amount": "1000000"}],
  "accepted_tip_denoms": ["uflix"],
  "reserved_usernames": []
}

Contract Deployment Details

The contract is currently deployed on the OmniFlix Hub testnet (flixnet-4) with the following address:

omniflix1zwngtwpmqtu45cj9sfdnnd4v5s39qte28eam49pffhleqtx30gsqt6fafl

Usage

Creating a Channel

omniflixhubd tx wasm execute <contract-address> '{
  "channel_create": {
    "salt": "<random-binary>",
    "user_name": "mychannel",
    "channel_name": "My Channel",
    "description": "A channel for my content",
    "payment_address": "<payment-address>",
    "profile_picture": "https://example.com/profile.jpg",
    "banner_picture": "https://example.com/banner.jpg"
  }
}' --amount 1000000uflix --from <your-key>

Publishing Content

omniflixhubd tx wasm execute <contract-address> '{
  "asset_publish": {
    "asset_source": {
      "off_chain": {}
    },
    "salt": "<random-binary>",
    "channel_id": "<channel-id>",
    "playlist_id": "<playlist-id>",
    "is_visible": true,
    "metadata": {
      "name": "My Video",
      "description": "An awesome video",
      "media_uri": "ipfs://Qm...",
      "thumbnail_uri": "ipfs://Qm..."
    }
  }
}' --from <your-key>

Updating Asset Details

omniflixhubd tx wasm execute <contract-address> '{
  "asset_update_details": {
    "publish_id": "<publish-id>",
    "channel_id": "<channel-id>",
    "is_visible": true,
    "name": "Updated Title",
    "description": "Updated description",
    "media_uri": "ipfs://Qm...",
    "thumbnail_uri": "ipfs://Qm..."
  }
}' --from <your-key>

Creating a Playlist

omniflixhubd tx wasm execute <contract-address> '{
  "playlist_create": {
    "playlist_name": "My Playlist",
    "channel_id": "<channel-id>",
    "salt": "<random-binary>"
  }
}' --from <your-key>

Adding Collaborators

omniflixhubd tx wasm execute <contract-address> '{
  "channel_add_collaborator": {
    "channel_id": "<channel-id>",
    "collaborator_address": "<collaborator-address>",
    "collaborator_details": {
      "role": "Moderator",
      "share": "0.2"
    }
  }
}' --from <your-key>

Following/Unfollowing Channels

# Follow a channel
omniflixhubd tx wasm execute <contract-address> '{
  "channel_follow": {
    "channel_id": "<channel-id>"
  }
}' --from <your-key>

# Unfollow a channel
omniflixhubd tx wasm execute <contract-address> '{
  "channel_unfollow": {
    "channel_id": "<channel-id>"
  }
}' --from <your-key>

Admin Operations

# Set contract configuration
omniflixhubd tx wasm execute <contract-address> '{
  "admin_set_config": {
    "channel_creation_fee": [{"denom": "uflix", "amount": "1000000"}],
    "protocol_admin": "<new-admin-address>",
    "fee_collector": "<new-fee-collector-address>"
  }
}' --from <admin-key>

# Manage reserved usernames
omniflixhubd tx wasm execute <contract-address> '{
  "admin_manage_reserved_usernames": {
    "add_usernames": [
      {
        "username": "reserved1",
        "address": "<reserved-address>"
      }
    ],
    "remove_usernames": ["reserved2"]
  }
}' --from <admin-key>

# Pause/Unpause contract
omniflixhubd tx wasm execute <contract-address> '{
  "pause": {}
}' --from <pauser-key>

omniflixhubd tx wasm execute <contract-address> '{
  "unpause": {}
}' --from <pauser-key>

# Set pausers
omniflixhubd tx wasm execute <contract-address> '{
  "set_pausers": {
    "pausers": ["<pauser-address-1>", "<pauser-address-2>"]
  }
}' --from <admin-key>

Query Operations

Channel Details

omniflixhubd query wasm contract-state smart <contract-address> '{
  "channel": {
    "channel_id": "<channel-id>"
  }
}'

Channel Assets

omniflixhubd query wasm contract-state smart <contract-address> '{
  "assets": {
    "channel_id": "<channel-id>",
    "limit": 10
  }
}'

Channel Playlists

omniflixhubd query wasm contract-state smart <contract-address> '{
  "playlists": {
    "channel_id": "<channel-id>",
    "limit": 10
  }
}'

Channel Followers

omniflixhubd query wasm contract-state smart <contract-address> '{
  "followers": {
    "channel_id": "<channel-id>",
    "limit": 10
  }
}'

Channel Collaborators

omniflixhubd query wasm contract-state smart <contract-address> '{
  "get_channel_collaborators": {
    "channel_id": "<channel-id>",
    "limit": 10
  }
}'

Username Reservation System

The contract includes a sophisticated username reservation system that allows specific usernames to be reserved for particular addresses or marked as generally reserved. This system ensures that premium or brand-specific usernames can be protected.

• Usernames can be reserved with or without a specific address assignment
• Reserved usernames without an address assignment cannot be claimed by anyone
• Reserved usernames with an address assignment can only be claimed by that address

Security Features

• Ownership Verification: All operations verify the sender is authorized through multiple validation layers
• Pause Mechanism: Contract can be paused in case of emergencies by designated pausers
• Role-Based Access: Different permissions for owners, collaborators, and admins ensure proper access control

License

This project is licensed under [LICENSE] - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Contact

For questions or support, please reach out to the OmniFlix team:

• Website: https://omniflix.network
• Twitter: @OmniFlixNetwork
• Discord: OmniFlix Discord