Merge pull request #119 from iotaledger/poc-experimental

Added architecture doc
iotaledger · Mar 3, 2021 · fff2125 · fff2125
2 parents df34b04 + 6585e0b
commit fff2125
Show file tree

Hide file tree

Showing 48 changed files with 31 additions and 31 deletions.
diff --git a/contracts/rust/wasmlib/docs/Context.md b/contracts/rust/wasmlib/docs/Context.md
@@ -16,8 +16,8 @@ contract functions in the ISCP:
 To support this function type distinction, Func and View each receive a
 separate, different function call context, and only the functionality that is
 necessary for their implementation is provided through their respective contexts
-ScFuncContext and ScViewContext. ScViewContext only provides a limited,
-immutable subset of the functionality provided by ScFuncContext. Again, the
+`ScFuncContext` and `ScViewContext`. `ScViewContext` only provides a limited,
+immutable subset of the functionality provided by `ScFuncContext`. Again, the
 compiler will prevent the programmer from using the wrong functionality in the
 wrong context.
 
@@ -52,9 +52,9 @@ fn on_load() {
 }
 ```
 
-As you can see this on_load() function first creates the required ScExports
+As you can see this on_load() function first creates the required `ScExports`
 context and then proceeds to define two Funcs named "divide" and "member" by
-calling the add_func() method of the ScExports object and then one View named
+calling the add_func() method of the `ScExports` object and then one View named
 "getFactor" by calling its add_view() method. The second parameter to these
 methods is the smart contract function associated with the name specified. These
 methods will also automatically assign unique identifiers and then send it all

diff --git a/contracts/rust/wasmlib/docs/Overview.md b/contracts/rust/wasmlib/docs/Overview.md
@@ -2,22 +2,22 @@
 
 WasmLib provides direct support for the following value data types:
 
-- Int64 - We currently only directly support 64-bit integer values.
-- Bytes - An arbitrary-length byte array.
-- String - An UTF-8 encoded string value.
-- Address - A 33-byte Tangle address.
-- AgentId - A 37-byte ISCP Agent id.
-- ChainId - A 33-byte ISCP Chain id.
-- Color - A 32-byte token color id.
-- ContractId - A 37-byte ISCP smart contract id.
-- Hash - A 32-byte hash values.
-- Hname - A 4-byte unsigned integer hash value derived from a name string.
-- RequestId - A 34-byte transaction request id.
+- `Int64` - We currently only directly support 64-bit integer values.
+- `Bytes` - An arbitrary-length byte array.
+- `String` - An UTF-8 encoded string value.
+- `Address` - A 33-byte Tangle address.
+- `AgentId` - A 37-byte ISCP Agent id.
+- `ChainId` - A 33-byte ISCP Chain id.
+- `Color` - A 32-byte token color id.
+- `ContractId` - A 37-byte ISCP smart contract id.
+- `Hash` - A 32-byte hash values.
+- `Hname` - A 4-byte unsigned integer hash value derived from a name string.
+- `RequestId` - A 34-byte transaction request id.
 
 The first three are basic value data types found in all programming languages,
 whereas the other types are ISCP-specific value data types. More detailed
-explanations about their specific use can be found in the documentation of the
-ISCP. Each of these value data types has the ability to serialize into and
+explanations about their specific use can be found in the [documentation of the
+ISCP](../../../../docs/docs/coretypes.md). Each of these value data types has the ability to serialize into and
 deserialize from a byte array. Each value data type can also be used as a key to
 our key/value proxy objects.
 

diff --git a/contracts/rust/wasmlib/docs/Proxies.md b/contracts/rust/wasmlib/docs/Proxies.md
@@ -47,10 +47,10 @@ name is subsequently followed by Array.
 
 Examples:
 
-- ScMutableInt - proxy to mutable int value
-- ScImmutableString - proxy to immutable string value
-- ScImmutableColorArray - proxy to immutable array of immutable color values
-- ScMutableMap - proxy to mutable map
-- ScImmutableMapArray - proxy to immutable array of immutable map
+- `ScMutableInt` - proxy to mutable int value
+- `ScImmutableString` - proxy to immutable string value
+- `ScImmutableColorArray` - proxy to immutable array of immutable color values
+- `ScMutableMap` - proxy to mutable map
+- `ScImmutableMapArray` - proxy to immutable array of immutable map
 
 Next: [Function Call Context](Context.md)
diff --git a/docs/ISCP architecture description v2.pdf b/docs/ISCP architecture description v2.pdf
diff --git a/articles/docs/accounts.md → docs/docs/accounts.md b/articles/docs/accounts.md → docs/docs/accounts.md
diff --git a/articles/docs/coretypes.md → docs/docs/coretypes.md b/articles/docs/coretypes.md → docs/docs/coretypes.md
diff --git a/articles/docs/deploy.md → docs/docs/deploy.md b/articles/docs/deploy.md → docs/docs/deploy.md
diff --git a/articles/docs/publisher.md → docs/docs/publisher.md b/articles/docs/publisher.md → docs/docs/publisher.md
diff --git a/articles/docs/runwasp.md → docs/docs/runwasp.md b/articles/docs/runwasp.md → docs/docs/runwasp.md
diff --git a/articles/intro/todo/deploy.md → docs/intro/todo/deploy.md b/articles/intro/todo/deploy.md → docs/intro/todo/deploy.md
diff --git a/articles/intro/todo/dwf.md → docs/intro/todo/dwf.md b/articles/intro/todo/dwf.md → docs/intro/todo/dwf.md
diff --git a/articles/intro/todo/tr-fa.md → docs/intro/todo/tr-fa.md b/articles/intro/todo/tr-fa.md → docs/intro/todo/tr-fa.md
diff --git a/articles/intro/utxo.md → docs/intro/utxo.md b/articles/intro/utxo.md → docs/intro/utxo.md
diff --git a/articles/tutorial/01.md → docs/tutorial/01.md b/articles/tutorial/01.md → docs/tutorial/01.md
diff --git a/articles/tutorial/02.md → docs/tutorial/02.md b/articles/tutorial/02.md → docs/tutorial/02.md
diff --git a/articles/tutorial/03.md → docs/tutorial/03.md b/articles/tutorial/03.md → docs/tutorial/03.md
diff --git a/articles/tutorial/04.md → docs/tutorial/04.md b/articles/tutorial/04.md → docs/tutorial/04.md
diff --git a/articles/tutorial/05.md → docs/tutorial/05.md b/articles/tutorial/05.md → docs/tutorial/05.md
diff --git a/articles/tutorial/06.md → docs/tutorial/06.md b/articles/tutorial/06.md → docs/tutorial/06.md
diff --git a/articles/tutorial/07.md → docs/tutorial/07.md b/articles/tutorial/07.md → docs/tutorial/07.md
diff --git a/articles/tutorial/08.md → docs/tutorial/08.md b/articles/tutorial/08.md → docs/tutorial/08.md
diff --git a/articles/tutorial/09.md → docs/tutorial/09.md b/articles/tutorial/09.md → docs/tutorial/09.md
diff --git a/articles/tutorial/10.md → docs/tutorial/10.md b/articles/tutorial/10.md → docs/tutorial/10.md
diff --git a/articles/tutorial/11.md → docs/tutorial/11.md b/articles/tutorial/11.md → docs/tutorial/11.md
diff --git a/articles/tutorial/SC-structure.png → docs/tutorial/SC-structure.png b/articles/tutorial/SC-structure.png → docs/tutorial/SC-structure.png
diff --git a/articles/tutorial/accounts.md → docs/tutorial/accounts.md b/articles/tutorial/accounts.md → docs/tutorial/accounts.md
diff --git a/articles/tutorial/accounts.png → docs/tutorial/accounts.png b/articles/tutorial/accounts.png → docs/tutorial/accounts.png
diff --git a/articles/tutorial/blob.md → docs/tutorial/blob.md b/articles/tutorial/blob.md → docs/tutorial/blob.md
diff --git a/articles/tutorial/call_view.png → docs/tutorial/call_view.png b/articles/tutorial/call_view.png → docs/tutorial/call_view.png
diff --git a/articles/tutorial/coresc.md → docs/tutorial/coresc.md b/articles/tutorial/coresc.md → docs/tutorial/coresc.md
diff --git a/articles/tutorial/eventlog.md → docs/tutorial/eventlog.md b/articles/tutorial/eventlog.md → docs/tutorial/eventlog.md
diff --git a/...cles/tutorial/example-tutorial/Cargo.lock → docs/tutorial/example-tutorial/Cargo.lock b/...cles/tutorial/example-tutorial/Cargo.lock → docs/tutorial/example-tutorial/Cargo.lock
diff --git a/...cles/tutorial/example-tutorial/Cargo.toml → docs/tutorial/example-tutorial/Cargo.toml b/...cles/tutorial/example-tutorial/Cargo.toml → docs/tutorial/example-tutorial/Cargo.toml
diff --git a/articles/tutorial/example-tutorial/LICENSE → docs/tutorial/example-tutorial/LICENSE b/articles/tutorial/example-tutorial/LICENSE → docs/tutorial/example-tutorial/LICENSE
diff --git a/articles/tutorial/example-tutorial/README.md → docs/tutorial/example-tutorial/README.md b/articles/tutorial/example-tutorial/README.md → docs/tutorial/example-tutorial/README.md
diff --git a/articles/tutorial/example-tutorial/cp → docs/tutorial/example-tutorial/cp b/articles/tutorial/example-tutorial/cp → docs/tutorial/example-tutorial/cp
diff --git a/articles/tutorial/example-tutorial/cp.bat → docs/tutorial/example-tutorial/cp.bat b/articles/tutorial/example-tutorial/cp.bat → docs/tutorial/example-tutorial/cp.bat
diff --git a/...cles/tutorial/example-tutorial/src/lib.rs → docs/tutorial/example-tutorial/src/lib.rs b/...cles/tutorial/example-tutorial/src/lib.rs → docs/tutorial/example-tutorial/src/lib.rs
diff --git a/...le-tutorial/test/example_tutorial_bg.wasm → ...le-tutorial/test/example_tutorial_bg.wasm b/...le-tutorial/test/example_tutorial_bg.wasm → ...le-tutorial/test/example_tutorial_bg.wasm
diff --git a/...al/example-tutorial/test/tutorial_test.go → ...al/example-tutorial/test/tutorial_test.go b/...al/example-tutorial/test/tutorial_test.go → ...al/example-tutorial/test/tutorial_test.go
diff --git a/articles/tutorial/install.md → docs/tutorial/install.md b/articles/tutorial/install.md → docs/tutorial/install.md
diff --git a/articles/tutorial/invoking.md → docs/tutorial/invoking.md b/articles/tutorial/invoking.md → docs/tutorial/invoking.md
diff --git a/articles/tutorial/iscp_accounts.md → docs/tutorial/iscp_accounts.md b/articles/tutorial/iscp_accounts.md → docs/tutorial/iscp_accounts.md
diff --git a/articles/tutorial/readme.md → docs/tutorial/readme.md b/articles/tutorial/readme.md → docs/tutorial/readme.md
diff --git a/articles/tutorial/root.md → docs/tutorial/root.md b/articles/tutorial/root.md → docs/tutorial/root.md
diff --git a/articles/tutorial/send_request.png → docs/tutorial/send_request.png b/articles/tutorial/send_request.png → docs/tutorial/send_request.png
diff --git a/plugins/banner/plugin.go b/plugins/banner/plugin.go
@@ -11,7 +11,7 @@ const PluginName = "Banner"
 
 const (
 	// AppVersion version number
-	AppVersion = "v0.1.0"
+	AppVersion = "v0.1.1"
 
 	// AppName app code name
 	AppName = "Wasp"

diff --git a/readme.md b/readme.md
@@ -9,7 +9,7 @@ introduction](https://blog.iota.org/an-introduction-to-iota-smart-contracts-16ea
 into ISCP.
 
 A _smart contract_ is a distributed software agent that stores its state in the
-[UTXO ledger](articles/intro/utxo.md), and evolves with each _request_ sent to
+[UTXO ledger](docs/intro/utxo.md), and evolves with each _request_ sent to
 the contrct. Since the UTXO ledger is immutable, by extension the smart
 contract state is also immutable.
 
@@ -60,16 +60,16 @@ tests).
 
 ## Run
 
-- [How to run a Wasp node on Pollen](articles/docs/runwasp.md)
-- [Using `wasp-cli` to deploy a chain and a contract](articles/docs/deploy.md)
+- [How to run a Wasp node on Pollen](docs/docs/runwasp.md)
+- [Using `wasp-cli` to deploy a chain and a contract](docs/docs/deploy.md)
 
 ## Learn
 
-- [Exploring IOTA Smart Contracts](articles/tutorial/readme.md)
-- [UTXO ledger and digital assets](articles/intro/utxo.md)
-- [Core types](articles/docs/coretypes.md)
-- [On-chain accounts](articles/docs/accounts.md)
-- [Wasp Publisher](articles/docs/publisher.md)
+- [Exploring IOTA Smart Contracts](docs/tutorial/readme.md)
+- [UTXO ledger and digital assets](docs/intro/utxo.md)
+- [Core types](docs/docs/coretypes.md)
+- [On-chain accounts](docs/docs/accounts.md)
+- [Wasp Publisher](docs/docs/publisher.md)
 
 ## Tools