@poolzfinance/api4 1.12.9 → 1.13.0

package/README.md

@@ -1,2 +1,56 @@
+[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=The-Poolz_InterfaceAPI4&token=f0ba11edcd186439dd94a0e63b805bff7b46d80e)](https://sonarcloud.io/summary/new_code?id=The-Poolz_InterfaceAPI4)
+
 # InterfaceAPI4
-Bridge between front and back
+
+InterfaceAPI4 provides a small React wrapper around the Poolz GraphQL API. It exposes an `API4Provider` component and a collection of hooks for querying and mutating data.
+
+## Installation
+
+```
+pnpm install
+```
+
+## Building the package
+
+```
+pnpm build
+```
+
+## Running tests
+
+```
+pnpm test
+```
+
+## Basic usage
+
+Wrap your application with `API4Provider` and pass it your GraphQL endpoint and a function that signs messages for authentication:
+
+```tsx
+import API4Provider from "@poolzfinance/api4/dist/components/API4Provider";
+
+const App = () => (
+  <API4Provider
+    account={address}
+    options={{
+      uri: "https://api4.poolz.finance/graphql",
+      siweCallBack: async () => ({
+        eip4361message: "...",
+        signature: "..."
+      })
+    }}
+  >
+    {/** your routes */}
+  </API4Provider>
+);
+```
+
+After the provider is configured you can start using the generated hooks:
+
+```tsx
+import { useGetCurrentTime } from "@poolzfinance/api4";
+
+const { data, loading } = useGetCurrentTime();
+```
+
+The project also includes many other hooks located in `src/endpoints` for interacting with different parts of the API.

package/dist/endpoints/adminGetAllocation.d.ts

@@ -1,6 +1,6 @@
-export declare const useAdminGetAllocation: (projectId: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").AdminGetAllocationQuery, {
-    projectId: string;
-}>;
+export declare const useAdminGetAllocation: (projectId: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").AdminGetAllocationQuery, import("../types/graphql/graphql").Exact<{
+    projectId: import("../types/graphql/graphql").Scalars["String"]["input"];
+}>>;
 export declare const useLazyAdminGetAllocation: () => import("@apollo/client").LazyQueryResultTuple<import("../types/graphql/graphql").AdminGetAllocationQuery, import("../types/graphql/graphql").Exact<{
     projectId: import("../types/graphql/graphql").Scalars["String"]["input"];
 }>>;

package/dist/endpoints/approvedContracts.d.ts

@@ -1,3 +1,3 @@
-export declare const useApprovedContracts: (onlyApproved: boolean) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").GetApprovedContractsQuery, {
-    onlyApproved: boolean;
-}>;
+export declare const useApprovedContracts: (onlyApproved: boolean) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").GetApprovedContractsQuery, import("../types/graphql/graphql").Exact<{
+    onlyApproved: import("../types/graphql/graphql").Scalars["Boolean"]["input"];
+}>>;

package/dist/endpoints/boostProxy.d.ts

@@ -1,9 +1,9 @@
-export declare const useBoostUsers: (campaignCodes?: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").BoostProxyUsersQuery, {
-    campaignCodes: string | never[];
-}>;
-export declare const useBoostData: (campaignCodes?: string[]) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").BoostProxyDataQuery, {
-    campaignCodes: string[];
-}>;
+export declare const useBoostUsers: (campaignCodes?: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").BoostProxyUsersQuery, import("../types/graphql/graphql").Exact<{
+    campaignCodes: Array<import("../types/graphql/graphql").Scalars["String"]["input"]> | import("../types/graphql/graphql").Scalars["String"]["input"];
+}>>;
+export declare const useBoostData: (campaignCodes?: string[]) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").BoostProxyDataQuery, import("../types/graphql/graphql").Exact<{
+    campaignCodes: Array<import("../types/graphql/graphql").Scalars["String"]["input"]> | import("../types/graphql/graphql").Scalars["String"]["input"];
+}>>;
 export declare const useLazyBoostUsers: () => import("@apollo/client").LazyQueryResultTuple<import("../types/graphql/graphql").BoostProxyUsersQuery, import("../types/graphql/graphql").Exact<{
     campaignCodes: Array<import("../types/graphql/graphql").Scalars["String"]["input"]> | import("../types/graphql/graphql").Scalars["String"]["input"];
 }>>;

package/dist/endpoints/daoSenderHistory.d.ts

@@ -1,3 +1,3 @@
-export declare const useDaoSenderHistory: (page: number) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").DaoSenderHistoryQuery, {
-    page: number;
-}>;
+export declare const useDaoSenderHistory: (page: number) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").DaoSenderHistoryQuery, import("../types/graphql/graphql").Exact<{
+    page: import("../types/graphql/graphql").Scalars["Int"]["input"];
+}>>;

package/dist/endpoints/leaderboard.d.ts

@@ -1,6 +1,6 @@
-export declare const useLeaderboardByAddress: (address?: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").GetLeaderboardByAddressQuery, {
-    address: string | undefined;
-}>;
+export declare const useLeaderboardByAddress: (address?: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").GetLeaderboardByAddressQuery, import("../types/graphql/graphql").Exact<{
+    address?: import("../types/graphql/graphql").InputMaybe<import("../types/graphql/graphql").Scalars["String"]["input"]>;
+}>>;
 export declare const useLeaderboard: () => import("@apollo/client").QueryResult<import("../types/graphql/graphql").GetLeaderboardQuery, import("../types/graphql/graphql").Exact<{
     [key: string]: never;
 }>>;

package/dist/endpoints/myRoles.d.ts

@@ -0,0 +1,6 @@
+export declare const useMyRoles: () => import("@apollo/client").QueryResult<import("../types/graphql/graphql").MyRolesQuery, import("../types/graphql/graphql").Exact<{
+    [key: string]: never;
+}>>;
+export declare const useLazyMyRoles: () => import("@apollo/client").LazyQueryResultTuple<import("../types/graphql/graphql").MyRolesQuery, import("../types/graphql/graphql").Exact<{
+    [key: string]: never;
+}>>;

package/dist/endpoints/simpleUrlShortener.d.ts

@@ -1,6 +1,3 @@
-export declare const useSimpleUrlShortener: (TxHash: string, ChainId: number) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").SimpleUrlShortenerQuery, {
-    input: {
-        TxHash: string;
-        ChainId: number;
-    };
-}>;
+export declare const useSimpleUrlShortener: (TxHash: string, ChainId: number) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").SimpleUrlShortenerQuery, import("../types/graphql/graphql").Exact<{
+    input: import("../types/graphql/graphql").TxHashChainIdInput;
+}>>;

package/dist/endpoints/tokenInfo.d.ts

@@ -1,6 +1,6 @@
-export declare const useTokenInfo: (hashKey: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").TokenInfoQuery, {
-    hashKey: string;
-}>;
-export declare const useTokenInfoByChainAndAddress: (chainId: number, tokenAddress: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").TokenInfoQuery, {
-    hashKey: string;
-}>;
+export declare const useTokenInfo: (hashKey: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").TokenInfoQuery, import("../types/graphql/graphql").Exact<{
+    hashKey: import("../types/graphql/graphql").Scalars["String"]["input"];
+}>>;
+export declare const useTokenInfoByChainAndAddress: (chainId: number, tokenAddress: string) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").TokenInfoQuery, import("../types/graphql/graphql").Exact<{
+    hashKey: import("../types/graphql/graphql").Scalars["String"]["input"];
+}>>;

package/dist/endpoints/vaults.d.ts

@@ -1,11 +1,11 @@
 type ChainIdType = number | null;
 type TokenAddressType = string | null;
 type FetchBalanceType = boolean | null;
-export declare const useVaults: (chainId: ChainIdType, tokenAddress: TokenAddressType, fetchBalance: FetchBalanceType) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").DataQuery, {
-    chainId: ChainIdType;
-    tokenAddress: TokenAddressType;
-    fetchBalance: FetchBalanceType;
-}>;
+export declare const useVaults: (chainId: ChainIdType, tokenAddress: TokenAddressType, fetchBalance: FetchBalanceType) => import("@apollo/client").QueryResult<import("../types/graphql/graphql").DataQuery, import("../types/graphql/graphql").Exact<{
+    chainId?: import("../types/graphql/graphql").InputMaybe<import("../types/graphql/graphql").Scalars["Int"]["input"]>;
+    tokenAddress?: import("../types/graphql/graphql").InputMaybe<import("../types/graphql/graphql").Scalars["String"]["input"]>;
+    fetchBalance?: import("../types/graphql/graphql").InputMaybe<import("../types/graphql/graphql").Scalars["Boolean"]["input"]>;
+}>>;
 export declare const useLazyGetVaults: () => import("@apollo/client").LazyQueryResultTuple<import("../types/graphql/graphql").DataQuery, import("../types/graphql/graphql").Exact<{
     chainId?: import("../types/graphql/graphql").InputMaybe<import("../types/graphql/graphql").Scalars["Int"]["input"]>;
     tokenAddress?: import("../types/graphql/graphql").InputMaybe<import("../types/graphql/graphql").Scalars["String"]["input"]>;