Skip to content

docs(readme): add USDT Payment example and fix Transaction args decimal scaling #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samuelchimmy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): add USDT Payment example and fix Transaction args decimal scaling #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 54 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,56 @@ export const PaymentBasic = () => {
};
```

### Example with USDT

USDT on Celo uses 6 decimals. Pass the amount as a human-readable string (e.g. `"1.5"`) — the `Payment` component handles unit conversion internally using the token's decimals. Use the USDT token address, not the cUSD address.

```tsx
import { useState } from "react";
import { Payment, PaymentError, PaymentDialog } from "@composer-kit/ui/payment";
import { celo } from "viem/chains";

// USDT on Celo mainnet — 6 decimals
const USDT_ADDRESS = "0x48065fbBE25f71C9282ddf5e1cD6D6A887483D5e";

export const PaymentUSDT = () => {
const [isOpen, setIsOpen] = useState(false);
const [txHash, setTxHash] = useState("");

return (
<div className="w-full items-center justify-center flex flex-col gap-4">
<Payment
amount="1.5"
//@ts-ignore
chain={celo}
onSuccess={(hash) => {
setTxHash(hash);
setIsOpen(false);
}}
onError={(error) => {
console.error("Payment error", error);
}}
recipientAddress="0x717F8A0b80CbEDe59EcA195F1E3D8E142C84d4d6"
tokenAddress={USDT_ADDRESS}
>
<button
className="bg-black font-medium dark:bg-white text-white dark:text-black px-4 py-2 rounded"
onClick={() => setIsOpen(!isOpen)}
>
Pay 1.5 USDT
</button>
<PaymentDialog
onOpenChange={() => setIsOpen(!isOpen)}
open={isOpen}
/>
<PaymentError />
</Payment>
{txHash && <p>{txHash}</p>}
</div>
);
};
```

## Swap

The `Swap` component allows users to exchange tokens seamlessly with a simple interface.
Expand Down Expand Up @@ -489,8 +539,11 @@ export const TransactionBasic = () => {
outputs: [{ name: "", type: "bool" }],
},
],
// cUSD on Celo mainnet (18 decimals)
// To send 1 cUSD: use 1_000_000_000_000_000_000n (18 decimal places)
// To send 1 USDT (0x48065fbBE25f71C9282ddf5e1cD6D6A887483D5e): use 1_000_000n (6 decimal places)
address: "0x765de816845861e75a25fca122bb6898b8b1282a",
args: ["0x717F8A0b80CbEDe59EcA195F1E3D8E142C84d4d6", 1],
args: ["0x717F8A0b80CbEDe59EcA195F1E3D8E142C84d4d6", 1_000_000_000_000_000_000n],
functionName: "transfer",
}}
>
Expand Down