@functionland/react-native-fula 0.4.2 → 1.1.4

package/lib/typescript/interfaces/fulaNativeModule.d.ts

@@ -1,8 +1,26 @@
 interface FulaNativeModule {
-    init: (identity: string | null, //Private key of did identity
-    storePath: string | null, //You can leave empty
+    init: (identity: string, //Private key of did identity
+    storePath: string, //You can leave empty
     bloxAddr: string, //Blox multiadddr needs to be manually entered now
-    exchange: string) => Promise<[string, string, string]>;
+    exchange: string, //set to 'noope' for testing
+    autoFlush: boolean, //set to false always unless you know what you are doing. This is to write actions to disk explicitly after each write
+    rootCid: string | null, //if you have the latest rootCid you can send it and it generates the private_ref for filesystem
+    useRelay: boolean | null, // if true it forces the use of relay
+    refresh: boolean) => Promise<{
+        peerId: string;
+        rootCid: string;
+        private_ref: string;
+    }>;
+    newClient: (identity: string, //Private key of did identity
+    storePath: string, //You can leave empty
+    bloxAddr: string, //Blox multiadddr needs to be manually entered now
+    exchange: string, //set to 'noope' for testing
+    autoFlush: boolean, //set to false always unless you know what you are doing. This is to write actions to disk explicitly after each write
+    useRelay: boolean | null) => Promise<string>;
+    isReady: (filesystemCheck: boolean) => Promise<boolean>;
+    logout: (identity: string, storePath: string) => Promise<boolean>;
+    checkFailedActions: (retry: boolean) => Promise<boolean>;
+    checkConnection: () => Promise<boolean>;
     get: (key: string) => Promise<string>;
     has: (key: Uint8Array) => Promise<boolean>;
     push: () => Promise<string>;
@@ -12,9 +30,28 @@ interface FulaNativeModule {
     writeFile: (fulaTargetFilename: string, localFilename: string) => Promise<string>;
     ls: (path: string) => Promise<string>;
     rm: (path: string) => Promise<string>;
+    cp: (sourcePath: string, targetPath: string) => Promise<string>;
+    mv: (sourcePath: string, targetPath: string) => Promise<string>;
     readFile: (fulaTargetFilename: string, localFilename: string) => Promise<string>;
     readFileContent: (path: string) => Promise<string>;
+    setAuth: (peerId: string, allow: boolean) => Promise<boolean>;
     shutdown: () => Promise<void>;
+    createAccount: (seed: string) => Promise<string>;
+    checkAccountExists: (account: string) => Promise<string>;
+    createPool: (seed: string, poolName: string) => Promise<string>;
+    listPools: () => Promise<string>;
+    joinPool: (seed: string, poolID: number) => Promise<string>;
+    leavePool: (seed: string, poolID: number) => Promise<string>;
+    cancelPoolJoin: (seed: string, poolID: number) => Promise<string>;
+    listPoolJoinRequests: (poolID: number) => Promise<string>;
+    votePoolJoinRequest: (seed: string, poolID: number, account: string, accept: boolean) => Promise<string>;
+    newReplicationRequest: (seed: string, poolID: number, replicationFactor: number, cid: string) => Promise<string>;
+    newStoreRequest: (seed: string, poolID: number, uploader: string, cid: string) => Promise<string>;
+    listAvailableReplicationRequests: (poolID: number) => Promise<string>;
+    removeReplicationRequest: (seed: string, poolID: number, cid: string) => Promise<string>;
+    removeStorer: (seed: string, storer: string, poolID: number, cid: string) => Promise<string>;
+    removeStoredReplication: (seed: string, uploader: string, poolID: number, cid: string) => Promise<string>;
+    bloxFreeSpace: () => Promise<string>;
 }
 declare const _default: FulaNativeModule;
 export default _default;

package/lib/typescript/protocols/blockchain.d.ts

@@ -0,0 +1,17 @@
+import type * as BType from '../types/blockchain';
+export declare const createAccount: (seed: string) => Promise<BType.SeededResponse>;
+export declare const checkAccountExists: (account: string) => Promise<BType.AccountExistsResponse>;
+export declare const createPool: (seed: string, poolName: string) => Promise<BType.PoolCreateResponse>;
+export declare const listPools: () => Promise<BType.PoolListResponse>;
+export declare const joinPool: (seed: string, poolID: number) => Promise<BType.PoolJoinResponse>;
+export declare const leavePool: (seed: string, poolID: number) => Promise<BType.PoolLeaveResponse>;
+export declare const cancelPoolJoin: (seed: string, poolID: number) => Promise<BType.PoolCancelJoinResponse>;
+export declare const listPoolJoinRequests: (poolID: number) => Promise<BType.PoolRequestsResponse>;
+export declare const votePoolJoinRequest: (seed: string, poolID: number, account: string, accept: boolean) => Promise<BType.PoolVoteResponse>;
+export declare const newReplicationRequest: (seed: string, poolID: number, replicationFactor: number, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const newStoreRequest: (seed: string, poolID: number, uploader: string, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const listAvailableReplicationRequests: (poolID: number) => Promise<BType.ManifestUploadResponse[]>;
+export declare const removeReplicationRequest: (seed: string, poolID: number, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const removeStorer: (seed: string, storer: string, poolID: number, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const removeStoredReplication: (seed: string, uploader: string, poolID: number, cid: string) => Promise<BType.ManifestUploadResponse>;
+export declare const bloxFreeSpace: () => Promise<BType.BloxFreeSpaceResponse>;

package/lib/typescript/protocols/chain-api.d.ts

@@ -0,0 +1,6 @@
+import { ApiPromise } from '@polkadot/api';
+import type * as BType from '../types/blockchain';
+export declare const init: (wsAddress?: string) => Promise<ApiPromise>;
+export declare const disconnectApi: (api: ApiPromise) => Promise<void>;
+export declare const listPools: (api: ApiPromise | undefined, start?: number, length?: number) => Promise<BType.PoolListResponse>;
+export declare const checkJoinRequest: (api: ApiPromise | undefined, poolId: number, accountId: string) => Promise<BType.PoolRequest | null>;

package/lib/typescript/protocols/fula.d.ts

@@ -4,7 +4,32 @@
  * @param config
  * @returns boolean
  */
-export declare const init: (identity: string, storePath: string, bloxAddr: string, exchange: string) => Promise<[string, string, string]>;
+export declare const init: (identity: string, storePath: string, bloxAddr: string, exchange: string, autoFlush?: boolean, rootCid?: string | null, useRelay?: boolean, refresh?: boolean) => Promise<{
+    peerId: string;
+    rootCid: string;
+    private_ref: string;
+}>;
+/**
+ * Get gets the value corresponding to the given key from the local datastore.
+// The key must be a valid ipld.Link.
+ * @param config
+ * @returns boolean
+ */
+export declare const newClient: (identity: string, storePath: string, bloxAddr: string, exchange: string, autoFlush?: boolean, useRelay?: boolean) => Promise<string>;
+/**
+ * rm removes all data
+ * @param path
+ * @returns string: new cid of the root
+ */
+export declare const logout: (identity: string, storePath: string) => Promise<boolean>;
+/**
+ * Checks if there are any un-synced changes on the device
+ */
+export declare const checkFailedActions: (retry?: boolean) => Promise<boolean>;
+/**
+ * Checks if there are any un-synced changes on the device
+ */
+export declare const checkConnection: () => Promise<boolean>;
 /**
  * Get gets the value corresponding to the given key from the local datastore.
 // The key must be a valid ipld.Link.
@@ -54,13 +79,25 @@ export declare const writeFile: (fulaTargetFilename: string, localFilename: stri
  * @returns string: list of items
  * TODO: Findout how is the string and convert to array
  */
-export declare const ls: (path: string) => Promise<string>;
+export declare const ls: (path: string) => Promise<void | JSON>;
 /**
  * rm removes all files and folders at a given path
  * @param path
  * @returns string: new cid of the root
  */
 export declare const rm: (path: string) => Promise<string>;
+/**
+ * cp copies the file or folder at the sourcePath to targetPath. targetPath is a folder that must exist already
+ * @param sourcePath, targetPath
+ * @returns string: new cid of the root
+ */
+export declare const cp: (sourcePath: string, targetPath: string) => Promise<string>;
+/**
+ * mv moves the file or folder at the sourcePath to targetPath. targetPath is a folder that must exist already
+ * @param sourcePath, targetPath
+ * @returns string: new cid of the root
+ */
+export declare const mv: (sourcePath: string, targetPath: string) => Promise<string>;
 export declare const readFile: (fulaTargetFilename: string, localFilename: string) => Promise<string>;
 /**
  * readFile reads content of a given path
@@ -75,3 +112,16 @@ export declare const readFileContent: (path: string) => Promise<string>;
  * @returns
  */
 export declare const shutdown: () => Promise<void>;
+/**
+ * setAuth adds or removes a peer from the list of peers that are allowed to push to this node.
+ * This can only be called on a peer that is added as an owner of blox by --authorizer parameter
+ * @param peerId, allow
+ * @returns boolean: true if successful or false if not
+ */
+export declare const setAuth: (peerId: string, allow: boolean) => Promise<boolean>;
+/**
+ * isReady checks if the connection is ready to be used.
+ * @param filesystemCheck: also check if the wnfs is ready
+ * @returns boolean: true if ready or false if not
+ */
+export declare const isReady: (filesystemCheck?: boolean) => Promise<boolean>;

package/lib/typescript/types/blockchain.d.ts

@@ -0,0 +1,68 @@
+export interface SeededResponse {
+    seed: string;
+    account: string;
+}
+export interface AccountExistsResponse {
+    account: string;
+    exists: boolean;
+}
+export interface PoolCreateResponse {
+    owner: string;
+    poolID: number;
+}
+export interface PoolJoinResponse {
+    account: string;
+    poolID: number;
+}
+export interface PoolCancelJoinResponse {
+    account: string;
+    poolID: number;
+}
+export interface PoolRequestsResponse {
+    poolRequests: PoolRequest[];
+}
+export interface PoolListResponse {
+    pools: Pool[];
+}
+export interface PoolVoteResponse {
+    account: string;
+    poolID: number;
+}
+export interface PoolLeaveResponse {
+    account: string;
+    poolID: number;
+}
+export interface ManifestUploadResponse {
+    uploader: string;
+    storage: string[];
+    manifestMetadata: ManifestMetadata;
+    poolID: number;
+}
+export interface PoolRequest {
+    poolID: number;
+    account: string;
+    voted: string[];
+    positiveVotes: number;
+    peerID: string;
+}
+export interface Pool {
+    poolID: number;
+    owner: string;
+    poolName: string;
+    parent: string;
+    participants: string[];
+}
+export interface ManifestMetadata {
+    job: ManifestJob;
+}
+export interface ManifestJob {
+    work: string;
+    engine: string;
+    uri: string;
+}
+export interface BloxFreeSpaceResponse {
+    size: number;
+    avail: number;
+    used: number;
+    used_percentage: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@functionland/react-native-fula",
-  "version": "0.4.2",
+  "version": "1.1.4",
   "description": "This package is a bridge to use the Fula libp2p protocols in the react-native which is using wnfs",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -28,7 +28,7 @@
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
     "prepare": "bob build",
     "release": "release-it",
-    "example": "yarn --cwd example",
+    "example": "set NODE_OPTIONS=--openssl-legacy-provider && yarn --cwd example",
     "pods": "cd example && pod-install --quiet",
     "bootstrap": "yarn example && yarn && yarn pods"
   },
@@ -46,9 +46,6 @@
   "homepage": "https://github.com/functionland/react-native-fula#readme",
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
-  },
-  "dependencies": {
-
   },
   "devDependencies": {
     "@babel/plugin-proposal-export-namespace-from": "^7.16.7",
@@ -57,7 +54,7 @@
     "@release-it/conventional-changelog": "^2.0.0",
     "@types/jest": "^26.0.0",
     "@types/react": "^16.9.19",
-    "@types/react-native": "0.62.13",
+    "@types/react-native": "0.70.8",
     "commitlint": "^11.0.0",
     "eslint": "^7.2.0",
     "eslint-config-prettier": "^7.0.0",
@@ -66,13 +63,15 @@
     "jest": "^26.0.1",
     "pod-install": "^0.1.0",
     "prettier": "^2.0.5",
-    "react": "16.13.1",
-    "react-native": "0.63.4",
+    "react": "^18.1.0",
+    "react-native": "0.70.6",
     "react-native-builder-bob": "^0.18.0",
     "release-it": "^14.2.2",
     "typescript": "^4.1.3"
   },
   "peerDependencies": {
+    "@babel/core": "^7.0.0-0",
+    "@babel/preset-env": "^7.1.6",
     "react": "*",
     "react-native": "*"
   },
@@ -148,5 +147,11 @@
         }
       ]
     ]
+  },
+  "dependencies": {
+    "@polkadot/api": "^9.11.3",
+    "@polkadot/keyring": "^10.2.6",
+    "@polkadot/util": "^10.2.6",
+    "@polkadot/util-crypto": "^10.2.6"
   }
 }

package/src/index.tsx

@@ -1 +1,3 @@
-export * as fula from './protocols/fula';
+export * as fula from './protocols/fula';
+export * as blockchain from './protocols/blockchain';
+export * as chainApi from './protocols/chain-api';