Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

Commit

Permalink
rework overview & how it works
Browse files Browse the repository at this point in the history
  • Loading branch information
ciaranightingale committed Sep 13, 2023
1 parent 5c4abde commit abc6352
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 21 deletions.
24 changes: 10 additions & 14 deletions docs/onboarding/3 EVM SDK/0 Overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,24 @@ title: Overview

import SupportedLanguagesSection from "@components/SupportedLanguagesSection";

The Contract SDK serves as a comprehensive interface for interacting with contracts on any EVM-compatible blockchain network. Designed to be highly versatile, it seamlessly integrates with web applications, mobile apps, gaming platforms, and automated scripts, providing a unified toolkit for contract interaction.
The Contract SDK functions as a comprehensive interface for interacting with contracts
across all EVM-compatible blockchain networks.
Created to be versatile, this SDK offers intuitive tools for constructing web and mobile applications,
games, and scripts with blockchain connectivity.

It saves you the hassle of handling complex, repetitive logic, but it also frees you up to focus on your specific application's unique features and functionalities.
Utilizing the Contract SDK removes the need to manage complex, repetitive logic,
allowing developers to focus on the unique features and functionalities of their application.

## Features

- **Extension-Driven Framework**: The SDK uses a contract-driven approach, automatically recognizing and enabling functionality based on common standards that your contract implements like ERC20, ERC721, and ERC1155. The full list of extensions can be found in the [Solidity documentation](https://www.notion.so/Solidity-SDK-cc236c86e6874cdc87808001b13283b8?pvs=21).
- **Extension-Driven Framework**: The SDK uses a extension-driven approach, automatically recognizing and enabling functionality based on common standards that your contract implements like [ERC20](/solidity/extensions/erc20), [ERC721](/solidity/extensions/erc721), and [ERC1155](/solidity/extensions/erc1155). The full list of extensions can be found in the [Solidity documentation](/solidity/extensions).
- **Multi-Lingual Support**: Offers SDKs for Unity, TypeScript, React, Python, and GO.
- **Any EVM Compatibility**: Designed to operate with any EVM-compatible network.
- **Cross-Platform Integration**: Suitable for web, mobile, and gaming applications, as well as automated scripting.
- **Cross-Platform Integration**: Suitable for web, mobile, gaming applications and scripting.
- **High-Level Abstractions**: Simplifies complex contract interactions into easy-to-use APIs.
- **Security**: Incorporates the latest security practices for safe and secure contract interaction.
- **Flexibility and No Vendor Lock-in**:
- **Flexibility and No Vendor Lock-in**: The SDK is modular and composible enabling customizations and replacements of the default settings and tools.

## Use Cases

- **Decentralized Apps**: Easily integrate smart contracts into your DApps for added functionality.
- **Game Development**: Incorporate token-based or blockchain mechanics into games.
- **Enterprise Solutions**: Enhance your business logic with secure and transparent contract execution.
- **Automated Scripts**: Create automated tasks that interact with contracts, such as minting tokens or updating records.

By choosing the Contract SDK, developers gain a scalable, secure, and straightforward avenue for integrating smart contract functionalities across multiple platforms and languages.
The Contract SDK is a scalable and straightforward avenue for integrating smart contract functionalities across multiple platforms and languages.

## Supported Languages

Expand Down
31 changes: 24 additions & 7 deletions docs/onboarding/3 EVM SDK/1 How it works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,39 @@ title: Architecture

# Architecture

The Contract SDK streamlines decentralized application development by managing everything from blockchain connections to user interfaces. The design is modular and highly composable, offering a mix of default settings and customization options to suit your project's unique requirements best.
The Contract SDK streamlines decentralized application development by managing everything from
blockchain connections to user interfaces.
The design is modular and highly composable,
offering a mix of default settings and customization options to suit your project's unique requirements best.

## Extension-Driven Framework

At the core of the SDK is an extension-driven, contract-centric architecture. This allows the SDK to automatically identify and enable functionalities based on common contract standards such as ERC20, ERC721, and ERC1155. This is achieved by resolving the smart contract's ABI and recognizing the implemented standards, also known as extensions.
The Contract SDK has an **extension-driven**, contract-centric architecture.
This allows the SDK to automatically identify and enable functionalities based on
common contract standards such as ERC20, ERC721, and ERC1155.
This is achieved by resolving the smart contract's ABI and extracting the implemented standards; known as extensions.

Each identified extension activates specific sets of methods and components, enabling you to interact with the smart contract effortlessly in the programming language of your choice.
Each detected extension unlocks functionality in the SDK for you to use;
enabling sets of methods and components to be used in the language of your choice to interact directly with the smart contract.

## Seamless Onboarding and Efficiency
## No ABI Required

With our suite of tools, including a comprehensive dashboard and import feature, getting started is straightforward. All you need to connect to a smart contract is the contract's address; the SDK automatically resolves the ABI from our on-chain registry. For optimized performance, each contract's details are cached, speeding up your read and write operations.
Our ecosystem of tools such as our [dashboard](/dashboard) and [import](/dashboard/import) feature make using smart contracts simpler and more efficient.
Connecting to a smart contract just requires the contract address, (no ABI), and are resolved from our on-chain registry of smart contracts automatically.
Each contract’s information is automatically cached by the SDK,
so your operations to read and write data to the smart contract are fast and efficient.

## Infrastructure

The SDK comes pre-configured with essential infrastructure elements for decentralized applications. These include blockchain RPC connections, IPFS pinning services, wallet onboarding flows, gasless relayers, FIAT on-ramps, and more. While these defaults are designed to give you a running start, they can also be customized to fit the particular needs of your project.
The SDK comes pre-configured with essential infrastructure to create decentralized applications.
These include blockchain RPC connections, IPFS pinning services, wallet onboarding flows,
gasless relayers, FIAT on-ramps, and more.
These defaults are designed to streamline the developer experience to build permformant and scalable applications,
they can also be customized to fit a projects requirements.

## Flexibility and No Vendor Lock-In

Our platform's modular and composable nature allows you to customize or replace any aspect of our tools. The SDK allows easy modification and integration if you prefer to use your own RPC, have a different wallet connection flow, or wish to employ another decentralized storage solution. This flexibility ensures you're never locked into specific tools or services, offering the freedom to tailor your development experience.
All components of the SDK are modular and customizable,
offering the flexibility to adapt the tooling to specific needs or to integrate
with alternative services for unique use cases. This enables seamless changes to RPC providers,
wallet connection flows, decentralized storage solutions, or gasless relayers as needed.

0 comments on commit abc6352

Please sign in to comment.