@unlink-xyz/sdk 0.0.2-canary.0

package/README.md

@@ -0,0 +1,74 @@
+# `@unlink-xyz/sdk`
+
+TypeScript SDK for Unlink account custody, private transfers, withdrawals, and engine API access.
+
+## Install
+
+```bash
+pnpm add @unlink-xyz/sdk viem
+```
+
+## Quickstart
+
+```ts
+import { createUnlink, unlinkAccount, unlinkEvm } from "@unlink-xyz/sdk";
+import { createPublicClient, createWalletClient, http } from "viem";
+import { privateKeyToAccount } from "viem/accounts";
+import { baseSepolia } from "viem/chains";
+
+const evmAccount = privateKeyToAccount(
+  process.env.EVM_PRIVATE_KEY as `0x${string}`,
+);
+
+const walletClient = createWalletClient({
+  account: evmAccount,
+  chain: baseSepolia,
+  transport: http(process.env.RPC_URL),
+});
+
+const publicClient = createPublicClient({
+  chain: baseSepolia,
+  transport: http(process.env.RPC_URL),
+});
+
+const unlink = createUnlink({
+  engineUrl: "http://localhost:3030",
+  apiKey: process.env.UNLINK_API_KEY!,
+  account: unlinkAccount.fromMnemonic({
+    mnemonic: process.env.UNLINK_MNEMONIC!,
+  }),
+  evm: unlinkEvm.fromViem({
+    walletClient,
+    publicClient,
+  }),
+});
+
+const approval = await unlink.ensureErc20Approval({
+  token: "0xYourToken",
+  amount: "1000000000000000000",
+});
+
+if (approval.status === "submitted") {
+  await publicClient.waitForTransactionReceipt({
+    hash: approval.txHash as `0x${string}`,
+  });
+}
+
+const deposit = await unlink.deposit({
+  token: "0xYourToken",
+  amount: "1000000000000000000",
+});
+
+const relayedDeposit = await unlink.pollTransactionStatus(deposit.txId);
+```
+
+## Notes
+
+- `createUnlink(...)` is the main high-level client surface.
+- `unlinkAccount.*` handles Unlink account custody from mnemonic, seed, or raw keys.
+- `unlinkEvm.*` adapts viem or ethers signers for approvals and deposits.
+
+## More
+
+- Expanded quickstart: `docs/quickstart.md`
+- Repository: `https://github.com/unlink-xyz/monorepo`