Browse Source

Cargo.toml and README slightly updated. Pre-publishing renaming done.

Hovsep Papoyan 10 months ago
parent
commit
2229ad558d
6 changed files with 19 additions and 16 deletions
  1. 4 1
      Cargo.toml
  2. 7 7
      README.md
  3. 1 1
      build.rs
  4. 3 3
      src/bindings.cc
  5. 2 2
      src/bindings.hpp
  6. 2 2
      src/lib.rs

+ 4 - 1
Cargo.toml

@@ -1,7 +1,10 @@
 [package]
-name = "openfhe_rs_dev"
+name = "openfhe"
 version = "0.1.0"
 edition = "2021"
+description = "Rust package of the OpenFHE Fully Homomorphic Encryption Library."
+license-file = "LICENSE"
+repository = "https://github.com/fairmath/openfhe-rs"
 
 [dependencies]
 cxx = "1.0"

+ 7 - 7
README.md

@@ -11,13 +11,13 @@ Whether you're building secure data processing apps or privacy-focused tools, Op
 
 # Current status
 
-The library is under development and the ETA is Q2 2024.
+The library is under development and the ETA of the first version is set to Q2 2024.
 
-# Instructions for running examples:
+# Installation from source
 
-1. Build and install OpenFHE library (for more info refer to https://openfhe-development.readthedocs.io/en/latest/sphinx_rsts/intro/installation/installation.html#):
-   1.1. Build OpenFHE as shared libraries;
-   1.2. Don't specify an installation path (If no installation path is provided in Ubuntu (and many other Unix-based OSes),
+1. Build and install OpenFHE library using the [official docs](https://openfhe-development.readthedocs.io/en/latest/sphinx_rsts/intro/installation/installation.html#):
+   1. Build OpenFHE as shared libraries;
+   2. Don't specify an installation path (If no installation path is provided in Ubuntu (and many other Unix-based OSes),
         the header and library binary files will be placed in /usr/local/include/openfhe and /usr/local/lib, respectively);
-2. Make sure that "build.rs" file has the correct paths to shared libraries(OpenFHE) and libgomp(GNU Offloading and Multi Processing Runtime Library);
-3. run "cargo run".
+2. Make sure that `build.rs` file has the correct paths to shared libraries(OpenFHE) and libgomp(GNU Offloading and Multi Processing Runtime Library);
+3. run `cargo build`

+ 1 - 1
build.rs

@@ -19,7 +19,7 @@ fn main()
         .flag_if_supported("-Wno-unused-parameter") // [-Wunused-parameter]
         .flag_if_supported("-Wno-missing-field-initializers") // [-Wmissing-field-initializers]
         .flag_if_supported("-Wno-unused-function") // [-Wunused-function]
-        .compile("openfhe_rs_dev");
+        .compile("openfhe");
 
     println!("cargo::rerun-if-changed=src/lib.rs");
     println!("cargo::rerun-if-changed=src/bindings.hpp");

+ 3 - 3
src/bindings.cc

@@ -1,8 +1,8 @@
-#include "openfhe_rs_dev/src/lib.rs.h"
+#include "openfhe/src/lib.rs.h"
 
 #include "openfhe/pke/gen-cryptocontext.h"
 
-namespace openfhe_rs_dev
+namespace openfhe
 {
 PublicKeyDCRTPoly::PublicKeyDCRTPoly()
     : m_publicKey(std::make_shared<PublicKeyImpl>())
@@ -548,4 +548,4 @@ bool DeserializePublicKeyFromFile(const std::string& publicKeyLocation,
     }
     return false;
 }
-} // openfhe_rs_dev
+} // openfhe

+ 2 - 2
src/bindings.hpp

@@ -12,7 +12,7 @@ enum SerialMode
     JSON = 1,
 };
 
-namespace openfhe_rs_dev
+namespace openfhe
 {
 using ParamsBFVRNS = lbcrypto::CCParams<lbcrypto::CryptoContextBFVRNS>;
 using ParamsBGVRNS = lbcrypto::CCParams<lbcrypto::CryptoContextBGVRNS>;
@@ -240,4 +240,4 @@ bool SerializePublicKeyToFile(const std::string& publicKeyLocation,
     const PublicKeyDCRTPoly& publicKey, const SerialMode serialMode);
 bool DeserializePublicKeyFromFile(const std::string& publicKeyLocation,
     PublicKeyDCRTPoly& publicKey, const SerialMode serialMode);
-} // openfhe_rs_dev
+} // openfhe

+ 2 - 2
src/lib.rs

@@ -4,7 +4,7 @@
 
 use cxx::{CxxVector, SharedPtr, let_cxx_string};
 
-#[cxx::bridge(namespace = "openfhe_rs_dev")]
+#[cxx::bridge(namespace = "openfhe")]
 mod ffi
 {
     #[repr(i32)]
@@ -119,7 +119,7 @@ mod ffi
 
     unsafe extern "C++"
     {
-        include!("openfhe_rs_dev/src/bindings.hpp");
+        include!("openfhe/src/bindings.hpp");
         type SCHEME;
         type Params;
         type SecretKeyDist;