ipns

Documentation

Index

• type Manager
  • func NewManager(keys *mdb.IPNSKeys, keyAPI iface.KeyAPI, nameAPI iface.NameAPI, ...) (*Manager, error)
  • func (m *Manager) Close()
  • func (m *Manager) CreateKey(ctx context.Context, dbID thread.ID, path path.Path) (keyID string, err error)
  • func (m *Manager) Publish(pth path.Path, keyID string)
  • func (m *Manager) RemoveKey(ctx context.Context, keyID string) error
  • func (m *Manager) StartRepublishing(schedule string) error

Types

type Manager

type Manager struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Manager handles bucket name publishing to IPNS.

func NewManager

func NewManager(
	keys *mdb.IPNSKeys,
	keyAPI iface.KeyAPI,
	nameAPI iface.NameAPI,
	republishConcurrency int,
	debug bool,
) (*Manager, error)

NewManager returns a new IPNS manager.

func (*Manager) Close

func (m *Manager) Close()

Close manager.

func (*Manager) CreateKey

func (m *Manager) CreateKey(ctx context.Context, dbID thread.ID, path path.Path) (keyID string, err error)

CreateKey generates and saves a new IPNS key.

func (*Manager) Publish

func (m *Manager) Publish(pth path.Path, keyID string)

Publish publishes a path to IPNS with key ID. Publishing can take up to a minute. Pending publishes are cancelled by consecutive calls with the same key ID, which results in only the most recent publish succeeding.

func (*Manager) RemoveKey

func (m *Manager) RemoveKey(ctx context.Context, keyID string) error

RemoveKey removes an IPNS key.

func (*Manager) StartRepublishing

func (m *Manager) StartRepublishing(schedule string) error

StartRepublishing initializes a key republishing cron