Skip to content

Commit cc9d840

Browse files
committed
fix: remove sdk address imports
1 parent 4db7e0b commit cc9d840

File tree

5 files changed

+5
-49
lines changed

5 files changed

+5
-49
lines changed

docs/content/docs/addresses/conversion.mdx

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -123,32 +123,6 @@ const bech32 = Address.toBech32(address);
123123
console.log("Bech32:", bech32);
124124
```
125125

126-
## SDK Helper Functions
127-
128-
The SDK module provides convenient helpers that wrap the Core transformations:
129-
130-
```typescript twoslash
131-
import * as Address from "@evolution-sdk/evolution/sdk/Address";
132-
133-
const bech32Address = "addr1qx2kd28nq8ac5prwg32hhvudlwggpgfp8utlyqxu6wqgz62f79qsdmm5dsknt9ecr5w468r9ey0fxwkdrwh08ly3tu9sy0f4qd";
134-
135-
// Bech32 string → AddressStructure
136-
const structure = Address.toAddressStructure(bech32Address);
137-
138-
// AddressStructure → Bech32 string
139-
const bech32 = Address.fromAddressStructure(structure);
140-
141-
// JSON ↔ AddressStructure (for serialization)
142-
const json = Address.fromAddressStructureToJson(structure);
143-
const fromJson = Address.fromJsonToAddressStructure(json);
144-
145-
// Combined: Bech32 → JSON
146-
const jsonDirect = Address.addressToJson(bech32Address);
147-
148-
// Combined: JSON → Bech32
149-
const bech32Direct = Address.jsonToAddress(json);
150-
```
151-
152126
## Best Practices
153127

154128
**Use Bech32 for Display**: Always show users Bech32-encoded addresses. They're human-readable and include error detection.

docs/content/docs/addresses/index.mdx

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,7 @@ description: Working with Cardano addresses using the Core AddressStructure modu
55

66
# Addresses
77

8-
Cardano addresses identify where funds can be sent and who controls them. In Evolution SDK:
9-
- **SDK Level**: `Address` is a simple string type alias for Bech32 addresses (`type Address = string`)
10-
- **Core Level**: `AddressStructure` module handles all parsing, encoding, validation, and manipulation
11-
12-
<Callout type="info">
13-
**Important**: The SDK `Address` type is just a Bech32 string. All address functionality lives in the Core `AddressStructure` module. This documentation focuses on the Core module.
14-
</Callout>
8+
Cardano addresses identify where funds can be sent and who controls them. The Evolution SDK Core `AddressStructure` module handles all parsing, encoding, validation, and manipulation of addresses.
159

1610
## Address Types Overview
1711

@@ -25,19 +19,6 @@ Cardano has several address types, each optimized for different use cases:
2519
| **[Pointer](/docs/addresses/pointer)** | ✅ Yes | 🔗 Reference | Legacy optimization | ❌ Avoid |
2620
| **[Franken](/docs/addresses/franken)** | ✅ Yes (A) | ✅ Yes (B) | Custody, enterprise | Advanced use |
2721

28-
## SDK Address Type
29-
30-
At the SDK level, an `Address` is just a Bech32-encoded string:
31-
32-
```typescript twoslash
33-
import type { Address } from "@evolution-sdk/evolution/sdk/Address";
34-
35-
// Address is simply: type Address = string
36-
const address: Address = "addr_test1qz...";
37-
```
38-
39-
All the actual address functionality is in the **Core `AddressStructure` module**.
40-
4122
## Quick Start
4223

4324
### Parse Existing Address

docs/next-env.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// <reference types="next" />
22
/// <reference types="next/image-types/global" />
3-
import "./out/dev/types/routes.d.ts";
3+
import "./.next/types/routes.d.ts";
44

55
// NOTE: This file should not be edited
66
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

docs/tsconfig.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@
4545
".next/types/**/*.ts",
4646
"next-env.d.ts",
4747
"out/types/**/*.ts",
48-
"out/dev/types/**/*.ts"
48+
"out/dev/types/**/*.ts",
49+
".next/dev/types/**/*.ts"
4950
],
5051
"exclude": [
5152
"node_modules"

docs/tsconfig.twoslash.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"compilerOptions": {
33
"module": "ESNext",
4-
"moduleResolution": "Bundler",
4+
"moduleResolution": "bundler",
55
"target": "ESNext",
66
"lib": ["ES2022", "DOM"],
77
"skipLibCheck": true,

0 commit comments

Comments
 (0)