README.md

maidsafe_client

Primary Maintainer: Spandan Sharma ([email protected])

Secondary Maintainer: Krishna Kumar ([email protected])

Crate	Linux	Windows	OSX	Coverage

API Documentation - master branch	SAFE Network System Documention	MaidSafe website	Safe Community site

###Pre-requisite: libsodium is a native dependency for sodiumxoide. Thus, install sodium by following the instructions here.

For windows, download and use the prebuilt mingw library. Extract and place the libsodium.a file in "bin\x86_64-pc-windows-gnu" for 64bit System, or "bin\i686-pc-windows-gnu" for a 32bit system.

###Build Instructions: Maidsafe-Client interfaces conditionally with either the actual routing crate or the Mock used for efficient local testing.

To use it with the Mock (default) do:

cargo build
cargo test
etc

To interface it with actual routing, do:

cargo build --features "USE_ACTUAL_ROUTING"
cargo test --features "USE_ACTUAL_ROUTING"
etc

#Todo

• MAID-1077 Account Creation

  • MAID-1078 Register
  • MAID-1079 Login

• Implement Storage API

  • MAID-1080 Implement types
    • Implement MetaData, File and DirectoryListing types
    • Implement wrapper traits
  • Implement Helpers
    • MAID-1081 Directory Helper
      • Save DirectoryListing
      • Get Directory
      • Get Directory Versions
    • File Helper
      • MAID-1082 Create File, update file and Metatdata
      • MAID-1083 Get Versions
      • MAID-1084 Read File
    • MAID-1085 Unit test cases for Directory and File Helpers
  • Implement REST DataTypes
    • MAID-1086 Container & Blob types
      • Implement Blob and Container types
      • Implement FileWrapper trait for Blob
      • Implement DirectoryListingWrapper trait for Container
    • REST API methods in Container
      • MAID-1087 Create Container & Get Container
      • MAID-1088 List Containers, Update / Get Container Metadata
      • MAID-1089 Delete Container
      • MAID-1090 Create Blob
      • MAID-1091 List Blobs
      • MAID-1092 Get Blob
      • MAID-1098 Update Blob Content
      • MAID-1093 Get Blob Content
      • MAID-1094 List Blob Version
      • MAID-1095 Delete Blob
      • MAID-1096 Copy Blob
      • MAID-1097 Update / Get Blob Metadata
    • MAID-1099 Unit test cases for API
  • MAID-1101 Implement Version Cache (cache key,(blob/container) info to reduce network traffic)
  • MAID-1133 Root Directory handling

• Create Example:

  • MAID-1102 Self authentication Example
  • MAID-1103 Example to demonstrate Storage API

  [0.1] Finish sprint

  • MAID-1104 Validate above example against Local network / droplet