Git Product home page Git Product logo

docs-old's Introduction

title description footer aside
CosmWasm Documentation
CosmWasm is a new smart contracting platform built for the cosmos ecosystem.
newsletter
true

CosmWasm Documentation Moved to https://github.com/CosmWasm/docs

CosmWasm is a new smart contracting platform built for the cosmos ecosystem. If you haven't yet heard of it, please check out this intro. The purpose of this documentation is to give a deep dive into the technology for developers who wish to try it out or integrate it into their product. Particularly, it is aimed at Go developers with experience with the Cosmos-SDK, as well as Rust developers looking for a blockchain platform. {synopsis}

CosmWasm was originally prototyped by Team Gaians at the Berlin Hackatom 2019. In particular, Aaron Craelius came up with the architecture, especially avoiding reentrancy, Jehan Tremback led the rust coding, and Ethan Frey led the go side of the implementation. After the successful prototype, the Interchain Foundation provided a grant to Confio to implement a robust version that would work in an adversarial environment. This article introduces developers to the output of that grant work, and lays out possible future directions.

Aside Title

To demonstrate that headers can add title to ON THIS PAGE. ๐Ÿ‘‰

docs-old's People

Contributors

afdudley avatar alpe avatar clevinson avatar ethanfrey avatar jaybxyz avatar kamid avatar lovincyrus avatar okwme avatar orkunkl avatar tac0turtle avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs-old's Issues

Upgrade tutorial to cosmwasm 0.7

When cosmwasm 0.7 is release, this will mean a number of changes to contract development. There is also a new escrow contract release to start with as a basis. We should update the tutorial to match it.

This requires not only a tagged 0.7 cosmwasm for contract development, but a tagged wasmd that supports 0.7 contracts.

Consider WebAssembly Studio in tutorial

One of the barriers to entry is installing the editor and build environment. There is actually an online IDE to allow building wasm projects from rust, assemblyscript or C directly in your browser: https://webassembly.studio/

I would look at this to simplify the intro tutorial, but you would want a real editor if you go beyond the demo. Still, it may make the barrier to entry lower - consider this if the build system is a hinderance. If rust itself is the barrier to entry, comment here: https://github.com/confio/cosmwasm/issues/74

Upgrade docs to cosmwasm 0.6.3 / wasmd

A step on the way to #22

I just merged cosmwasm 0.6.3 support into wasmd master (Jan 17, 11:00 UTC). We will make a wasmd tag when 0.38 cosmos-sdk is integrated.

We need to upgrade some docs. I will make a quick first pass to the obvious broken commands, but it would be good if someone goes through carefull to make sure all code samples and sample commands work properly. The rust code changes, but also the cli - notably the query commands.

Random Doc Improvements

Various items to improve text-wise

  • "known vector attacks " -> "known attack vectors"
  • when mentioning decimal and blake2b in the docs, it might make sense to mention why each is useful. By the way, blake3 is out now, which has significant parts written in rust
  • early in the docs, on the Actor model page, the code is in Go. If this is for people writing Rust, it might be distracting or confusing. https://www.cosmwasm.com/docs/intro/actor
  • on the canonical addresses page, the ?= operator may not be clear for some readers https://www.cosmwasm.com/docs/intro/addresses#canonical-addresses

Get a Logo

I threw something together with rust/wasm and cosmos logos. Neither belong to me. Even ignoring trademark issues, the project should have it's own logo.

Also, this logo should be the same color as the title bar (change one or the other), and should have a favicon verion.

Introduce code earlier on

Let's throw a few more code samples early on. If nothing else, API definitions to go along with text. Here is some feedback from a reader to contextualize the issue:

  • it would be nice to have more real code in the Intro section of the docs, ideally with some real usable code on the first page, Intro -> Overview.
  • I definitely expected to see some real working code on the Getting Started -> First Contract page. It feels like things stay at 0 code for really long, then in the "Editing the Sample Contract" page it goes into fine-granularity code detail mode. If you can start introducing code much earlier, and at a higher-level, it might ease people into that section better.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.