Sapphire ParaTime

The Sapphire ParaTime is the official confidential EVM Compatible ParaTime providing a smart contract development environment with EVM compatibility on the Oasis Network.

This monorepo includes the source code for the following Sapphire packages:

Sub-Project	Version	Size	Downloads
TypeScript
Go
Solidity
Hardhat
Ethers 6.x
Wagmi 2.x
Viem 2.x

Layout

This repository includes all relevant Sapphire and dependencies organized into the following directories:

• clients: the Go, Python and JavaScript/TypeScript clients
• contracts: Sapphire and OPL smart contracts
• docs: topic-oriented Sapphire documentation
• examples: sample code snippets in popular Ethereum development environments
• integrations: plugins for popular Ethereum SDKs
• runtime: the Sapphire Paratime as based off of the Oasis SDK

Documentation

The Sapphire documentation is deployed as part of the official Oasis documentation. To make changes visible on the docs website:

1. Merge any changes in the docs folder to the main branch.
2. Bump the git commit reference of the Sapphire submodule inside the external directory of the Oasis docs repository (you can simply approve the auto-generated dependabot's submodule bump PR).
3. Merge changes into Oasis docs repository main branch. CI will deploy the docs to the website automatically.

Note: If you want to introduce a new markdown file, you will need to add it to the Oasis documentation's sidebar. If you remove any chapters, don't forget to define sensible redirects. For more info on how to write the Oasis documentation, manage images and diagrams, reference cross-repo markdown files and similar consult the official README.

The API documentation is auto-generated from the corresponding Sapphire clients and libraries. It is deployed at:

• https://api.docs.oasis.io/js/sapphire-paratime/
• https://api.docs.oasis.io/sol/sapphire-contracts/

The API docs are generated automatically every 15 minutes from the main branch.

Release

Clients & Integrations

JS libraries should be updated with a version bump in the package.json file and a respective tag in the pattern of {{path}}/v{{semver}}, such as clients/js/v1.1.1.

This repository allows the use of alpha, beta, and next releases for NPM packages, but prefers a linear upgrade path when possible from latest to next. such as integrations/hardhat/v2.22.2-next. While we prefer the use of CI and e2e testing such as dAppwright, this may not be possible for all supported use cases. When releasing a new version of a package, seek to upgrade demo- repos to the release version, and test both demo- dapps and this repository's examples against the to be released package with commonly used browser wallets such as Rabby, MetaMask, and Brave.

Contributing

Developers are encouraged to contribute their improvements to the Sapphire Paratime through this repository. Open a pull request and one of the Oasis Protocol Foundation members will check it out and get back to you!

See our Contributing Guidelines.

Build

Oasis remains committed to unlocking the full potential of privacy applications on Web3.

Build with us today!

License

This software is licensed under Apache 2.0.

The content of the documentation (the /docs folder) including the media (e.g. images and diagrams) is licensed under Creative Commons Attribution 4.0 International.