admin

Documentation

Index

• type Admin
  • func NewAdmin(client adminPb.AdminServiceClient) *Admin
• type Data
  • func (w *Data) GCStaged(ctx context.Context) (*proto.GCStagedResponse, error)
  • func (w *Data) PinnedCids(ctx context.Context) (*proto.PinnedCidsResponse, error)
• type StorageJobs
  • func (j *StorageJobs) Executing(ctx context.Context, opts ...StorageJobsOption) (*adminPb.ExecutingStorageJobsResponse, error)
  • func (j *StorageJobs) LatestFinal(ctx context.Context, opts ...StorageJobsOption) (*adminPb.LatestFinalStorageJobsResponse, error)
  • func (j *StorageJobs) LatestSuccessful(ctx context.Context, opts ...StorageJobsOption) (*adminPb.LatestSuccessfulStorageJobsResponse, error)
  • func (j *StorageJobs) Queued(ctx context.Context, opts ...StorageJobsOption) (*adminPb.QueuedStorageJobsResponse, error)
  • func (j *StorageJobs) Summary(ctx context.Context, opts ...StorageJobsOption) (*adminPb.StorageJobsSummaryResponse, error)
• type StorageJobsOption
  • func WithCids(cids ...string) StorageJobsOption
  • func WithUserID(userID string) StorageJobsOption
• type Users
  • func (p *Users) Create(ctx context.Context) (*adminPb.CreateUserResponse, error)
  • func (p *Users) List(ctx context.Context) (*adminPb.UsersResponse, error)
• type Wallet
  • func (w *Wallet) Addresses(ctx context.Context) (*adminPb.AddressesResponse, error)
  • func (w *Wallet) NewAddress(ctx context.Context, addrType string) (*adminPb.NewAddressResponse, error)
  • func (w *Wallet) SendFil(ctx context.Context, from, to string, amount *big.Int) (*adminPb.SendFilResponse, error)

Types

type Admin

type Admin struct {
	StorageJobs *StorageJobs
	Users       *Users
	Wallet      *Wallet
	Data        *Data
}

Admin provides access to Powergate admin APIs.

func NewAdmin

func NewAdmin(client adminPb.AdminServiceClient) *Admin

NewAdmin creates a new admin API.

type Data

type Data struct {
	// contains filtered or unexported fields
}

Data provides access to Powergate data admin APIs.

func (*Data) GCStaged

func (w *Data) GCStaged(ctx context.Context) (*proto.GCStagedResponse, error)

GCStaged unpins staged data not related to queued or executing jobs.

func (*Data) PinnedCids

func (w *Data) PinnedCids(ctx context.Context) (*proto.PinnedCidsResponse, error)

PinnedCids returns pinned cids information of hot-storage.

type StorageJobs

type StorageJobs struct {
	// contains filtered or unexported fields
}

StorageJobs provides access to Powergate jobs admin APIs.

func (*StorageJobs) Executing

func (j *StorageJobs) Executing(ctx context.Context, opts ...StorageJobsOption) (*adminPb.ExecutingStorageJobsResponse, error)

Executing returns a list of executing storage jobs.

func (*StorageJobs) LatestFinal

func (j *StorageJobs) LatestFinal(ctx context.Context, opts ...StorageJobsOption) (*adminPb.LatestFinalStorageJobsResponse, error)

LatestFinal returns a list of latest final storage jobs.

func (*StorageJobs) LatestSuccessful

func (j *StorageJobs) LatestSuccessful(ctx context.Context, opts ...StorageJobsOption) (*adminPb.LatestSuccessfulStorageJobsResponse, error)

LatestSuccessful returns a list of latest successful storage jobs.

func (*StorageJobs) Queued

func (j *StorageJobs) Queued(ctx context.Context, opts ...StorageJobsOption) (*adminPb.QueuedStorageJobsResponse, error)

Queued returns a list of queued storage jobs.

func (*StorageJobs) Summary

func (j *StorageJobs) Summary(ctx context.Context, opts ...StorageJobsOption) (*adminPb.StorageJobsSummaryResponse, error)

Summary returns a summary of storage jobs.

type StorageJobsOption

type StorageJobsOption = func(*storageJobsConfig)

StorageJobsOption configures a storageJobsConfig.

func WithCids

func WithCids(cids ...string) StorageJobsOption

WithCids filters the results to the specified data cids.

func WithUserID

func WithUserID(userID string) StorageJobsOption

WithUserID filters the results to the specified user.

type Users

type Users struct {
	// contains filtered or unexported fields
}

Users provides access to Powergate admin users APIs.

func (*Users) Create

func (p *Users) Create(ctx context.Context) (*adminPb.CreateUserResponse, error)

Create creates a new Powergate user, returning the user ID and auth token.

func (*Users) List

func (p *Users) List(ctx context.Context) (*adminPb.UsersResponse, error)

List returns a list of existing users.

type Wallet

type Wallet struct {
	// contains filtered or unexported fields
}

Wallet provides access to Powergate wallet admin APIs.

func (*Wallet) Addresses

func (w *Wallet) Addresses(ctx context.Context) (*adminPb.AddressesResponse, error)

Addresses lists all addresses associated with this Powergate.

func (*Wallet) NewAddress

func (w *Wallet) NewAddress(ctx context.Context, addrType string) (*adminPb.NewAddressResponse, error)

NewAddress creates a new address.

func (*Wallet) SendFil

func (w *Wallet) SendFil(ctx context.Context, from, to string, amount *big.Int) (*adminPb.SendFilResponse, error)

SendFil sends FIL from an address associated with this Powergate to any other address.