diff --git a/docs/basics/metadata.md b/docs/basics/metadata.md index 0847dd964d..e5425fe450 100644 --- a/docs/basics/metadata.md +++ b/docs/basics/metadata.md @@ -16,16 +16,16 @@ The ink! metadata is generated when a contract is built using `cargo-contract`, `cargo contract build`. The metadata can be found in your contract's target directory under the name -`metadata.json`. +`.json`. :::note -The metadata is also contained in your `$contract_name.contract` file. The difference is +The metadata is also contained in your `.contract` file. The difference is that the `.contract` file also contains the Wasm binary of your contract. ::: -## metadata.json +## `.json` The metadata is defined by the following **required** keys: - `source`: Information about the contract's Wasm code. - `contract`: Metadata about the contract. diff --git a/docs/examples/contracts.md b/docs/examples/contracts.md index 87f50dc700..52bb534949 100644 --- a/docs/examples/contracts.md +++ b/docs/examples/contracts.md @@ -113,7 +113,7 @@ the example and run: cargo contract build ``` -As a result you'll get a file `target/.wasm` file, a `metadata.json` file +As a result you'll get a file `target/.wasm` file, a `.json` file and a `.contract` file in the `target/` folder of your contract. The `.contract` file combines the Wasm and metadata into one file and needs to be used when deploying the contract. diff --git a/docs/examples/dapps.md b/docs/examples/dapps.md index 83d9cd079c..dd4d5144af 100644 --- a/docs/examples/dapps.md +++ b/docs/examples/dapps.md @@ -1,12 +1,37 @@ --- title: Dapps slug: /examples/dapps +hide_title: true --- -Check out link! – a URL shortener DApp. It consists of a frontend and an ink! contract. -You can view an online demo of the Dapp here: https://tiny.ink. + + +# Dapps + +We'll point to a couple full-stack Dapp examples here. +These can serve as inspiration for how to create a frontend for your +smart contract. + +Two popular libraries for building frontends are: + +* [`polkadot-js/api`](https://github.com/polkadot-js/api) a low-level TypeScript API. +* [useInkathon](https://github.com/scio-labs/use-inkathon) a React hooks library. + +## INK!athon + +INK!athon is a f full-stack dApp boilerplate project consisting of +an ink! smart contract and a React frontend using the +[useInkathon](https://github.com/scio-labs/use-inkathon) hooks library. + +## link! + +link! is a URL shortener DApp. It consists of a frontend and an ink! contract. + +link! uses [`polkadot-js/api`](https://github.com/polkadot-js/api) under the hood. +The entire source code (contract + frontend) is located here: +[https://github.com/paritytech/link](https://github.com/paritytech/link). + +You can view an online demo of the Dapp here: [https://tiny.ink](https://tiny.ink). To create new short links you need `ROC` tokens from our testnet. See [here](/testnet) for how to get those. - -The repository is located here: [https://github.com/paritytech/link](https://github.com/paritytech/link). \ No newline at end of file diff --git a/docs/getting-started/cargo-contract.md b/docs/getting-started/cargo-contract.md index 55fb224217..f3f8d6b6d7 100644 --- a/docs/getting-started/cargo-contract.md +++ b/docs/getting-started/cargo-contract.md @@ -59,5 +59,5 @@ cargo contract build As a result you'll get the file `target/flipper.contract`. It's a JSON which bundles the contract's metadata and its Wasm blob. This file needs to be used when deploying the contract. -You additionally get the individual `target/flipper.wasm` and `target/metadata.json` in the folder as well. +You additionally get the individual `target/flipper.wasm` and `target/flipper.json` in the folder as well. diff --git a/docs/getting-started/compiling.md b/docs/getting-started/compiling.md index 3ecfe0a360..a2a73fcd5e 100644 --- a/docs/getting-started/compiling.md +++ b/docs/getting-started/compiling.md @@ -24,10 +24,10 @@ target └─ ink └─ flipper.contract └─ flipper.wasm - └─ metadata.json + └─ flipper.json ``` -Let's take a look at the structure of the `metadata.json`: +Let's take a look at the structure of the `flipper.json`: ```json { diff --git a/docs/intro/ink-vs-solidity.md b/docs/intro/ink-vs-solidity.md index 6476c87963..a2c734d781 100644 --- a/docs/intro/ink-vs-solidity.md +++ b/docs/intro/ink-vs-solidity.md @@ -780,7 +780,7 @@ fn invoke_transaction( ``` -Note: the `function_selector` bytes can be found in the generated `target/ink/metadata.json`. +Note: the `function_selector` bytes can be found in the generated `target/ink/.json`. ## Limitations of ink! v3 diff --git a/i18n/es/docusaurus-plugin-content-docs/current/basics/metadata.md b/i18n/es/docusaurus-plugin-content-docs/current/basics/metadata.md index 6ed46ebcb4..78ae6c9d58 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/basics/metadata.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/basics/metadata.md @@ -14,7 +14,7 @@ Los metadatos ink! son generados cuando un contrato es construido utilizando `ca `cargo contract build`. Los metadatos se pueden encontrar en tu en el directorio de destino de su contrato bajo el nombre -`metadata.json`. +`.json`. :::note @@ -23,7 +23,7 @@ es que el fichero `.contract` también contiene el binario Wasm de tu contrato. ::: -## metadata.json +## .json Los metadatos se definen con las siguietes claves **requeridas**: - `source`: Información sobre el código Wasm. - `contract`: Metadatos sobre el contrato. diff --git a/i18n/es/docusaurus-plugin-content-docs/current/examples/contracts.md b/i18n/es/docusaurus-plugin-content-docs/current/examples/contracts.md index d2fb3dc9fa..05a50e36e0 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/examples/contracts.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/examples/contracts.md @@ -119,7 +119,7 @@ the example and run: cargo contract build ``` -As a result you'll get a file `target/.wasm` file, a `metadata.json` file +As a result you'll get a file `target/.wasm` file, a `.json` file and a `.contract` file in the `target/` folder of your contract. The `.contract` file combines the Wasm and metadata into one file and needs to be used when deploying the contract. diff --git a/i18n/es/docusaurus-plugin-content-docs/current/getting-started/cargo-contract.md b/i18n/es/docusaurus-plugin-content-docs/current/getting-started/cargo-contract.md index 92d65fe960..b4fdf7e5c3 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/getting-started/cargo-contract.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/getting-started/cargo-contract.md @@ -61,5 +61,5 @@ cargo contract build As a result you'll get the file `target/flipper.contract`. It's a JSON which bundles the contract's metadata and its Wasm blob. This file needs to be used when deploying the contract. -You additionally get the individual `target/flipper.wasm` and `target/metadata.json` in the folder as well. +You additionally get the individual `target/flipper.wasm` and `target/flipper.json` in the folder as well. diff --git a/i18n/es/docusaurus-plugin-content-docs/current/getting-started/compiling.md b/i18n/es/docusaurus-plugin-content-docs/current/getting-started/compiling.md index 7764ec76ed..bb7588edb2 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/getting-started/compiling.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/getting-started/compiling.md @@ -21,10 +21,10 @@ target └─ ink └─ flipper.contract └─ flipper.wasm - └─ metadata.json + └─ flipper.json ``` -Vamos a ver la estructura de `metadata.json`: +Vamos a ver la estructura de `flipper.json`: ```json { diff --git a/i18n/es/docusaurus-plugin-content-docs/current/intro/ink-vs-solidity.md b/i18n/es/docusaurus-plugin-content-docs/current/intro/ink-vs-solidity.md index 1561864fd2..f54b9d982a 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/intro/ink-vs-solidity.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/intro/ink-vs-solidity.md @@ -784,7 +784,7 @@ fn invoke_transaction( ``` -Note: the `function_selector` bytes can be found in the generated `target/ink/metadata.json`. +Note: the `function_selector` bytes can be found in the generated `target/ink/.json`. ## Limitations of ink! v3 diff --git a/static/img/matrix-transparent.png b/static/img/matrix-transparent.png deleted file mode 100644 index 0d8fc292e9..0000000000 Binary files a/static/img/matrix-transparent.png and /dev/null differ diff --git a/static/img/title/metadata.svg b/static/img/title/metadata.svg index eb515975c8..8e79c39ab7 100644 --- a/static/img/title/metadata.svg +++ b/static/img/title/metadata.svg @@ -288,67 +288,6 @@ - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +