Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

Build robust Cardano applications with modern TypeScript, functional programming, and comprehensive type safety.

[![Build Status](https://img.shields.io/github/actions/workflow/status/no-witness-labs/evolution-sdk/ci.yml?branch=main)](https://github.com/no-witness-labs/evolution-sdk/actions)
[![Build Status](https://img.shields.io/github/actions/workflow/status/IntersectMBO/evolution-sdk/ci.yml?branch=main)](https://github.com/IntersectMBO/evolution-sdk/actions)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.4+-blue.svg)](https://www.typescriptlang.org/)
[![Effect](https://img.shields.io/badge/Effect-3.0+-blueviolet.svg)](https://effect.website/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[Documentation](https://no-witness-labs.github.io/evolution-sdk) • [Quick Start](#quick-start) • [Contributing](#contributing)
[Documentation](https://intersectmbo.github.io/evolution-sdk) • [Quick Start](#quick-start) • [Contributing](#contributing)
</div>

---
Expand Down Expand Up @@ -152,18 +152,18 @@ evolution-sdk/

## Core Modules

Evolution SDK provides 78 comprehensive modules organized into the following categories:
Evolution SDK provides **125+ core modules** plus SDK utilities, organized into comprehensive categories:

### Address Management (10 modules)
- `Address` - Core address utilities with bech32/hex encoding
- `BaseAddress`, `ByronAddress`, `EnterpriseAddress` - All address types
- `BaseAddress`, `ByronAddress`, `EnterpriseAddress` - Address type implementations
- `PaymentAddress`, `PointerAddress`, `RewardAddress` - Specialized addresses
- `AddressDetails`, `AddressTag`, `StakeReference` - Address metadata
- `AddressEras`, `AddressTag`, `StakeReference` - Address metadata

### Transaction Handling (7 modules)
- `Transaction`, `TransactionBody`, `TransactionHash` - Core transaction
### Transaction Handling (9 modules)
- `Transaction`, `TransactionBody`, `TransactionHash` - Core transaction types
- `TransactionInput`, `TransactionOutput`, `TransactionIndex` - I/O handling
- `TransactionMetadatumLabels` - Metadata support
- `TransactionWitnessSet`, `TransactionMetadatum`, `TransactionMetadatumLabels` - Metadata & witnesses

### Cryptography & Security (9 modules)
- `Ed25519Signature`, `KesSignature`, `VrfCert` - Digital signatures
Expand Down Expand Up @@ -248,23 +248,23 @@ pnpm turbo type-check
## Documentation

### Website
For comprehensive guides, tutorials, and interactive examples, visit our [official documentation](https://no-witness-labs.github.io/evolution-sdk).
For comprehensive guides, tutorials, and interactive examples, visit our [official documentation](https://intersectmbo.github.io/evolution-sdk).

### API Reference
Complete API documentation with type definitions and examples is available in our [API reference](https://no-witness-labs.github.io/evolution-sdk/api).
Complete API documentation with type definitions and examples is available in our [API reference](https://intersectmbo.github.io/evolution-sdk/api).

### Learning Resources

- [Getting Started Guide](https://no-witness-labs.github.io/evolution-sdk/getting-started) - Your first steps with Evolution SDK
- [Getting Started Guide](https://intersectmbo.github.io/evolution-sdk/getting-started) - Your first steps with Evolution SDK

## Community & Support

Join our thriving community of Cardano developers:

- [Discord](https://discord.gg/RcW9xqFC) - Get help, share projects, and discuss development
- [Discord](https://discord.gg/jnGW5YG3) - Get help, share projects, and discuss development
- [X](https://x.com/nowitnesslabs) - Latest announcements and ecosystem updates
- [GitHub Issues](https://github.com/no-witness-labs/evolution-sdk/issues) - Bug reports and feature requests
- [GitHub Discussions](https://github.com/no-witness-labs/evolution-sdk/discussions) - Questions, ideas, and community showcases
- [GitHub Issues](https://github.com/IntersectMBO/evolution-sdk/issues) - Bug reports and feature requests
- [GitHub Discussions](https://github.com/IntersectMBO/evolution-sdk/discussions) - Questions, ideas, and community showcases

### Getting Help

Expand Down Expand Up @@ -340,7 +340,7 @@ We love your input! We want to make contributing to Evolution SDK as easy and tr

1. Fork and clone the repository
```bash
git clone https://github.com/your-username/evolution-sdk.git
git clone https://github.com/IntersectMBO/evolution-sdk.git
cd evolution-sdk
```

Expand Down Expand Up @@ -384,7 +384,7 @@ Evolution SDK builds on the incredible work of:

- [Turborepo](https://turborepo.org/) - For the incredible build system
- [Effect](https://effect.website/) - For functional programming excellence
- Our [contributors](https://github.com/no-witness-labs/evolution-sdk/graphs/contributors) - Building the future together
- Our [contributors](https://github.com/IntersectMBO/evolution-sdk/graphs/contributors) - Building the future together

---

Expand All @@ -393,10 +393,10 @@ Evolution SDK builds on the incredible work of:
<sub>Built with ❤️ by <a href="https://github.com/no-witness-labs">No Witness Labs</a></sub>
</p>
<p>
<a href="https://github.com/no-witness-labs/evolution-sdk">⭐ Star us on GitHub</a> •
<a href="https://github.com/IntersectMBO/evolution-sdk">⭐ Star us on GitHub</a> •
<a href="https://x.com/nowitnesslabs">Follow on X</a> •
<a href="https://discord.gg/RcW9xqFC">Join Discord</a>
<a href="https://discord.gg/jnGW5YG3">Join Discord</a>
</p>

[Read the docs](https://no-witness-labs.github.io/evolution-sdk) to get started building with Evolution SDK
[Read the docs](https://intersectmbo.github.io/evolution-sdk) to get started building with Evolution SDK
</div>
4 changes: 2 additions & 2 deletions docs/content/docs/addresses/address-types/base.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,6 @@ console.log("Script-based address:", bech32);

## Related

- **[Enterprise Addresses](./enterprise)** - Payment credential only
- **[Reward Addresses](./reward)** - Staking credential only
- **[Enterprise Addresses](/docs/addresses/address-types/enterprise)** - Payment credential only
- **[Reward Addresses](/docs/addresses/address-types/reward)** - Staking credential only
- **[Franken Addresses](/docs/addresses/franken)** - Addresses with credentials from different sources
4 changes: 2 additions & 2 deletions docs/content/docs/addresses/address-types/enterprise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,5 +99,5 @@ console.log("Script enterprise address:", bech32);

## Related

- **[Base Addresses](./base)** - Addresses with both payment and staking credentials
- **[Reward Addresses](./reward)** - Staking credential only
- **[Base Addresses](/docs/addresses/address-types/base)** - Addresses with both payment and staking credentials
- **[Reward Addresses](/docs/addresses/address-types/reward)** - Staking credential only
16 changes: 8 additions & 8 deletions docs/content/docs/addresses/address-types/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,19 @@ Each address type encodes different credential combinations:

| Address Type | Payment | Staking | On-Chain Size | Bech32 Prefix | Header Bits |
|--------------|---------|---------|---------------|---------------|-------------|
| **[Base](./base)** | ✓ | ✓ | 57 bytes | `addr`/`addr_test` | `0000xxxx` |
| **[Enterprise](./enterprise)** | ✓ | ✗ | 29 bytes | `addr`/`addr_test` | `0110xxxx` |
| **[Reward](./reward)** | ✗ | ✓ | 29 bytes | `stake`/`stake_test` | `1110xxxx` |
| **[Pointer](./pointer)** | ✓ | Pointer | Variable | `addr`/`addr_test` | `0100xxxx` |
| **[Base](/docs/addresses/address-types/base)** | ✓ | ✓ | 57 bytes | `addr`/`addr_test` | `0000xxxx` |
| **[Enterprise](/docs/addresses/address-types/enterprise)** | ✓ | ✗ | 29 bytes | `addr`/`addr_test` | `0110xxxx` |
| **[Reward](/docs/addresses/address-types/reward)** | ✗ | ✓ | 29 bytes | `stake`/`stake_test` | `1110xxxx` |
| **[Pointer](/docs/addresses/address-types/pointer)** | ✓ | Pointer | Variable | `addr`/`addr_test` | `0100xxxx` |

## Address Type Documentation

Detailed serialization specifications for each format:

- **[Base Addresses](./base)** - Payment and staking credential encoding
- **[Enterprise Addresses](./enterprise)** - Payment credential only encoding
- **[Reward Addresses](./reward)** - Staking credential only encoding
- **[Pointer Addresses](./pointer)** - On-chain stake registration reference encoding
- **[Base Addresses](/docs/addresses/address-types/base)** - Payment and staking credential encoding
- **[Enterprise Addresses](/docs/addresses/address-types/enterprise)** - Payment credential only encoding
- **[Reward Addresses](/docs/addresses/address-types/reward)** - Staking credential only encoding
- **[Pointer Addresses](/docs/addresses/address-types/pointer)** - On-chain stake registration reference encoding

## Related

Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/addresses/address-types/pointer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,5 +119,5 @@ console.log("Pointer address (deprecated):", pointerAddr);

## Related

- **[Base Addresses](./base)** - Standard address format with embedded stake credential
- **[Enterprise Addresses](./enterprise)** - Payment credential only
- **[Base Addresses](/docs/addresses/address-types/base)** - Standard address format with embedded stake credential
- **[Enterprise Addresses](/docs/addresses/address-types/enterprise)** - Payment credential only
4 changes: 2 additions & 2 deletions docs/content/docs/addresses/address-types/reward.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,6 @@ Reward addresses enable separation between payment and staking operations:

## Related

- **[Base Addresses](./base)** - Addresses with both payment and staking credentials
- **[Enterprise Addresses](./enterprise)** - Payment credential only
- **[Base Addresses](/docs/addresses/address-types/base)** - Addresses with both payment and staking credentials
- **[Enterprise Addresses](/docs/addresses/address-types/enterprise)** - Payment credential only
- **[Staking](/docs/staking)** - Using reward addresses for delegation and withdrawals
2 changes: 1 addition & 1 deletion docs/content/docs/architecture/provider-layer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,6 @@ The provider layer integrates with other architectural components:

## Related Topics

- [Client Architecture](/docs/architecture/index) - How providers attach to clients
- [Client Architecture](/docs/architecture) - How providers attach to clients
- [Transaction Flow](/docs/architecture/transaction-flow) - Provider queries during build phase
- [Deferred Execution](/docs/architecture/deferred-execution) - Provider integration with program execution
2 changes: 1 addition & 1 deletion docs/content/docs/architecture/wallet-layer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,6 @@ Compiler automatically selects correct return type based on wallet parameter.

## Related Topics

- [Client Architecture](/docs/architecture/index) - How clients compose with wallets and providers
- [Client Architecture](/docs/architecture) - How clients compose with wallets and providers
- [Transaction Flow](/docs/architecture/transaction-flow) - How wallet type affects build/sign/submit flow
- [Deferred Execution](/docs/architecture/deferred-execution) - Change address resolution from wallet
9 changes: 2 additions & 7 deletions docs/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,10 @@ import { Card, Cards } from 'fumadocs-ui/components/card'
description="Generate TypeScript types from Plutus Blueprint JSON"
href="/tools/blueprint-codegen"
/>
<Card
title="Examples"
description="Explore real-world examples and common patterns"
href="/docs/examples"
/>
<Card
title="API Reference"
description="Complete API documentation for all modules"
href="/docs/api"
href="/docs/modules"
/>
</Cards>

Expand Down Expand Up @@ -69,7 +64,7 @@ Learn the fundamentals of working with Evolution SDK.
<Card
title="Querying"
description="Query blockchain data and UTxOs"
href="/docs/getting-started/provider"
href="/docs/querying"
/>
</Cards>

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/introduction/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const client = createClient({
});
```

See [Creating Wallets](/docs/wallets/creating-wallets) for all wallet types.
See [Creating Wallets](/docs/wallets) for all wallet types.

### 3. Attach a Provider
Connect to the blockchain via a provider:
Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/introduction/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,6 @@ console.log("Evolution SDK loaded successfully!");

## Next Steps

- [Create a wallet](/docs/wallets/creating-wallets)
- [Create a wallet](/docs/wallets)
- [Connect a provider](/docs/clients/providers)
- [Build your first transaction](/docs/getting-started)
- [Build your first transaction](/docs/introduction/getting-started)
2 changes: 1 addition & 1 deletion docs/next-env.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />
import "./out/dev/types/routes.d.ts";
import "./.next/types/routes.d.ts";

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