@chipi-stack/chipi-react 13.13.0 → 14.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Chipi Pay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,43 +1,61 @@
-# Chipi SDK
+# @chipi-stack/chipi-react
 
-Chipi SDK is the easiest way to integrate USDC staking and withdrawal functionality into your React/Next.js application. Add secure wallet management, token staking, and withdrawals to your application in minutes. All transactions are sponsored thanks to Avnu's paymaster.
+React hooks for Chipi Pay. Provides wallet creation, transfers, SKU purchases, and session management.
 
-## Prerequisites
-
-- React 18 or later
-- Node.js >=18.17.0 or later
-- A Chipi account. [Create your account for free](https://dashboard.chipipay.com)
-
-## Installation
-
-The fastest way to get started with Chipi SDK is by following our [Quickstart Guide](https://docs.chipipay.com/gasless/quickstart).
+## Install
 
 ```bash
-npm install @chipi-stack/chipi-react
-# or
-yarn add @chipi-stack/chipi-react
+npm install @chipi-stack/chipi-react @chipi-stack/backend @chipi-stack/types
 ```
 
-## Usage
-
-For detailed information, guides, and examples visit our [documentation](https://docs.chipipay.com).
-
-## Support
-
-You can get in touch with us in any of the following ways:
-
-- Join our [Telegram community](https://t.me/chipi_pay)
-- Visit our [YouTube channel](https://www.youtube.com/@chipipay) for tutorials
-- Email us at support@chipi.com
-
-## Contributing
-
-We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines and code of conduct.
+## Quick Start
+
+```tsx
+import { ChipiProvider, useChipiWallet, useTransfer } from "@chipi-stack/chipi-react";
+import type { ChainToken } from "@chipi-stack/types";
+
+function App() {
+  return (
+    <ChipiProvider config={{ apiPublicKey: "your-key" }}>
+      <Wallet />
+    </ChipiProvider>
+  );
+}
+
+function Wallet() {
+  const { wallet } = useChipiWallet({
+    externalUserId: "user-123",
+    getBearerToken: async () => "your-bearer-token",
+  });
+  const { transfer, isLoading } = useTransfer();
+
+  if (!wallet) return <p>Loading wallet...</p>;
+
+  return (
+    <button
+      onClick={() =>
+        transfer({
+          params: {
+            wallet,
+            token: "USDC" as ChainToken,
+            recipient: "0x...",
+            amount: 10,
+            encryptKey: "user-pin",
+          },
+          bearerToken: "your-bearer-token",
+        })
+      }
+    >
+      {isLoading ? "Sending..." : "Send 10 USDC"}
+    </button>
+  );
+}
+```
 
-## Security
+## Documentation
 
-@chipi-stack/chipi-react follows best practices for security, but 100% security cannot be assured.
+Full docs at [docs.chipipay.com](https://docs.chipipay.com)
 
-@chipi-stack/chipi-react is provided "as is" without any warranty. Use at your own risk.
+## License
 
-For more information and to report security issues, please refer to our [security documentation](https://docs.chipipay.com).
+MIT

package/dist/hooks.d.mts

@@ -524,10 +524,14 @@ declare function useApprove(): {
 type TransactionListInput = {
     query: GetTransactionListQuery;
     getBearerToken?: () => Promise<string | null | undefined>;
-    queryOptions?: Omit<UseQueryOptions<PaginatedResponse<Transaction>, Error>, 'queryKey' | 'queryFn'>;
+    queryOptions?: Omit<UseQueryOptions<PaginatedResponse<Transaction>, Error>, "queryKey" | "queryFn">;
+};
+type FetchTransactionListInput = {
+    query: GetTransactionListQuery;
+    getBearerToken: () => Promise<string | null | undefined>;
 };
 declare function useGetTransactionList(input?: TransactionListInput): {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: PaginatedResponse<Transaction>;
     error: Error;
     isError: true;
@@ -555,7 +559,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: PaginatedResponse<Transaction>;
     error: null;
     isError: false;
@@ -583,7 +587,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: undefined;
     error: Error;
     isError: true;
@@ -611,7 +615,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: undefined;
     error: null;
     isError: false;
@@ -639,7 +643,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: undefined;
     error: null;
     isError: false;
@@ -667,7 +671,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: PaginatedResponse<Transaction>;
     isError: false;
     error: null;
@@ -892,7 +896,7 @@ declare function useGetSkuPurchase(input?: GetSkuPurchaseInput): {
 type SkuListInput = {
     query: GetSkuListQuery;
     getBearerToken?: () => Promise<string | null | undefined>;
-    queryOptions?: Omit<UseQueryOptions<PaginatedResponse<Sku>, Error>, 'queryKey' | 'queryFn'>;
+    queryOptions?: Omit<UseQueryOptions<PaginatedResponse<Sku>, Error>, "queryKey" | "queryFn">;
 };
 declare function useGetSkuList(input?: SkuListInput): {
     fetchSkuList: (newInput: SkuListInput) => Promise<PaginatedResponse<Sku>>;
@@ -1275,7 +1279,7 @@ declare function useRecordSendTransaction(): {
 type GetTokenBalanceInput = {
     params?: GetTokenBalanceParams;
     getBearerToken?: () => Promise<string | null | undefined>;
-    queryOptions?: Omit<UseQueryOptions<GetTokenBalanceResponse, Error>, 'queryKey' | 'queryFn'>;
+    queryOptions?: Omit<UseQueryOptions<GetTokenBalanceResponse, Error>, "queryKey" | "queryFn">;
 };
 declare function useGetTokenBalance(input?: GetTokenBalanceInput): {
     fetchTokenBalance: (newInput: GetTokenBalanceInput) => Promise<GetTokenBalanceResponse>;

package/dist/hooks.d.ts

@@ -524,10 +524,14 @@ declare function useApprove(): {
 type TransactionListInput = {
     query: GetTransactionListQuery;
     getBearerToken?: () => Promise<string | null | undefined>;
-    queryOptions?: Omit<UseQueryOptions<PaginatedResponse<Transaction>, Error>, 'queryKey' | 'queryFn'>;
+    queryOptions?: Omit<UseQueryOptions<PaginatedResponse<Transaction>, Error>, "queryKey" | "queryFn">;
+};
+type FetchTransactionListInput = {
+    query: GetTransactionListQuery;
+    getBearerToken: () => Promise<string | null | undefined>;
 };
 declare function useGetTransactionList(input?: TransactionListInput): {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: PaginatedResponse<Transaction>;
     error: Error;
     isError: true;
@@ -555,7 +559,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: PaginatedResponse<Transaction>;
     error: null;
     isError: false;
@@ -583,7 +587,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: undefined;
     error: Error;
     isError: true;
@@ -611,7 +615,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: undefined;
     error: null;
     isError: false;
@@ -639,7 +643,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: undefined;
     error: null;
     isError: false;
@@ -667,7 +671,7 @@ declare function useGetTransactionList(input?: TransactionListInput): {
     fetchStatus: _tanstack_react_query.FetchStatus;
     promise: Promise<PaginatedResponse<Transaction>>;
 } | {
-    fetchTransactionList: (newInput: TransactionListInput) => Promise<PaginatedResponse<Transaction>>;
+    fetchTransactionList: (newInput: FetchTransactionListInput) => Promise<PaginatedResponse<Transaction>>;
     data: PaginatedResponse<Transaction>;
     isError: false;
     error: null;
@@ -892,7 +896,7 @@ declare function useGetSkuPurchase(input?: GetSkuPurchaseInput): {
 type SkuListInput = {
     query: GetSkuListQuery;
     getBearerToken?: () => Promise<string | null | undefined>;
-    queryOptions?: Omit<UseQueryOptions<PaginatedResponse<Sku>, Error>, 'queryKey' | 'queryFn'>;
+    queryOptions?: Omit<UseQueryOptions<PaginatedResponse<Sku>, Error>, "queryKey" | "queryFn">;
 };
 declare function useGetSkuList(input?: SkuListInput): {
     fetchSkuList: (newInput: SkuListInput) => Promise<PaginatedResponse<Sku>>;
@@ -1275,7 +1279,7 @@ declare function useRecordSendTransaction(): {
 type GetTokenBalanceInput = {
     params?: GetTokenBalanceParams;
     getBearerToken?: () => Promise<string | null | undefined>;
-    queryOptions?: Omit<UseQueryOptions<GetTokenBalanceResponse, Error>, 'queryKey' | 'queryFn'>;
+    queryOptions?: Omit<UseQueryOptions<GetTokenBalanceResponse, Error>, "queryKey" | "queryFn">;
 };
 declare function useGetTokenBalance(input?: GetTokenBalanceInput): {
     fetchTokenBalance: (newInput: GetTokenBalanceInput) => Promise<GetTokenBalanceResponse>;