Convert Figma logo to code with AI

anacrolix logotorrent

Full-featured BitTorrent client package and utilities

5,474
620
5,474
58

Top Related Projects

Official Transmission BitTorrent client repository

qBittorrent BitTorrent client

an efficient feature complete C++ bittorrent implementation

⚡️ Streaming torrent client for the web

[Unofficial] qBittorrent Enhanced, based on qBittorrent

1,520

Deluge BitTorrent client - Git mirror, PRs only

Quick Overview

anacrolix/torrent is a full-featured BitTorrent client package and utilities for Go. It provides a comprehensive set of tools for creating, managing, and interacting with BitTorrent protocols and networks. The library is designed to be flexible and efficient, suitable for both high-performance applications and simple torrent clients.

Pros

  • Comprehensive functionality, including support for magnet links, DHT, and peer exchange
  • Written in pure Go, offering excellent performance and cross-platform compatibility
  • Actively maintained with regular updates and improvements
  • Extensive documentation and examples for easy integration

Cons

  • Steep learning curve for developers new to BitTorrent protocols
  • May require additional configuration for optimal performance in specific use cases
  • Limited built-in user interface options, primarily focused on backend functionality

Code Examples

  1. Creating a torrent client:
import "github.com/anacrolix/torrent"

cfg := torrent.NewDefaultClientConfig()
client, err := torrent.NewClient(cfg)
if err != nil {
    log.Fatalf("Error creating client: %v", err)
}
defer client.Close()
  1. Adding a torrent by magnet link:
t, err := client.AddMagnet("magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU")
if err != nil {
    log.Fatalf("Error adding magnet: %v", err)
}
<-t.GotInfo()
t.DownloadAll()
  1. Retrieving torrent stats:
for _, t := range client.Torrents() {
    fmt.Printf("Torrent: %s\n", t.Name())
    fmt.Printf("  Progress: %.2f%%\n", t.BytesCompleted()*100/t.Info().TotalLength())
    fmt.Printf("  Download Rate: %s/s\n", humanize.Bytes(uint64(t.Stats().DownloadRate)))
}

Getting Started

To use anacrolix/torrent in your Go project:

  1. Install the package:

    go get github.com/anacrolix/torrent
    
  2. Import the package in your Go code:

    import "github.com/anacrolix/torrent"
    
  3. Create a client and start using the library:

    cfg := torrent.NewDefaultClientConfig()
    client, err := torrent.NewClient(cfg)
    if err != nil {
        log.Fatalf("Error creating client: %v", err)
    }
    defer client.Close()
    
    // Add and manage torrents using the client
    

For more detailed usage and advanced features, refer to the project's documentation and examples on GitHub.

Competitor Comparisons

Official Transmission BitTorrent client repository

Pros of Transmission

  • Well-established, mature project with a large user base and extensive documentation
  • Cross-platform support with native clients for various operating systems
  • User-friendly GUI and web interface for easy management

Cons of Transmission

  • Written in C, which may be less accessible for some developers compared to Go
  • Slower development cycle and less frequent updates
  • More complex codebase due to its long history and broad feature set

Code Comparison

Transmission (C):

static void
tr_peerMgrAddIncoming(tr_peerMgr* manager, tr_address const* addr, tr_port port, struct peer_atom** atom)
{
    assert(tr_isAddress(addr));
    struct tr_peer_info* info = getExistingPeer(manager, addr, port);
    if (info == NULL)
        info = createPeerInfo(manager, addr, port, false, atom);
}

Torrent (Go):

func (cl *Client) AddTorrentInfoHash(ih metainfo.Hash) (t *Torrent, new bool, err error) {
    t, new = cl.AddTorrentInfoHashWithMeta(ih, nil)
    if new {
        go cl.startAcceptingConnections()
    }
    return
}

The code snippets demonstrate the different languages and approaches used in each project. Transmission's C code focuses on peer management, while Torrent's Go code shows a more high-level torrent addition function.

qBittorrent BitTorrent client

Pros of qBittorrent

  • Full-featured GUI client with cross-platform support
  • Actively maintained with regular updates and bug fixes
  • Large user base and community support

Cons of qBittorrent

  • Larger codebase and more complex architecture
  • Potentially higher resource usage due to GUI components
  • Less suitable for embedding in other Go projects

Code Comparison

qBittorrent (C++):

void TorrentHandle::addTrackers(const QVector<TrackerEntry> &trackers)
{
    if (trackers.isEmpty()) return;

    const libtorrent::torrent_handle nativeHandle = m_nativeHandle;
    for (const TrackerEntry &tracker : trackers)
        nativeHandle.add_tracker(tracker.nativeEntry());
}

anacrolix/torrent (Go):

func (cl *Client) AddTorrentInfoHash(infoHash metainfo.Hash) (t *Torrent, new bool, err error) {
    cl.lock()
    defer cl.unlock()
    t, ok := cl.torrents[infoHash]
    if ok {
        return t, false, nil
    }
    t = cl.newTorrent(infoHash, nil)
    return t, true, nil
}

Summary

qBittorrent is a comprehensive GUI-based torrent client, while anacrolix/torrent is a lightweight Go library for BitTorrent operations. qBittorrent offers a user-friendly interface and extensive features, making it suitable for end-users. anacrolix/torrent, on the other hand, is more appropriate for developers looking to integrate BitTorrent functionality into their Go projects.

an efficient feature complete C++ bittorrent implementation

Pros of libtorrent

  • Written in C++, offering high performance and efficiency
  • Extensive feature set, including support for various BitTorrent extensions
  • Well-documented and actively maintained by a large community

Cons of libtorrent

  • Steeper learning curve due to C++ complexity
  • Larger codebase, which may lead to longer compilation times
  • Potentially more challenging to integrate into non-C++ projects

Code Comparison

libtorrent (C++):

#include <libtorrent/session.hpp>
#include <libtorrent/add_torrent_params.hpp>
#include <libtorrent/torrent_handle.hpp>

lt::session ses;
lt::add_torrent_params p;
p.save_path = "./";
p.ti = std::make_shared<lt::torrent_info>("test.torrent");
lt::torrent_handle h = ses.add_torrent(p);

torrent (Go):

import "github.com/anacrolix/torrent"

client, _ := torrent.NewClient(nil)
t, _ := client.AddTorrentFromFile("test.torrent")
t.DownloadAll()
client.WaitAll()

Summary

libtorrent offers high performance and a rich feature set but comes with a steeper learning curve. torrent provides a simpler API and easier integration for Go projects but may have fewer advanced features. The choice between the two depends on the specific project requirements, programming language preferences, and desired level of control over the BitTorrent implementation.

⚡️ Streaming torrent client for the web

Pros of WebTorrent

  • Browser-based: Can run entirely in web browsers without additional software
  • Supports WebRTC for peer-to-peer communication in browsers
  • Large community and ecosystem with numerous extensions and integrations

Cons of WebTorrent

  • Limited to JavaScript, which may impact performance for some use cases
  • Lacks some advanced features found in native BitTorrent clients
  • May have compatibility issues with some traditional BitTorrent trackers

Code Comparison

WebTorrent (JavaScript):

const WebTorrent = require('webtorrent')
const client = new WebTorrent()

client.add(torrentId, (torrent) => {
  torrent.files.forEach(file => {
    file.createReadStream().pipe(process.stdout)
  })
})

Torrent (Go):

import "github.com/anacrolix/torrent"

client, _ := torrent.NewClient(nil)
t, _ := client.AddMagnet("magnet:?xt=urn:btih:...")
<-t.GotInfo()
t.DownloadAll()
client.WaitAll()

Summary

WebTorrent excels in browser-based scenarios and has a large ecosystem, while Torrent offers native performance and more advanced features. WebTorrent is ideal for web applications, whereas Torrent is better suited for standalone clients and server-side implementations. The choice between them depends on the specific requirements of your project and the target environment.

[Unofficial] qBittorrent Enhanced, based on qBittorrent

Pros of qBittorrent-Enhanced-Edition

  • User-friendly GUI for easier torrent management
  • More features, including advanced filtering and tagging options
  • Regular updates and active community support

Cons of qBittorrent-Enhanced-Edition

  • Larger resource footprint due to GUI and additional features
  • Less suitable for embedding in other applications or scripts
  • May have a steeper learning curve for users new to BitTorrent clients

Code Comparison

qBittorrent-Enhanced-Edition (C++):

void TorrentHandle::addTrackers(const QVector<TrackerEntry> &trackers)
{
    if (trackers.isEmpty()) return;

    const libtorrent::torrent_handle nativeHandle = m_nativeHandle;
    for (const TrackerEntry &tracker : trackers)
        nativeHandle.add_tracker(tracker.nativeEntry());
}

torrent (Go):

func (cl *Client) AddTrackers(t *Torrent, announceList [][]string) error {
    cl.lock()
    defer cl.unlock()
    return t.AddTrackers(announceList)
}

The code snippets show how each project handles adding trackers to a torrent. qBittorrent-Enhanced-Edition uses C++ and libtorrent, while torrent is written in Go and implements its own BitTorrent protocol.

1,520

Deluge BitTorrent client - Git mirror, PRs only

Pros of Deluge

  • Full-featured BitTorrent client with a graphical user interface
  • Supports plugins for extended functionality
  • Cross-platform compatibility (Windows, macOS, Linux)

Cons of Deluge

  • Written in Python, which may have performance limitations compared to Go
  • Less suitable for embedding in other applications
  • Larger codebase and potentially more complex to maintain

Code Comparison

Deluge (Python):

class TorrentManager(component.Component):
    def __init__(self):
        component.Component.__init__(self, "TorrentManager")
        self.torrents = {}
        self.queued_torrents = set()

Torrent (Go):

type Client struct {
    config *ClientConfig
    logger *log.Logger
    closed missinggo.Event
    mu     sync.Mutex
}

Summary

Deluge is a comprehensive BitTorrent client with a GUI, suitable for end-users across multiple platforms. Torrent is a Go library focused on providing BitTorrent functionality for developers to integrate into their applications. Deluge offers more features out-of-the-box, while Torrent provides better performance and is more suitable for embedding in other projects.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

torrent

PkgGoDev

This repository implements BitTorrent-related packages and command-line utilities in Go. The emphasis is on use as a library from other projects. It's been used 24/7 in production by downstream services since late 2014. The implementation was specifically created to explore Go's concurrency capabilities, and to include the ability to stream data directly from the BitTorrent network. To this end it supports seeking, readaheads and other features exposing torrents and their files with the various Go idiomatic io package interfaces. This is also demonstrated through torrentfs.

There is support for protocol encryption, DHT, PEX, uTP, and various extensions. There are several data storage backends provided: blob, file, bolt, mmap, and sqlite, to name a few. You can write your own to store data for example on S3, or in a database.

Some noteworthy package dependencies that can be used for other purposes include:

Installation

Install the library package with go get github.com/anacrolix/torrent, or the provided cmds with go install github.com/anacrolix/torrent/cmd/...@latest.

Library examples

There are some small examples in the package documentation.

Mentions

Downstream projects

There are several web-frontends, sites, Android clients, storage backends and supporting services among the known public projects:

  • cove: Personal torrent browser with streaming, DHT search, video transcoding and casting.
  • confluence: torrent client as a HTTP service
  • Gopeed: Gopeed (full name Go Speed), a high-speed downloader developed by Golang + Flutter, supports (HTTP, BitTorrent, Magnet) protocol, and supports all platforms.
  • Erigon: an implementation of Ethereum (execution layer with embeddable consensus layer), on the efficiency frontier.
  • exatorrent: Elegant self-hostable torrent client
  • bitmagnet: A self-hosted BitTorrent indexer, DHT crawler, content classifier and torrent search engine with web UI, GraphQL API and Servarr stack integration.
  • TorrServer: Torrent streaming server over http
  • distribyted: Distribyted is an alternative torrent client. It can expose torrent files as a standard FUSE, webDAV or HTTP endpoint and download them on demand, allowing random reads using a fixed amount of disk space.
  • Mangayomi: Cross-platform app that allows users to read manga and stream anime from a variety of sources including BitTorrent.
  • Simple Torrent: self-hosted HTTP remote torrent client
  • autobrr: autobrr redefines download automation for torrents and Usenet, drawing inspiration from tools like trackarr, autodl-irssi, and flexget.
  • mabel: Fancy BitTorrent client for the terminal
  • Toru: Stream anime from the the terminal!
  • webtor.io: free cloud BitTorrent-client
  • Android Torrent Client: Android torrent client
  • libtorrent: gomobile wrapper
  • Go-PeersToHTTP: Simple torrent proxy to http stream controlled over REST-like api
  • CortexFoundation/torrentfs: Independent HTTP service for file seeding and P2P file system of cortex full node
  • Torrent WebDAV Client: Automatic torrent download, streaming, WebDAV server and client.
  • goTorrent: torrenting server with a React web frontend
  • Go Peerflix: Start watching the movie while your torrent is still downloading!
  • hTorrent: HTTP to BitTorrent gateway with seeking support.
  • Remote-Torrent: Download Remotely and Retrieve Files Over HTTP
  • Trickl: torrent client for android
  • ANT-Downloader: ANT Downloader is a BitTorrent Client developed by golang, angular 7, and electron
  • Elementum (up to version 0.0.71)

Help

Communication about the project is primarily through Discussions and the issue tracker.

Command packages

Here I'll describe what some of the packages in ./cmd do. See installation to make them available.

torrent

torrent download

Downloads torrents from the command-line.

$ torrent download 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
... lots of jibber jabber ...
downloading "ubuntu-14.04.2-desktop-amd64.iso": 1.0 GB/1.0 GB, 1989/1992 pieces completed (1 partial)
2015/04/01 02:08:20 main.go:137: downloaded ALL the torrents
$ md5sum ubuntu-14.04.2-desktop-amd64.iso
1b305d585b1918f297164add46784116  ubuntu-14.04.2-desktop-amd64.iso
$ echo such amaze
wow

torrent metainfo magnet

Creates a magnet link from a torrent file. Note the extracted trackers, display name, and info hash.

$ torrent metainfo testdata/debian-10.8.0-amd64-netinst.iso.torrent magnet
magnet:?xt=urn:btih:4090c3c2a394a49974dfbbf2ce7ad0db3cdeddd7&dn=debian-10.8.0-amd64-netinst.iso&tr=http%3A%2F%2Fbttracker.debian.org%3A6969%2Fannounce

See torrent metainfo --help for other metainfo related commands.

torrentfs

torrentfs mounts a FUSE filesystem at -mountDir. The contents are the torrents described by the torrent files and magnet links at -metainfoDir. Data for read requests is fetched only as required from the torrent network, and stored at -downloadDir.

$ mkdir mnt torrents
$ torrentfs -mountDir=mnt -metainfoDir=torrents &
$ cd torrents
$ wget http://releases.ubuntu.com/14.04.2/ubuntu-14.04.2-desktop-amd64.iso.torrent
$ cd ..
$ ls mnt
ubuntu-14.04.2-desktop-amd64.iso
$ pv mnt/ubuntu-14.04.2-desktop-amd64.iso | md5sum
996MB 0:04:40 [3.55MB/s] [========================================>] 100%
1b305d585b1918f297164add46784116  -