Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Oasis branding #335

Merged
merged 7 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,4 @@ yarn-error.log*
__pycache__/

# Ignore build releases.
oasis-wallet-*.zip
rose-wallet-*.zip
oasis-rose-wallet-*.zip
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ all: build

# Build.
build:
@$(ECHO) "$(MAGENTA)*** Building ROSE Wallet Browser Extension...$(OFF)"
@$(ECHO) "$(MAGENTA)*** Building Oasis ROSE Wallet Browser Extension...$(OFF)"
@yarn buildProd

# Lint code, commits and documentation.
Expand Down
36 changes: 16 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ROSE Wallet - Browser Extension
# Oasis ROSE Wallet - Browser Extension

[![CI lint status][github-ci-lint-badge]][github-ci-lint-link]

Expand All @@ -11,7 +11,7 @@ The official non-custodial browser extension wallet for the [Oasis Network].

## Introduction

ROSE Wallet - Browser Extension provides a complete solution for managing your
Oasis ROSE Wallet - Browser Extension provides a complete solution for managing your
ROSE tokens, including everything for convenient staking of your ROSE tokens.

## Features
Expand All @@ -24,7 +24,7 @@ ROSE tokens, including everything for convenient staking of your ROSE tokens.
- Import accounts directly from their private keys
- Watch 3rd-party accounts
- Address book of your saved accounts
- Easily switch between different Oasis wallets that use the same [ADR 0008]
- Easily switch between different Oasis ROSE wallets that use the same [ADR 0008]
standard account key generation process.

### Transactions
Expand All @@ -49,32 +49,29 @@ ROSE tokens, including everything for convenient staking of your ROSE tokens.
The extension is roughly laid out this way:

- background - the extension's background page
- APIService (wallet info storage, in-memory transaction signing, transaction submission)
- ExtDAppService (DApp interface, handles requests from xu-frame)
- APIService (wallet info storage, in-memory transaction signing, transaction submission)
- ExtDAppService (DApp interface, handles requests from xu-frame)

- service-data - connections to the network and block explorer
- OASISSCAN (provided by [oasisscan](https://api.oasisscan.com/mainnet))
- Oasis gRPC-web (provided by [oasisscan-grpc](https://grpc-mainnet.oasisscan.com))
- OASISSCAN (provided by [oasisscan](https://api.oasisscan.com/mainnet))
- Oasis gRPC-web (provided by [oasisscan-grpc](https://grpc-mainnet.oasisscan.com))

- popup - interactive parts
- pages (UI, Ledger transaction signing)
- actions (reducer action)
- reducer
- pages (UI, Ledger transaction signing)
- actions (reducer action)
- reducer

- xu-frame - a page that DApps can load in an iframe to communicate with this extension
- code for this page is in background/ExtUtils.js
- Oasis SDK ext-utils handlers
- code for this page is in background/ExtUtils.js
- Oasis SDK ext-utils handlers

[![Architecture Diagram](./docs/oasis-nomnoml.png)][1]




## Getting started

### build extension

ROSE Wallet extension repo uses git-secret to encrypt the endpoints and the api keys. So, you can't build this without creating your own config file. You should create your own `config.js` file in the folder. Refer to the `config.example.js` sample file to create your own configuration.
Oasis ROSE Wallet extension repo uses git-secret to encrypt the endpoints and the api keys. So, you can't build this without creating your own config file. You should create your own `config.js` file in the folder. Refer to the `config.example.js` sample file to create your own configuration.

```sh
yarn install
Expand All @@ -85,11 +82,10 @@ yarn dev

Extension's build output is placed in `/dist`, and you can check out [this page](https://developer.chrome.com/extensions/getstarted) for installing the developing extension.


### dapp-connect test

* open [oasis-test-dapp](https://lukaw3d.github.io/oasis-test-dapp)
* click connect and other button to communicate with wallet
- open [oasis-test-dapp](https://lukaw3d.github.io/oasis-test-dapp)
- click connect and other button to communicate with wallet

## CI pipelines (Coming soon)

Expand All @@ -107,7 +103,7 @@ COMMIT=`git rev-parse --short HEAD`
rm -rf dist/
yarn install --frozen-lockfile
yarn buildProd
zip -r rose-wallet-$VERSION-$COMMIT.zip dist/
zip -r oasis-rose-wallet-$VERSION-$COMMIT.zip dist/
```

If you're actually making a new release, follow the applicable steps in the
Expand Down
2 changes: 1 addition & 1 deletion config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* ROSE Wallet - Browser Extension's configuration.
* Oasis ROSE Wallet - Browser Extension's configuration.
*
* NOTE: If you intend to build a custom version of the extension, edit this
* file appropriately and rebuild the extension.
Expand Down
17 changes: 12 additions & 5 deletions docs/release-process.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Release Process

## Determine the New Version

Extension versions may not have suffixes like "-rc1".
We are incrementing patch versions to differentiate release candidate builds.

Expand All @@ -11,12 +12,14 @@ Version 1.0.1 is also a release candidate at first.
If no changes are needed, 1.0.1 becomes the first public release of 1.0.

## Set the New Version Throughout

You must update:

- `package.json`
- `public/manifest.json`

## Add a Change Log Section

Here's the [Change Log](../CHANGELOG.md).

If there is an "Unreleased Changes" section, rename it to the new version.
Expand All @@ -37,6 +40,7 @@ We especially encourage linking externally reported issues.
If you feel like it, move one Change Log item to a section on top titled "Spotlight change".

## Propose the New Version

Commit the version changes and Change Log update with a message in the format
`Prepare release <VERSION>`, ideally separate from any other changes.

Expand All @@ -56,23 +60,25 @@ git push origin v$VERSION
```

## Prepare an Unsigned Archive

Clean the output directory, build, and package:

```sh
VERSION=`cat public/manifest.json | jq .version -r`
rm -rf dist/
yarn install --frozen-lockfile
yarn buildProd
zip -r rose-wallet-$VERSION.zip dist/
zip -r oasis-rose-wallet-$VERSION.zip dist/
```

Note: The zip file has no Git commit hash.

## Add a Pre-Release on GitHub

Create a tag and create a
[new release](https://github.com/oasisprotocol/oasis-wallet-ext/releases/new) on GitHub.

Enter `ROSE Wallet <VERSION> Release Candidate` for the title.
Enter `Oasis ROSE Wallet <VERSION> Release Candidate` for the title.

Our Change Log is a file under version control, so all we do is put the link in the description:

Expand All @@ -92,16 +98,17 @@ _This step is for our web store account admins._
_Contact an admin if you don't have access._

Go to [Chrome Web Store Developer Dashboard](https://chrome.google.com/webstore/devconsole/),
browse to the _ROSE Wallet_ item,
browse to the _Oasis_ROSE Wallet_ item,
select _Package_ in the side bar and
choose _Upload new package_.

## Update GitHub Pre-Release

Change the title:

```diff
-ROSE Wallet <VERSION> Release Candidate
+ROSE Wallet <VERSION>
-Oasis ROSE Wallet <VERSION> Release Candidate
+Oasis ROSE Wallet <VERSION>
```

Change the description:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@oasisprotocol/rose-wallet-ext",
"name": "@oasisprotocol/oasis-rose-wallet-ext",
"version": "1.13.0",
"private": true,
"scripts": {
Expand Down
Binary file modified public/static/img/oasis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion public/static/popup.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>ROSE Wallet</title>
<title>Oasis ROSE Wallet</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
Expand Down
29 changes: 29 additions & 0 deletions src/assets/images/Rose Wallet Logo Blue cropped.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/assets/images/accountEnter_hover.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/assets/images/accountEnter_normal.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/assets/images/blueArrow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading