Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add files via upload #13

Merged
merged 8 commits into from
Mar 7, 2024
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
Binary file added docs/build/img/astar-swanky.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/build/img/swanky-cli.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/build/img/swanky-node.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/build/swanky/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import Figure from '/src/components/figure'

# Swanky CLI

<Figure caption="Build" src={require('../img/swanky-cli.jpg').default } width="100%" />

Swanky CLI is a Node.js based CLI application that abstracts away and extends the functionality of Polkadot.js, `cargo contract`, and other ink! based smart contract developer tools.
It aims to ease development of and interaction with ink! smart contracts and provides simple tools to bootstrap contract environment (project) with contract and integration tests templates, local node and accounts management, smart contracts interaction on both local and remote networks, compatibility checks between the contract pallet and compiler...

Expand Down
23 changes: 14 additions & 9 deletions docs/build/swanky/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
import Figure from "/src/components/figure"


# Swanky Suite

Swanky Suite aims to be an "all-in-one" tool for Wasm smart contract developers. It is based on existing tools like `cargo contract CLI` and `polkadot.js` but extends their functionality with many additional features such as smart contract templates, and an instant finality (Swanky) node, which reduces the contract development lifecycle.

<Figure caption="Build" src={require('../img/astar-swanky.jpg').default } width="100%" />

Swanky Suite is a tool that provides Web3 Wasm dapps developers with an experience that is more in-line with what they're familiar with, compared to popular tooling for EVM.

Swanky Suite offers an extensible set of features, allowing developers to:

- Quickly spin up a local contract development node with instant finality (Swanky Node).
- provide a ready dev environment via prebuilt Docker image and dev-container configuration
- Easily scaffold new projects using templates for both smart contracts and (soon) front-end dApps.
- Compile ink! projects and generate TS types.
- provide Typescript based integration testing simulating interaction from the client-side.
- Handle and manage network accounts.
- Deploy smart contracts within the Polkadot ecosystem to networks that support `pallet-contracts`.
- Quickly spin up a local contract development node with instant finality (Swanky Node);
- Provide a ready dev environment via prebuilt Docker image and dev-container configuration;
- Easily scaffold new projects using templates for both smart contracts and (soon) front-end dApps;
- Compile ink! projects and generate TS types;
- Provide Typescript based integration testing simulating interaction from the client-side;
- Handle and manage network accounts;
- Deploy smart contracts within the Polkadot ecosystem to networks that support `pallet-contracts`;
- Make arbitrary calls to deployed smart contracts.

## Architecture Overview
Expand All @@ -28,9 +33,9 @@ Source code for both Swanky CLI and Swanky Node are hosted on GitHub:

This documentation's sub-sections on usage of Swanky CLI and Swanky Node have great instructions on how to setup the tool and start using it right away.

`swanky` CLI Github repo with the latest documentation;
`swanky` CLI Github repo with the latest releases, ink! Dev Hub documentation;

`swanky-node` Github repo with the latest documentation;
`swanky-node` Github repo with the latest releases, ink! Dev Hub documentation;

`pallet-contracts` documentation on Parity Github;

Expand Down
4 changes: 4 additions & 0 deletions docs/build/swanky/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@
sidebar_position: 2
---

import Figure from "/src/components/figure"

# Swanky Node

<Figure caption="Build" src={require('../img/swanky-node.jpg').default } width="100%" />

Swanky Node is a Substrate based blockchain configured to enable `pallet-contracts` (a smart contract module), and other features that assist local development of Wasm smart contracts.

### Features
Expand Down
Loading