Skip to content

Commit fbdcb43

Browse files
committed
deprecation notices
1 parent d7ae1c8 commit fbdcb43

22 files changed

Lines changed: 110 additions & 94 deletions

src/content/docs/common/posting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Downvotes or moderation actions may follow these behaviors. Repeat offenders can
2929
- **Use relevant tags**: Pick 1–5 tags that match your topic (e.g., `travel`, `photography`, `introduction`). Keep them lowercase; hyphens are allowed.
3030
- **Format for readability**: Use headings, lists, and images to break up text.
3131
- **Set fair beneficiaries** if sharing rewards with collaborators.
32-
- **Respect community rules**: Many communities have their own posting standards read them before submitting.
32+
- **Respect community rules**: Many communities have their own posting standards - read them before submitting.
3333

3434
---
3535

src/content/docs/developers/sdk.mdx

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Framework-agnostic data layer for Hive apps with first-class React
77

88
The Ecency SDK (`@ecency/sdk`) is a framework-agnostic data layer for Hive applications with
99
first-class **React Query** support. It provides **165+ query option builders**, **76+ mutation
10-
hooks**, and a shared configuration layer all with **zero runtime dependencies**.
10+
hooks**, and a shared configuration layer - all with **zero runtime dependencies**.
1111

1212
Published on [npm](https://www.npmjs.com/package/@ecency/sdk) under the MIT license.
1313

@@ -17,10 +17,10 @@ Published on [npm](https://www.npmjs.com/package/@ecency/sdk) under the MIT lice
1717
|---|---|
1818
| Query builders | 165+ composable query option builders |
1919
| Mutation hooks | 76+ hooks for all blockchain write operations |
20-
| Cache keys | Centralized `QueryKeys` single source of truth |
20+
| Cache keys | Centralized `QueryKeys` - single source of truth |
2121
| Auth methods | Private key, Keychain, HiveSigner, HiveAuth |
2222
| Platform support | Web, React Native, Node.js (SSR) |
23-
| Runtime deps | **Zero** only peer dependencies |
23+
| Runtime deps | **Zero** - only peer dependencies |
2424
| Bundle size | ~182 KB |
2525
| Build targets | Browser ESM + Node ESM/CJS (dual builds via tsup) |
2626

@@ -32,9 +32,9 @@ Published on [npm](https://www.npmjs.com/package/@ecency/sdk) under the MIT lice
3232
promotions, games, ai, integrations, auth, bridge, core, private-api
3333
- **Central configuration** via `ConfigManager` (RPC nodes, QueryClient, DMCA filtering, image host)
3434
- **Platform adapter pattern** for cross-platform auth and broadcasting
35-
- **Smart auth fallback** automatically tries alternative signing methods on failure
36-
- **RPC node failover** multi-node configuration with automatic failover
37-
- **Blockchain error parsing** user-friendly error messages with typed error categories
35+
- **Smart auth fallback** - automatically tries alternative signing methods on failure
36+
- **RPC node failover** - multi-node configuration with automatic failover
37+
- **Blockchain error parsing** - user-friendly error messages with typed error categories
3838

3939
## Why React Query?
4040

@@ -183,21 +183,21 @@ The Ecency SDK with React Query solves all of these:
183183

184184
- Reduced API calls by 70-90% through intelligent caching
185185
- Instant UI updates with optimistic mutations
186-
- Zero manual cache management React Query handles invalidation
186+
- Zero manual cache management - React Query handles invalidation
187187
- Better UX with background updates and retry logic
188188
- Faster perceived performance with prefetching and SSR
189-
- Less code no custom loading/error/caching logic needed
189+
- Less code - no custom loading/error/caching logic needed
190190

191191
### How other apps can benefit
192192

193193
Any Hive application can leverage this SDK to:
194194

195-
1. **Drop custom data fetching code** use pre-built query options for all common Hive
195+
1. **Drop custom data fetching code** - use pre-built query options for all common Hive
196196
operations
197-
2. **Share cache across features** one query for account data serves entire app
197+
2. **Share cache across features** - one query for account data serves entire app
198198
3. **Add real-time features** easily with `refetchInterval` and optimistic updates
199199
4. **Improve SEO** with SSR-ready queries that prefetch on server
200-
5. **Reduce bundle size** share the SDK's type-safe queries instead of custom fetch logic
200+
5. **Reduce bundle size** - share the SDK's type-safe queries instead of custom fetch logic
201201

202202
**Example: Building a Hive blog reader**
203203

@@ -266,7 +266,7 @@ npm install @hiveio/dhive hivesigner
266266
npm install react @tanstack/react-query
267267
```
268268

269-
React and React Query are optional the SDK's query option builders and utility functions
269+
React and React Query are optional - the SDK's query option builders and utility functions
270270
work without them in server-side or non-React contexts.
271271

272272
## Quick start
@@ -301,7 +301,7 @@ import { ConfigManager, makeQueryClient } from "@ecency/sdk";
301301
// Set QueryClient (required for React Query integration)
302302
ConfigManager.setQueryClient(makeQueryClient());
303303

304-
// Custom RPC nodes (optional defaults to 6 public nodes)
304+
// Custom RPC nodes (optional - defaults to 6 public nodes)
305305
ConfigManager.setHiveNodes([
306306
"https://api.hive.blog",
307307
"https://api.deathwing.me",
@@ -315,14 +315,14 @@ ConfigManager.setDmcaLists({
315315
posts: ["@author/permlink"],
316316
});
317317

318-
// Custom image CDN host (optional defaults to images.ecency.com)
318+
// Custom image CDN host (optional - defaults to images.ecency.com)
319319
ConfigManager.setImageHost("https://images.ecency.com");
320320
```
321321

322-
The SDK includes **automatic RPC node failover** if the primary node fails, requests are
322+
The SDK includes **automatic RPC node failover** - if the primary node fails, requests are
323323
retried on alternate nodes from the configured list.
324324

325-
## QueryKeys centralized cache management
325+
## QueryKeys - centralized cache management
326326

327327
All cache keys are defined in a single `QueryKeys` export, organized by domain. Use these
328328
as the single source of truth for cache invalidation.
@@ -408,13 +408,13 @@ automatic fallback between signing methods:
408408
import type { AuthContextV2, PlatformAdapter } from "@ecency/sdk";
409409

410410
const adapter: PlatformAdapter = {
411-
// Storage retrieve credentials from your platform's storage
411+
// Storage - retrieve credentials from your platform's storage
412412
getUser: async (username) => getUserFromStore(username),
413413
getPostingKey: async (username) => getKeyFromStorage(username),
414414
getAccessToken: async (username) => getTokenFromStorage(username),
415415
getLoginType: async (username) => getAuthMethod(username),
416416

417-
// UI feedback show messages in your platform's style
417+
// UI feedback - show messages in your platform's style
418418
showError: (msg) => toast.error(msg),
419419
showSuccess: (msg) => toast.success(msg),
420420

@@ -426,7 +426,7 @@ const adapter: PlatformAdapter = {
426426
return showHiveAuthModal(username, ops, keyType);
427427
},
428428

429-
// Auth upgrade UI shown when posting-key user attempts an active-key operation
429+
// Auth upgrade UI - shown when posting-key user attempts an active-key operation
430430
showAuthUpgradeUI: async (authority, operation) => {
431431
return showUpgradeDialog(authority, operation);
432432
// Returns: 'key' | 'keychain' | 'hivesigner' | 'hiveauth' | false
@@ -442,7 +442,7 @@ const auth: AuthContextV2 = {
442442
const { mutateAsync } = useVote(username, auth);
443443
```
444444

445-
**Smart auth fallback** when `enableFallback` is true, the SDK automatically:
445+
**Smart auth fallback** - when `enableFallback` is true, the SDK automatically:
446446

447447
1. Detects the user's login method via `adapter.getLoginType()`
448448
2. Attempts to broadcast with that method
@@ -471,7 +471,7 @@ await mutateAsync({
471471
});
472472
```
473473

474-
With a platform adapter, the SDK handles active operations automatically
474+
With a platform adapter, the SDK handles active operations automatically -
475475
prompting the user to upgrade auth if needed.
476476

477477
## Error handling
@@ -496,9 +496,9 @@ try {
496496
showMessage("Not enough Resource Credits to broadcast this transaction.");
497497
} else if (shouldTriggerAuthFallback(error)) {
498498
// SDK handles this automatically with adapter, but you can customize
499-
showMessage("Authentication failed trying alternative method...");
499+
showMessage("Authentication failed - trying alternative method...");
500500
} else if (isNetworkError(error)) {
501-
showMessage("Network error please check your connection.");
501+
showMessage("Network error - please check your connection.");
502502
} else {
503503
const [message, type] = formatError(error);
504504
showMessage(message);
@@ -544,27 +544,27 @@ src/modules/
544544
| posts | 30 | 20 | Post/comment CRUD, voting, drafts, schedules, images |
545545
| accounts | 26 | 19 | Account data, relationships, profile, bookmarks |
546546
| wallet | 23 | 25 | Balances, delegations, transfers, conversions |
547-
| hive-engine | 10 | | Hive Engine token queries |
547+
| hive-engine | 10 | - | Hive Engine token queries |
548548
| market | 9 | 3 | Prices, order book, trade history |
549-
| search | 7 | | Topic, account, post search |
549+
| search | 7 | - | Topic, account, post search |
550550
| communities | 7 | 8 | Community data, subscriptions, mutations |
551-
| spk | 6 | | SPK wallet, market, rewards |
551+
| spk | 6 | - | SPK wallet, market, rewards |
552552
| notifications | 5 | 3 | Notification lists, settings |
553553
| proposals | 5 | 3 | Governance proposals, voting |
554554
| core | 4 | 3 | Chain properties, dynamic props, broadcasting |
555555
| analytics | 4 | 2 | Curation, leaderboard, page stats |
556556
| promotions | 4 | 2 | Promotion pricing, Boost+ |
557557
| points | 4 | 2 | Points balance, transactions |
558-
| resource-credits | 3 | | RC stats |
558+
| resource-credits | 3 | - | RC stats |
559559
| witnesses | 2 | 3 | Witness voting, proxy |
560560
| operations | 2 | 4 | Operation signing |
561561
| ai | 2 | 2 | Image generation pricing |
562562
| games | 2 | 2 | Game status |
563563

564564
## SSR / RSC notes
565565

566-
- Query option builders are safe to use on the server they return plain objects.
567-
- Mutation hooks (`use*`) are client-only they use React hooks internally.
566+
- Query option builders are safe to use on the server - they return plain objects.
567+
- Mutation hooks (`use*`) are client-only - they use React hooks internally.
568568
- If you use Next.js App Router, keep hook usage in `"use client"` components.
569569
- Use `queryClient.prefetchQuery()` on the server to hydrate data for instant client rendering.
570570

src/content/docs/developers/wallets.mdx

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,20 @@ wallet-related operations across the Ecency website and mobile app. The new
1010
`@ecency/wallets` package gives us a single, dedicated layer for creating and
1111
managing wallets while keeping the rest of the Ecency stack lightweight.
1212

13-
## Standard seed phrase, multi-chain addresses
13+
## Multi-chain addresses
14+
15+
<Aside type="caution">
16+
The seed-phrase-based wallet creation flow is being discontinued. Managing
17+
a separate seed phrase added complexity to signups and transaction signing.
18+
Ecency is integrating **MetaMask** to handle external chain wallets instead.
19+
If your application generated wallets using the mnemonic flow described below,
20+
guide users to the [seed phrase migration guide](/guides/seed-phrase-migration/)
21+
so they can move funds to an external wallet.
22+
</Aside>
1423

15-
We utilize a blockchain-standard seed phrase to derive wallet addresses across
16-
different blockchains. A single mnemonic can be used to:
24+
The `@ecency/wallets` package previously used a blockchain-standard seed phrase
25+
to derive wallet addresses across different blockchains. A single mnemonic
26+
could:
1727

1828
1. Generate addresses for multiple supported chains without asking the user to
1929
juggle several keys.
@@ -23,9 +33,9 @@ different blockchains. A single mnemonic can be used to:
2333
client enforce its own encryption and secure storage policies.
2434

2535
<Aside type="note">
26-
The seed phrase never leaves the client. When a wallet needs to be backed up
27-
or restored, the mnemonic is provided by the user, and derived addresses are
28-
synced to Ecency services only after local encryption is applied.
36+
The seed phrase never left the client. When a wallet needed to be backed up
37+
or restored, the mnemonic was provided by the user, and derived addresses were
38+
synced to Ecency services only after local encryption was applied.
2939
</Aside>
3040

3141
## What `@ecency/wallets` handles
@@ -40,12 +50,15 @@ responsible for:
4050
- Publishing public wallet metadata to Ecency services when users choose to
4151
make their addresses available.
4252

43-
## Example: derive addresses from a mnemonic
53+
## Example: derive addresses from a mnemonic (legacy)
54+
55+
<Aside type="caution">
56+
This mnemonic-based flow is being phased out. The example below is kept for
57+
reference only. New integrations should not rely on seed phrase generation.
58+
</Aside>
4459

45-
The snippet below shows the general flow for creating a mnemonic and deriving a
46-
set of addresses. The exact API surface may evolve, but the key steps—create or
47-
import a seed, derive addresses for requested chains, and persist only the
48-
public detailsremain the same.
60+
The snippet below shows the legacy flow for creating a mnemonic and deriving a
61+
set of addresses.
4962

5063
export const exampleCode = `
5164
import { createWalletClient } from '@ecency/wallets';

src/content/docs/developers/x402.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Monetize APIs and content with zero-fee HBD micropayments using the
55

66
# x402 Payments
77

8-
The [`@hiveio/x402`](https://www.npmjs.com/package/@hiveio/x402) package brings the [x402 payment protocol](https://www.x402.org/) to Hive. It lets any API or content endpoint accept **HBD micropayments** zero fees, 3-second finality, no credit cards.
8+
The [`@hiveio/x402`](https://www.npmjs.com/package/@hiveio/x402) package brings the [x402 payment protocol](https://www.x402.org/) to Hive. It lets any API or content endpoint accept **HBD micropayments** - zero fees, 3-second finality, no credit cards.
99

1010
Published on [npm](https://www.npmjs.com/package/@hiveio/x402) under the MIT license. Source on [GitHub](https://github.com/ecency/hive-x402).
1111

@@ -41,7 +41,7 @@ Client Server Facilitator
4141

4242
| Feature | Details |
4343
|---|---|
44-
| Currency | HBD (Hive Backed Dollars) pegged to ~$1 USD |
44+
| Currency | HBD (Hive Backed Dollars) - pegged to ~$1 USD |
4545
| Transaction fees | **Zero** |
4646
| Finality | ~3 seconds (1 Hive block) |
4747
| Middleware | Express, Next.js App Router, Hono |
@@ -58,7 +58,7 @@ npm install @hiveio/x402
5858
pnpm add @hiveio/x402
5959
```
6060

61-
The package uses **subpath exports** import only what you need:
61+
The package uses **subpath exports** - import only what you need:
6262

6363
```ts
6464
import { ... } from "@hiveio/x402/types";
@@ -88,8 +88,8 @@ app.get(
8888
description: "Premium API access",
8989
}),
9090
(req, res) => {
91-
// req.payer the Hive account that paid
92-
// req.txId the on-chain transaction ID
91+
// req.payer - the Hive account that paid
92+
// req.txId - the on-chain transaction ID
9393
res.json({ message: "Premium content", payer: req.payer });
9494
}
9595
);
@@ -292,8 +292,8 @@ parseHBD("0.050 HBD"); // 0.05
292292

293293
HBD (Hive Backed Dollars) is ideal for micropayments:
294294

295-
- **Zero transaction fees** unlike EVM chains, Hive transfers cost nothing
296-
- **~$1 USD peg** algorithmic stablecoin, no wrapping or bridging needed
297-
- **3-second finality** one block confirmation
298-
- **No gas estimation** predictable, simple transfers
299-
- **3-second block time** fast enough for real-time API access
295+
- **Zero transaction fees** - unlike EVM chains, Hive transfers cost nothing
296+
- **~$1 USD peg** - algorithmic stablecoin, no wrapping or bridging needed
297+
- **3-second finality** - one block confirmation
298+
- **No gas estimation** - predictable, simple transfers
299+
- **3-second block time** - fast enough for real-time API access

src/content/docs/ecency/ecency-vs-others.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Compare Ecency with other Hive frontends like PeakD and Hive.blog.
55

66
# Ecency vs Other Hive Frontends
77

8-
Hive has a rich ecosystem of frontends apps and websites that let you interact with the blockchain. Ecency is one of the most feature-rich and modern options available, but it’s helpful to understand how it compares to others.
8+
Hive has a rich ecosystem of frontends - apps and websites that let you interact with the blockchain. Ecency is one of the most feature-rich and modern options available, but it’s helpful to understand how it compares to others.
99

1010
---
1111

@@ -18,7 +18,7 @@ A **frontend** is an interface that connects to Hive’s decentralized backend.
1818
- Manage their Hive account
1919
- Interact with communities
2020

21-
Each frontend uses the same Hive blockchain data but presents it differently.
21+
Each frontend uses the same Hive blockchain data - but presents it differently.
2222

2323
---
2424

src/content/docs/ecency/notifications-drafts-bookmarks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Use bookmarks to **save posts** for later reading or reference. You can also boo
5858
- Great for tutorials, inspiration, or curating
5959
- Bookmark any post with the 🔖 icon
6060
- Bookmark or Favorite any author with ❤️ icon and get notified when they publish new content
61-
- Bookmarks are **private** only you can see them
61+
- Bookmarks are **private** - only you can see them
6262

6363
### Accessing Bookmarks
6464

src/content/docs/ecency/publish.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ You can import an existing blog post or article into the editor instead of start
3535

3636
### Supported sources
3737

38-
- **Hive posts** URLs from Ecency, PeakD, Hive.blog, and other Hive front-ends. The original markdown and tags are preserved.
39-
- **External articles** URLs from any public website. The article text and images are extracted automatically, and a source attribution is appended at the end.
38+
- **Hive posts** - URLs from Ecency, PeakD, Hive.blog, and other Hive front-ends. The original markdown and tags are preserved.
39+
- **External articles** - URLs from any public website. The article text and images are extracted automatically, and a source attribution is appended at the end.
4040

4141
:::caution
4242
Only import content that you own or have permission to republish.

src/content/docs/ecency/wallets/about.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ You can view balances, recent transactions, and perform key actions across these
2828

2929
### External Chain Tokens
3030

31-
Ecency Wallets can generate lightweight wallets for supported blockchains such as **Bitcoin (BTC)**, **Ethereum (ETH)**, **BNB Chain (BNB)**, **Solana (SOL)**, **Aptos (APT)**, **Tron (TRX)**, and **Ton (TON)**. These direct integrations give you full control and self custody, letting you track and transfer cross-chain tokens alongside your Hive assets without leaving Ecency. See the [cross-chain wallet quickstart](/ecency/wallets/cross-chain-wallets/) for setup steps.
31+
Ecency Wallets support lightweight wallets for blockchains such as **Bitcoin (BTC)**, **Ethereum (ETH)**, **BNB Chain (BNB)**, **Solana (SOL)**, **Aptos (APT)**, **Tron (TRX)**, and **Ton (TON)**. These direct integrations give you full control and self custody, letting you track and transfer cross-chain tokens alongside your Hive assets without leaving Ecency. The cross-chain wallet structure is being upgraded - see [cross-chain wallets](/ecency/wallets/cross-chain-wallets/) for details and the [seed phrase migration guide](/guides/seed-phrase-migration/) if you have funds in a wallet created with a seed phrase.
3232

3333
---
3434

@@ -54,7 +54,7 @@ Convert Hive Power back into liquid HIVE over a 13-week period (weekly payouts).
5454
- Transfer it to others
5555
- Use it outside Hive ecosystem
5656

57-
> Be mindful powering down reduces your voting and RC capacity.
57+
> Be mindful - powering down reduces your voting and RC capacity.
5858
5959
---
6060

@@ -104,7 +104,7 @@ Transferring HBD into savings earns you 15-20% (subject to governance settings)
104104
- Always store your **active key** securely (required for transfers).
105105
- Use **Hive Keychain** or **Ecency mobile app** for safer transactions.
106106
- Never share your **owner key**.
107-
- For cross-chain wallets, back up any **seed phrases** shown during address generation.
107+
- If you have a cross-chain wallet created with a seed phrase, keep the phrase safe until you have [migrated your funds](/guides/seed-phrase-migration/).
108108

109109
---
110110

0 commit comments

Comments
 (0)