hyperspace

package module

Go to main page

Versions in this module

v1

v1.2.2

Jul 7, 2026

Changes in this version

+ type ConnectionRole int

+ const RoleAnnounce

+ const RoleAuto

+ const RoleConnect

type Pool

+ func (p *Pool) ConnectAnnounce(ctx context.Context, id string, passcode string) error

+ func (p *Pool) ConnectWithKeysAndRole(ctx context.Context, id string, passcode string, keys *KeyPair, ...) error

+ func (p *Pool) ConnectWithRole(ctx context.Context, id string, passcode string, role ConnectionRole) error

v1.2.1

Jul 7, 2026

v1.2.0

Jul 7, 2026

Changes in this version

+ func Base32ToPasscode(base32Str string) ([]byte, error)

+ func PasscodeToBase32(passcode []byte) string

v1.1.0

Jul 7, 2026

Changes in this version

+ type ConnectionEvent struct

+ Error error

+ ID string

+ NewState ConnectionState

+ OldState ConnectionState

+ Timestamp time.Time

type Pool

+ func (p *Pool) Subscribe() *Subscription

+ func (p *Pool) SubscribeConnection(id string) *Subscription

+ type Subscription struct

+ Events <-chan ConnectionEvent

+ func (s *Subscription) Unsubscribe()

v1.0.0

Jul 7, 2026

Changes in this version

+ var ErrCancelled = fmt.Errorf("connection cancelled")

+ var ErrConnectionExists = fmt.Errorf("connection with this ID already exists")

+ var ErrConnectionNotFound = fmt.Errorf("connection not found")

+ var ErrConnectionNotReady = fmt.Errorf("connection is not ready")

+ var ErrMaxRetries = fmt.Errorf("max retries exceeded")

+ var ErrPoolClosed = fmt.Errorf("pool is closed")

type Connection

+ func (c *Connection) Done() <-chan struct{}

+ type ConnectionInfo struct

+ ConnectedAt time.Time

+ CreatedAt time.Time

+ ID string

+ LastAttemptAt time.Time

+ LastError string

+ MaxRetries int

+ PasscodeZ32 string

+ RetryCount int

+ State ConnectionState

+ type ConnectionState int

+ const StateActive

+ const StateCancelled

+ const StateClosed

+ const StateFailed

+ const StatePending

+ func (s ConnectionState) String() string

+ type KeyPair struct

+ PrivateKey []byte

+ PublicKey []byte

+ type Pool struct

+ func NewPool(config *PoolConfig) *Pool

+ func (p *Pool) Cancel(id string) error

+ func (p *Pool) CancelAll() map[string]error

+ func (p *Pool) Close() error

+ func (p *Pool) CloseAll() map[string]error

+ func (p *Pool) Connect(ctx context.Context, id string, passcode string) error

+ func (p *Pool) ConnectWithKeys(ctx context.Context, id string, passcode string, keys *KeyPair) error

+ func (p *Pool) Get(id string) (*ConnectionInfo, error)

+ func (p *Pool) IDs() []string

+ func (p *Pool) List() []ConnectionInfo

+ func (p *Pool) ListActive() []ConnectionInfo

+ func (p *Pool) ListByState(state ConnectionState) []ConnectionInfo

+ func (p *Pool) Remove(id string) error

+ func (p *Pool) Stream(id string) (io.ReadWriteCloser, error)

+ func (p *Pool) WaitForAllReady(ctx context.Context) map[string]error

+ func (p *Pool) WaitForReady(ctx context.Context, id string) error

+ type PoolConfig struct

+ ConnectTimeout time.Duration

+ MaxRetries int

+ RetryDelay time.Duration

+ func DefaultPoolConfig() PoolConfig

v0

v0.0.2

Jul 6, 2026

Changes in this version

+ func PingPeer(passcode string, timeout time.Duration) bool

+ type PresenceResult struct

+ Error error

+ Found bool

+ PublicKey []byte

+ func CheckPresence(passcode string, timeout time.Duration) PresenceResult

+ func CheckPresenceWithKeys(myPrivateKey, theirPublicKey []byte, timeout time.Duration, ...) PresenceResult

v0.0.1

Jul 6, 2026

Changes in this version

+ const PasscodeContext

+ const PasscodeSize

+ var ErrHyperbeamNotFound = fmt.Errorf("hyperbeam not found - install with: npm install -g hyperbeam")

+ var ErrInvalidKeySize = fmt.Errorf("key must be %d bytes", curve25519.PointSize)

+ func ComputeSharedSecret(privateKey, peerPublicKey []byte) ([]byte, error)

+ func DefaultNodePath() string

+ func DerivePasscode(sharedSecret []byte) ([]byte, error)

+ func DerivePasscodeFromKeys(myPrivateKey, theirPublicKey []byte) ([]byte, error)

+ func EnsureHyperbeam() error

+ func HyperbeamPath() (string, error)

+ func InstallHyperbeam() error

+ func IsHyperbeamInstalled() bool

+ func NodePath() (string, error)

+ func NpmPath() (string, error)

+ func PasscodeToHex(passcode []byte) string

+ func PasscodeToZ32(passcode []byte) string

+ func Z32ToPasscode(z32 string) ([]byte, error)

+ type ConnectOptions struct

+ Env []string

+ type Connection struct

+ func Connect(passcode string) (*Connection, error)

+ func ConnectWithKeys(myPrivateKey, theirPublicKey []byte) (*Connection, error)

+ func ConnectWithPasscode(passcode string, opts *ConnectOptions) (*Connection, error)

+ func (c *Connection) Close() error

+ func (c *Connection) Process() *exec.Cmd

+ func (c *Connection) Read(p []byte) (n int, err error)

+ func (c *Connection) SetOnClose(fn func())

+ func (c *Connection) Stderr() io.Reader

+ func (c *Connection) Write(p []byte) (n int, err error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL