Categorygithub.com/proximax-storage/go-xpx-dfms-api-http
repositorypackage
0.4.1
Repository: https://github.com/proximax-storage/go-xpx-dfms-api-http.git
Documentation: pkg.go.dev

# README

go-xpx-dfms-api-http

Documentation Go Report Card proximax standard-readme compliant

The Client's API is experimental and can often change.

Current status: under active development

Welcome to DFMS!

The package is the HTTP client for all DFMS's applications. It gives an ability to operate DFMS(Clients) and DFMSR(Replicators) nodes remotely through a generic API.

Table of Contents

Background

DFMS(Decentralized File Management System) - is a new advanced technology developed by ProximaX which represents the Storage Layer of ProximaX infrastructure platform solution.

DFMS provides an easy-to-use decentralized market of disk space using the Blockchain and the DLT powdered with cryptography magic.

Requirements

go version 1.12 or higher

Install

$ go get github.com/proximax-storage/go-xpx-dfms-http-client

Usage

Simply create new Client using an address the DFMS application's API listens to and you are ready to go:

client := client.New(address)

...

Creating new Drive contract:

contract, err := client.ContractAPI().Compose(ctx, space, duration)

...

API

TODO

Maintainers

@Wondertan @BramBear @mrLSD

Contributing

Feel free to dive in! Open an issue or submit PRs.

License

Apache 2.0 © 2019 ProximaX Limited