search

oasisprotocol / sapphire-paratime

Oasis Sapphire - the confidential EVM-compatible ParaTime for the Oasis Network
https://oasisprotocol.org/sapphire
Apache License 2.0
39 stars 27 forks source link

Rename repository to sapphire #353

Open tjanez opened 3 months ago

tjanez commented 3 months ago

It would make sense to rename this monorepo from "sapphire-paratime" to just "sapphire" (i.e. https://github.com/oasisprotocol/sapphire-paratime/ -> https://github.com/oasisprotocol/sapphire/) and call the product Oasis Sapphire. Then in the text, where appropriate, it can be shortened to just Sapphire.

The thing that would be still be called Sapphire ParaTime would be the actual runtime inside the runtime/ directory.

We would need to go through the code in the repo and see where we need to rename things from sapphire-paratime to sapphire and where they should stay sapphire-paratime.

aefhm commented 3 months ago

Very much agree with the rename.

matevz commented 2 months ago

I am slightly against breaking the -paratime convention for the runtime repos. But we could split the sapphire-paratime repo into:

If monorepos are a bad idea, we could have more of those:

aefhm commented 2 months ago

I am slightly against breaking the -paratime convention for the runtime repos. But we could split the sapphire-paratime repo into:

  • sapphire-paratime: just the runtime, same format as cipher-paratime, emerald-paratime, keymanager-paratime, pontusx-paratime etc.
  • sapphire-sdk: everything else (clients, contracts, docs, examples)

➕ to the split preserving the monorepo for al the clients and tooling. I'm cool with a separate sapphire-paratime repo or embedded in the monorepo.

tjanez commented 2 months ago

I am slightly against breaking the -paratime convention for the runtime repos. But we could split the sapphire-paratime repo into:

  • sapphire-paratime: just the runtime, same format as cipher-paratime, emerald-paratime, keymanager-paratime, pontusx-paratime etc.
  • sapphire-sdk: everything else (clients, contracts, docs, examples)

Yes, that is also a good idea.

I would suggest:

If monorepos are a bad idea, we could have more of those:

  • sapphire-paratime
  • sapphire-contracts
  • sapphire-client-js (monorepo also containing hardhat, viem, wagmi and examples)
  • sapphire-client-py
  • sapphire-client-go
  • sapphire-docs

I see something like this possible in the future. Another naming convention for the "clients" could be:

kostko commented 2 months ago

Another important thing to consider is the runtime releases which are linked from various places and should remain valid at all times.