@functionland/react-native-fula 1.0.0 → 1.1.5

package/src/interfaces/fulaNativeModule.ts

@@ -1,52 +1,86 @@
-import { NativeModules, Platform } from 'react-native';
-
-interface FulaNativeModule {
-  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, //set to 'noope' for testing
-    rootCid: string | null //if you have the latest rootCid you can send it and it generates the private_ref for filesystem
-  ) => Promise<{ peerId: string; rootCid: string; private_ref: string }>;
-  logout: (identity: string, storePath: string) => Promise<boolean>;
-  get: (key: string) => Promise<string>;
-  has: (key: Uint8Array) => Promise<boolean>;
-  push: () => Promise<string>;
-  put: (content: string, codec: string) => Promise<string>;
-  mkdir: (path: string) => Promise<string>;
-  writeFileContent: (path: string, content: string) => Promise<string>;
-  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>;
-
-  shutdown: () => Promise<void>;
-}
-
-const LINKING_ERROR =
-  `The package 'react-native-fula' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo managed workflow\n';
-
-const Fula = NativeModules.FulaModule
-  ? NativeModules.FulaModule
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
-
-export default Fula as FulaNativeModule;
+import { NativeModules, Platform } from 'react-native';
+
+interface FulaNativeModule {
+  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, //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 // if true it forces to refresh the fula object
+  ) => 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, // if true it forces the use of relay
+    refresh: boolean // if true it forces to refresh the fula object
+    ) => 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>;
+  put: (content: string, codec: string) => Promise<string>;
+  mkdir: (path: string) => Promise<string>;
+  writeFileContent: (path: string, content: string) => Promise<string>;
+  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>;
+
+//Blockchain related functions
+  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>;
+}
+
+const LINKING_ERROR =
+  `The package 'react-native-fula/Fula' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo managed workflow\n';
+
+const Fula = NativeModules.FulaModule
+  ? NativeModules.FulaModule
+  : new Proxy(
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR);
+        },
+      }
+    );
+
+export default Fula as FulaNativeModule;

package/src/protocols/blockchain.ts

@@ -0,0 +1,460 @@
+import Fula from '../interfaces/fulaNativeModule';
+import type * as BType from '../types/blockchain';
+
+/*
+createAccount: This function takes a seed argument, which is used to create an account. The seed must start with "/". The function returns a promise of an object that contains the seed and the account that was created.
+*/
+export const createAccount = (
+  seed: string, //seed that is used to create the account. It must start with "/"
+): Promise<BType.SeededResponse> => {
+  console.log(
+    'createAccount in react-native started',
+    seed
+  );
+  let res = Fula.createAccount(seed).then((res) => {
+    try{
+      let jsonRes:BType.SeededResponse = JSON.parse(res);
+      return jsonRes;
+    } catch (e) {
+      try {
+        return JSON.parse(res)
+      } catch (e) {
+        return res;
+      }
+    }
+  }).catch((err) => {
+    return err;
+  });
+  return res;
+};
+
+/*
+checkAccountExists: This function takes an account argument, and returns a promise of an object that contains the account and a boolean exists flag. If exists is true, it means the account exists, otherwise, the account does not exist
+*/
+export const checkAccountExists = (
+  account: string,
+): Promise<BType.AccountExistsResponse> => {
+  console.log(
+    'checkAccountExists in react-native started',
+    account
+  );
+  let res = Fula.checkAccountExists(account).then((res) => {
+    try{
+      let jsonRes: BType.AccountExistsResponse = JSON.parse(res);
+      return jsonRes;
+    } catch (e) {
+      try {
+        return JSON.parse(res)
+      } catch (e) {
+        return res;
+      }
+    }
+  }).catch((err) => {
+    return err;
+  });
+  return res;
+};
+
+/*
+createPool: This function takes two arguments: seed and poolName. The seed is used to identify the account that is creating the pool, and the poolName is the name of the pool being created. The function returns a promise of an object that contains the owner of the pool and the poolID of the created pool.
+*/
+export const createPool = (seed: string, poolName: string): Promise<BType.PoolCreateResponse> => {
+  console.log(
+  'createPool in react-native started',
+  seed,
+  poolName
+  );
+  let res = Fula.createPool(seed, poolName).then((res) => {
+  try {
+  let jsonRes: BType.PoolCreateResponse = JSON.parse(res);
+  return jsonRes;
+  } catch (e) {
+  try {
+  return JSON.parse(res);
+  } catch (e) {
+  return res;
+  }
+  }
+  }).catch((err) => {
+  return err;
+  });
+  return res;
+  };
+  
+  /*
+  listPools: This function takes no arguments and returns a promise of an object that contains a list of pools. Each pool in the list contains the poolID, owner, poolName, parent, and participants of the pool
+  */
+  export const listPools = (): Promise<BType.PoolListResponse> => {
+    console.log(
+    'listPools in react-native started'
+    );
+    let res = Fula.listPools().then((res) => {
+    try {
+    let jsonRes: BType.PoolListResponse = JSON.parse(res);
+    return jsonRes;
+    } catch (e) {
+    try {
+    return JSON.parse(res);
+    } catch (e) {
+    return res;
+    }
+    }
+    }).catch((err) => {
+    return err;
+    });
+    return res;
+    };
+
+    /*
+    joinPool: This function takes two arguments: seed and poolID. The seed is used to identify the account that is joining the pool, and the poolID is the ID of the pool the account is joining. The function returns a promise of an object that contains the account joining the pool and the poolID of the joined pool.
+    */
+
+    export const joinPool = (seed: string, poolID: number): Promise<BType.PoolJoinResponse> => {
+      console.log(
+      'joinPool in react-native started',
+      seed,
+      poolID
+      );
+      let res = Fula.joinPool(seed, poolID).then((res) => {
+      try {
+      let jsonRes: BType.PoolJoinResponse = JSON.parse(res);
+      return jsonRes;
+      } catch (e) {
+      try {
+      return JSON.parse(res);
+      } catch (e) {
+      return res;
+      }
+      }
+      }).catch((err) => {
+      return err;
+      });
+      return res;
+      };
+
+      /*
+      leavePool: This function takes two arguments: seed and poolID. The seed is used to identify the account that is leaving the pool, and the poolID is the ID of the pool the account is leaving. The function returns a promise of an object that contains the `
+      */
+     
+      export const leavePool = (seed: string, poolID: number): Promise<BType.PoolLeaveResponse> => {
+        console.log(
+        'leavePool in react-native started',
+        seed,
+        poolID
+        );
+        let res = Fula.leavePool(seed, poolID).then((res) => {
+        try {
+        let jsonRes: BType.PoolLeaveResponse = JSON.parse(res);
+        return jsonRes;
+        } catch (e) {
+        try {
+        return JSON.parse(res);
+        } catch (e) {
+        return res;
+        }
+        }
+        }).catch((err) => {
+        return err;
+        });
+        return res;
+        };
+
+        export const cancelPoolJoin = (seed: string, poolID: number): Promise<BType.PoolCancelJoinResponse> => {
+          console.log(
+          'cancelPoolJoin in react-native started',
+          seed,
+          poolID
+          );
+          let res = Fula.cancelPoolJoin(seed, poolID).then((res) => {
+          try {
+          let jsonRes: BType.PoolCancelJoinResponse = JSON.parse(res);
+          return jsonRes;
+          } catch (e) {
+          try {
+          return JSON.parse(res);
+          } catch (e) {
+          return res;
+          }
+          }
+          }).catch((err) => {
+          return err;
+          });
+          return res;
+          };
+          export const listPoolJoinRequests = (poolID: number): Promise<BType.PoolRequestsResponse> => {
+            console.log(
+              'listPoolJoinRequests in react-native started',
+              poolID
+            );
+            let res = Fula.listPoolJoinRequests(poolID).then((res) => {
+              try {
+                let jsonRes: BType.PoolRequestsResponse = JSON.parse(res);
+                return jsonRes;
+              } catch (e) {
+                try {
+                  return JSON.parse(res);
+                } catch (e) {
+                  return res;
+                }
+              }
+            }).catch((err) => {
+              return err;
+            });
+            return res;
+          };
+
+          /*
+          seed is used to authorize the request.
+poolID is the ID of the pool in which the account is requesting to join.
+account is the account that is requesting to join the pool.
+accept is a boolean value that indicates whether to accept or reject the join request.
+It returns a promise of BType.PoolVoteResponse which includes the account and poolID
+*/
+          export const votePoolJoinRequest = (seed: string, poolID: number, account: string, accept: boolean): Promise<BType.PoolVoteResponse> => {
+            console.log(
+              'votePoolJoinRequest in react-native started',
+              seed,
+              poolID,
+              account,
+              accept
+            );
+            let res = Fula.votePoolJoinRequest(seed, poolID, account, accept).then((res) => {
+              try {
+                let jsonRes: BType.PoolVoteResponse = JSON.parse(res);
+                return jsonRes;
+              } catch (e) {
+                try {
+                  return JSON.parse(res);
+                } catch (e) {
+                  return res;
+                }
+              }
+            }).catch((err) => {
+              return err;
+            });
+            return res;
+          };
+          
+
+          /*
+It takes four arguments:
+
+seed is used to authorize the request.
+poolID is the ID of the pool in which the replication request is made.
+replicationFactor is the number of copies of the content to be stored.
+cid is the content identifier of the content to be replicated.
+It returns a promise of BType.ManifestUploadResponse which includes the uploader, storage, ManifestMetadata, and poolID
+          */
+          export const newReplicationRequest = (seed: string, poolID: number, replicationFactor: number, cid: string): Promise<BType.ManifestUploadResponse> => {
+  console.log(
+    'newReplicationRequest in react-native started',
+    seed,
+    poolID,
+    replicationFactor,
+    cid
+  );
+  let res = Fula.newReplicationRequest(seed, poolID, replicationFactor, cid).then((res) => {
+    try {
+      let jsonRes: BType.ManifestUploadResponse = JSON.parse(res);
+      return jsonRes;
+    } catch (e) {
+      try {
+        return JSON.parse(res);
+      } catch (e) {
+        return res;
+      }
+    }
+  }).catch((err) => {
+    return err;
+  });
+  return res;
+};
+
+/*
+It takes four arguments:
+
+seed is used to authorize the request.
+poolID is the ID of the pool in which the replication request is made.
+uploader is the account of the user making the request
+cid is the content identifier of the content to be stored.
+It returns a promise of BType.ManifestUploadResponse which includes the uploader, storage, ManifestMetadata, and poolID
+*/
+export const newStoreRequest = (seed: string, poolID: number, uploader: string, cid: string): Promise<BType.ManifestUploadResponse> => {
+  console.log(
+    'newStoreRequest in react-native started',
+    seed,
+    poolID,
+    uploader,
+    cid
+  );
+  let res = Fula.newStoreRequest(seed, poolID, uploader, cid).then((res) => {
+    try {
+      let jsonRes: BType.ManifestUploadResponse = JSON.parse(res);
+      return jsonRes;
+    } catch (e) {
+      try {
+        return JSON.parse(res);
+      } catch (e) {
+        return res;
+      }
+    }
+  }).catch((err) => {
+    return err;
+  });
+  return res;
+};
+
+
+/*
+It takes one argument:
+
+poolID is the ID of the pool for which the replication requests are listed
+It returns a promise of BType.ManifestUploadResponse[] which is an array of the replication requests, including the uploader, storage, ManifestMetadata, and poolID
+*/
+export const listAvailableReplicationRequests = (poolID: number): Promise<BType.ManifestUploadResponse[]> => {
+  console.log(
+    'listAvailableReplicationRequests in react-native started',
+    poolID
+  );
+  let res = Fula.listAvailableReplicationRequests(poolID).then((res) => {
+    try {
+      let jsonRes: BType.ManifestUploadResponse[] = JSON.parse(res);
+      return jsonRes;
+    } catch (e) {
+      try {
+        return JSON.parse(res);
+      } catch (e) {
+        return res;
+      }
+    }
+  }).catch((err) => {
+    return err;
+  });
+  return res;
+};
+
+
+/*
+It takes three arguments:
+
+seed is the seed of the account that is removing the replication request
+poolID is the ID of the pool for which the replication request is being removed
+cid is the content ID of the replication request being removed
+It returns a promise of BType.ManifestUploadResponse which is the removed replication request, including the uploader, storage, ManifestMetadata, and poolID
+*/
+export const removeReplicationRequest = (seed: string, poolID: number, cid: string): Promise<BType.ManifestUploadResponse> => {
+  console.log(
+    'removeReplicationRequest in react-native started',
+    seed,
+    poolID,
+    cid
+  );
+  let res = Fula.removeReplicationRequest(seed, poolID, cid).then((res) => {
+    try {
+      let jsonRes: BType.ManifestUploadResponse = JSON.parse(res);
+      return jsonRes;
+    } catch (e) {
+      try {
+        return JSON.parse(res);
+      } catch (e) {
+        return res;
+      }
+    }
+  }).catch((err) => {
+    return err;
+  });
+  return res;
+};
+
+/*
+It takes four arguments:
+
+seed is the seed of the account that is removing the storer
+storer is the address of the storer that is being removed
+poolID is the ID of the pool for which the storer is being removed
+cid is the content ID of the replication request for which the storer is being removed
+It returns a promise of BType.ManifestUploadResponse which is the replication request, including the uploader, storage, ManifestMetadata, and poolID after the storer has been removed.
+*/
+export const removeStorer = (seed: string, storer: string, poolID: number, cid: string): Promise<BType.ManifestUploadResponse> => {
+  console.log(
+    'removeStorer in react-native started',
+    seed,
+    storer,
+    poolID,
+    cid
+  );
+  let res = Fula.removeStorer(seed, storer, poolID, cid).then((res) => {
+    try {
+      let jsonRes: BType.ManifestUploadResponse = JSON.parse(res);
+      return jsonRes;
+    } catch (e) {
+      try {
+        return JSON.parse(res);
+      } catch (e) {
+        return res;
+      }
+    }
+  }).catch((err) => {
+    return err;
+  });
+  return res;
+};
+
+
+/*
+It takes four arguments:
+
+seed is the seed of the account that is removing the stored replication
+uploader is the address of the uploader that is being removed
+poolID is the ID of the pool for which the stored replication is being removed
+cid is the content ID of the replication request for which the stored replication is being removed
+It returns a promise of BType.ManifestUploadResponse which is the replication request, including the uploader, storage, ManifestMetadata, and poolID after the stored replication has been removed.
+*/
+export const removeStoredReplication = (seed: string, uploader: string, poolID: number, cid: string): Promise<BType.ManifestUploadResponse> => {
+  console.log(
+    'removeStoredReplication in react-native started',
+    seed,
+    uploader,
+    poolID,
+    cid
+  );
+  let res = Fula.removeStoredReplication(seed, uploader, poolID, cid).then((res) => {
+    try {
+      let jsonRes: BType.ManifestUploadResponse = JSON.parse(res);
+      return jsonRes;
+    } catch (e) {
+      try {
+        return JSON.parse(res);
+      } catch (e) {
+        return res;
+      }
+    }
+  }).catch((err) => {
+    return err;
+  });
+  return res;
+};
+
+  /*
+  bloxFreeSpace: This function takes no arguments and returns a promise of an object that contains the blox free space information.
+  */
+  export const bloxFreeSpace = (): Promise<BType.BloxFreeSpaceResponse> => {
+    console.log(
+    'bloxFreeSpace in react-native started'
+    );
+    let res = Fula.bloxFreeSpace().then((res) => {
+    try {
+    let jsonRes: BType.BloxFreeSpaceResponse = JSON.parse(res);
+    return jsonRes;
+    } catch (e) {
+    try {
+    return JSON.parse(res);
+    } catch (e) {
+    return res;
+    }
+    }
+    }).catch((err) => {
+    return err;
+    });
+    return res;
+    };

package/src/protocols/chain-api.ts

@@ -0,0 +1,80 @@
+import { default as EventTypes } from '../interfaces/api-lookup';
+
+import { ApiPromise, WsProvider } from '@polkadot/api';
+import type * as BType from '../types/blockchain';
+
+    const types = {
+        FulaPoolPool: EventTypes.FulaPoolPool,
+    }
+
+    export const init = async (wsAddress: string = 'wss://node.testnet.fx.land'): Promise<ApiPromise> => {
+        const provider = new WsProvider(wsAddress);
+        const api = await ApiPromise.create({ types, provider }).catch((err) => {
+            console.log(err);
+            return Promise.reject(err);
+        });
+        return api;
+    };
+
+    export const disconnectApi = async (api: ApiPromise): Promise<void> => {
+        await api.disconnect();
+    };
+
+/*
+  listPools: This function takes start index and length and returns a promise of an object that contains a list of pools. Each pool in the list contains the poolID, owner, poolName, parent, and participants of the pool
+  */
+  export const listPools = async (api: ApiPromise|undefined, start: number=1, length: number=10): Promise<BType.PoolListResponse> => {
+    console.log(
+        'listPools in react-native started'
+    );
+    try {
+        if(api == undefined) {
+            api = await init();
+        }
+        const pools: BType.PoolListResponse = { pools: [] };
+        const lastPoolId = await api.query.pool.lastPoolId();
+        let finalReturnedId: number = Number(lastPoolId.toHuman());
+        if (Number(lastPoolId.toHuman()) > start + length) {
+            finalReturnedId = start + length;
+        }
+        for(let i=start; i<=finalReturnedId;i++) {
+            const poolInfo = await api.query.pool
+            .pools(i).catch((err) => {
+                console.log(err);
+                return Promise.reject(err);
+            });
+            if(poolInfo != null) {
+                let formattedPoolInfo: BType.Pool = JSON.parse(JSON.stringify(poolInfo.toHuman()));
+                pools.pools.push(formattedPoolInfo);
+            }
+        }
+        return Promise.resolve(pools);
+    } catch (err) {
+        return Promise.reject(err);
+    }
+  }
+
+  /*
+  checkJoinRequest: This function takes poolId and AccontId and returns a promise of an object that contains request to the pools.
+  */
+  export const checkJoinRequest = async (api: ApiPromise|undefined, poolId: number, accountId: string): Promise<BType.PoolRequest|null> => {
+    console.log(
+        'checkJoinRequest in react-native started'
+    );
+    try {
+        if(api == undefined) {
+            api = await init();
+        }
+
+        const poolRequest = await api.query.pool.poolRequests(poolId, accountId);
+
+        if(poolRequest != null) {
+            let formattedPoolRequest: BType.PoolRequest = JSON.parse(JSON.stringify(poolRequest.toHuman()));
+            return Promise.resolve(formattedPoolRequest);
+        }
+        return Promise.resolve(null);
+        
+    } catch (err) {
+        return Promise.reject(err);
+    }
+  }