From 8431b2ceea16bb2a6409231283c16f92c35cbf11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niels=20M=C3=BCndler?= Date: Sun, 19 Mar 2023 13:14:47 +0100 Subject: [PATCH] Rename eopsin to opshin --- docs/smart-contracts/{eopsin.md => opshin.md} | 28 ++++++++++-------- docs/smart-contracts/overview.md | 4 +-- sidebars.js | 2 +- src/data/builder-tools.js | 6 ++-- .../builder-tools/{eopsin.png => opshin.png} | Bin 5 files changed, 21 insertions(+), 19 deletions(-) rename docs/smart-contracts/{eopsin.md => opshin.md} (63%) rename src/data/builder-tools/{eopsin.png => opshin.png} (100%) diff --git a/docs/smart-contracts/eopsin.md b/docs/smart-contracts/opshin.md similarity index 63% rename from docs/smart-contracts/eopsin.md rename to docs/smart-contracts/opshin.md index 6742e89baf..e3aeae9faa 100644 --- a/docs/smart-contracts/eopsin.md +++ b/docs/smart-contracts/opshin.md @@ -1,41 +1,41 @@ --- -id: eopsin -title: eopsin -sidebar_label: eopsin -description: eopsin -image: ../img/logo-eopsin.png +id: opshin +title: opshin +sidebar_label: opshin +description: opshin +image: ../img/logo-opshin.png --- ## Introduction -[eopsin](https://github.com/ImperatorLang/eopsin) is a programming language for developing smart contracts on the Cardano blockchain. +[opshin](https://github.com/OpShin/opshin) is a programming language for developing smart contracts on the Cardano blockchain. Its syntax is 100% valid Python code and it ensures that contracts evaluate on-chain exactly as their Python counterpart. This allows unit tests and verification of the Python code using standard tooling available for Python development. Existing IDEs, linters and language servers may be re-used as well. -Note that the type system of eopsin is much stricter than the type system of Python, so that many optimizations can be implemented and an elevated level of security is provided. +Note that the type system of opshin is much stricter than the type system of Python, so that many optimizations can be implemented and an elevated level of security is provided. The language interacts closely with the python library [pycardano](https://pycardano.readthedocs.io/en/latest/index.html). The internal data structures are defined with data types compatible to the library and allow a tight combination of off- and on-chain code, all written in Python. :::caution -eopsin is a still a work in progress and is NOT recommended for use in production. +opshin is a still a work in progress and is NOT recommended for use in production. ::: ## Getting started -A short tutorial on getting started with eopsin may be found on [its GitHub page](https://github.com/ImperatorLang/eopsin). -Additionally, a tutorial demonstrating how to write matching off-chain code for eopsin contracts can be found in the [pycardano documentation](https://pycardano.readthedocs.io/en/latest/guides/plutus.html). +A tutorial on getting started with opshin may be found on [its GitHub page](https://github.com/OpShin/opshin). +Additionally, a tutorial demonstrating how to write matching off-chain code for opshin contracts can be found in the [pycardano documentation](https://pycardano.readthedocs.io/en/latest/guides/plutus.html). ### Example contract -This is a basic validator written in eopsin: +This is a basic validator written in opshin: ```python -from eopsin.prelude import * +from opshin.prelude import * @dataclass() class CancelDatum(PlutusData): @@ -52,6 +52,8 @@ def validator(datum: CancelDatum, redeemer: None, context: ScriptContext) -> Non ## Links -- [eopsin Github Repository](https://github.com/ImperatorLang/eopsin). +- [opshin Github Repository](https://github.com/OpShin/opshin). +- [opshin pioneer program](https://github.com/OpShin/opshin-pioneer-program) +- [opshin example project](https://github.com/OpShin/opshin-example) - [pycardano Smart Contract documentation](https://pycardano.readthedocs.io/en/latest/guides/plutus.html). diff --git a/docs/smart-contracts/overview.md b/docs/smart-contracts/overview.md index 9b308ec44c..c1015b3707 100644 --- a/docs/smart-contracts/overview.md +++ b/docs/smart-contracts/overview.md @@ -24,8 +24,8 @@ In another world, you'd like to build programs, possibly even replace a major co - The smart contract is a piece of code that allows a decentralized system to operate. ## Programming languages -- [Marlowe](marlowe) - a domain-specific language, it covers the world of financial contracts. - [Aiken](aiken) - for on-chain validator scripts only: a language & toolchain favouring developer experience. +- [Marlowe](marlowe) - a domain-specific language, it covers the world of financial contracts. +- [opshin](opshin) - a programming language for generic Smart Contracts based on Python. - [Plutus](plutus) - a platform to write full applications that interact with the Cardano blockchain. -- [eopsin](eopsin) - a programming language for generic Smart Contracts based on Python. diff --git a/sidebars.js b/sidebars.js index e5beac4336..16bab4a144 100644 --- a/sidebars.js +++ b/sidebars.js @@ -98,7 +98,7 @@ module.exports = { "smart-contracts/marlowe", "smart-contracts/plutus", "smart-contracts/aiken", - "smart-contracts/eopsin", + "smart-contracts/opshin", ], "Be Part of the Governance": [ "governance/overview", diff --git a/src/data/builder-tools.js b/src/data/builder-tools.js index d56d23f418..86b33cfb46 100644 --- a/src/data/builder-tools.js +++ b/src/data/builder-tools.js @@ -940,11 +940,11 @@ export const Showcases = [ tags: ["operatortool", "cli"], }, { - title: "eopsin", + title: "opshin", description: "A simple pythonic programming language for Smart Contracts on Cardano.", - preview: require("./builder-tools/eopsin.png"), - website: "https://github.com/ImperatorLang/eopsin", + preview: require("./builder-tools/opshin.png"), + website: "https://github.com/OpShin/opshin", getstarted: null, tags: ["python", "cli", "plutus"], }, diff --git a/src/data/builder-tools/eopsin.png b/src/data/builder-tools/opshin.png similarity index 100% rename from src/data/builder-tools/eopsin.png rename to src/data/builder-tools/opshin.png