a free (libre) open source, mobile OS for Ethereum https://status.im
Go to file
Icaro Motta a17efa7299
Make json-rpc/call effect more in line with re-frame standards (#15936)
Changes effect :json/rpc-call to accept on-success and on-error parameters
either as functions OR as re-frame event vectors. The changes are 100% backwards
compatible.

## Why?

Re-frame is very explicit in its documentation and its architecture, saying that
event handlers should be pure. Calling re-frame.core/dispatch in event handlers
makes them sort of stateful.

> So, you can "get away with it". But it ain't pure.
>
> -- https://day8.github.io/re-frame/EffectfulHandlers/#90-solution

In status-mobile, arguably one of our most important effects (not to be confused
with event handlers) is :json-rpc/call, but at the moment, the on-success and
on-error values are expected to be stateful functions (e.g. usually used for
logging and dispatching subsequent events).

This creates two important problems:

1. The value returned by event handlers is more opaque and cannot be easily
   inspected (for example using tap>, log/debug or just println). If we try to
   inspect or log them, on-success and on-error will be printed as
   #object[Function].
2. Testing event handlers using :json-rpc/call becomes an exercise of
   frustration, because we can't simply compare the results of the event handler
   with a good expected value, which is one of the big selling points of testing
   pure functions.

### The testability of event handlers

> For any re-frame app, there's three things to test:
>
> - Event Handlers - most of your testing focus will be here because this is
>   where most of the logic lives
> - Subscription Handlers - often not a lot to test here. Only Layer 3
>   subscriptions need testing.
> - View functions - I don't tend to write tests for views.
>
> -- https://day8.github.io/re-frame/Testing/#what-to-test

So re-frame is saying event handlers should be pure, and that event handlers
should be tested.

In order to achieve the divine simplicity of testing event handlers as pure
functions, we need to make :json-rpc/call also accept on-success and
on-error as event vectors.

Good news is that there is a known pattern to solve this problem, e.g. used by
the library https://github.com/Day8/re-frame-http-fx.

The pattern is simple once we see it: behind the scenes, :json-rpc/call conj'es
the results of the RPC call into the event vectors on-success and on-error, and
:json-rpc/call dispatches the events itself. This eliminates the need for the
stateful dispatch call in event handlers.
2023-05-18 15:56:10 -03:00
.clj-kondo Move unit test helper namespace to `src/test_helpers/` (#14716) 2023-01-05 11:58:37 -03:00
.dependabot [Fixes: #11518] Fix dependabot directory 2020-12-07 12:14:16 +01:00
.github drop unused zenhub github actions workflows 2022-08-01 16:11:38 +02:00
android [#15798] Fix issue with android dev env by disabling flipper 2023-05-04 11:18:14 +02:00
ci ci: fix Alchemy and Infura env vars for iOS 2023-05-16 13:06:37 +02:00
doc Make json-rpc/call effect more in line with re-frame standards (#15936) 2023-05-18 15:56:10 -03:00
fastlane ios: upgrade Cocoapods to 1.12.0, drop ancient fix 2023-03-16 10:24:27 +01:00
ios fix: android blur view hash mismatch in some locations 2023-05-09 21:36:12 +02:00
modules/react-native-status Adapt to status-go backend changes for ConvertToKeycardAccount (#15846) 2023-05-09 20:51:08 +08:00
nix nix: use SRI hashes for Gradle dependencies 2023-05-10 15:45:32 +02:00
resources Design Feedbacks on "Create profile password" screen (#15863) 2023-05-16 18:03:45 +05:30
scripts ci: add Alchemy and Infura credentials in CI 2023-05-10 12:57:04 +02:00
src Make json-rpc/call effect more in line with re-frame standards (#15936) 2023-05-18 15:56:10 -03:00
test Dont check `app-state` for `Android` when evaluating universal links routing (#15896) 2023-05-18 00:20:38 +05:30
test-resources make sure nodejs uses a fixed timezone (#14793) 2023-01-16 16:34:15 +05:30
translations (feat) : add share capabilities in shell (#15782) 2023-05-16 21:57:34 +05:30
visual-test feat: add component tests using react-testing-library and jest (#14331) 2022-11-23 05:59:18 -08:00
.buckconfig upgrade react-native and packages - but broken 2016-04-24 15:07:08 +07:00
.carve_ignore move status native module (#15749) 2023-04-26 18:14:14 +02:00
.detoxrc.js Visual tests setup (#14329) 2022-11-20 15:46:04 -08:00
.dockerignore Create Nix package for building status-go 2019-04-09 12:44:39 +02:00
.env UI for mobile to mobile local pairing - updated (#14514) 2022-12-16 18:40:56 +05:30
.env.e2e UI for mobile to mobile local pairing - updated (#14514) 2022-12-16 18:40:56 +05:30
.env.jenkins UI for mobile to mobile local pairing - updated (#14514) 2022-12-16 18:40:56 +05:30
.env.nightly Enable waku2 by default 2022-12-15 12:39:49 +00:00
.env.release Enable waku2 by default 2022-12-15 12:39:49 +00:00
.envrc Add login integration test 2022-06-08 13:43:32 +01:00
.eslintrc.js Upgrade react-native to 0.60.5 2019-09-12 16:13:42 +02:00
.flowconfig RN 63 and xcode12 2021-01-14 09:41:38 +01:00
.gitattributes Desktop branch merged into develop (#5266) 2018-07-23 18:21:31 +03:00
.gitignore feat: reimplement composer (#15639) 2023-04-24 17:40:15 +04:00
.mailmap fix my name 2019-02-28 14:50:42 +01:00
.nycrc add coverage test 2019-07-10 16:15:44 -04:00
.prettierrc.js feat: add messages gap component (#13860) 2022-09-05 15:58:35 +08:00
.watchmanconfig Ensure shell.nix uses same nixpkgs as the rest of the environment 2019-06-20 09:18:24 -04:00
.zprintrc Fix input padding & add blur and override-theme properties 2023-03-16 12:59:34 -06:00
LICENSE.md Create LICENSE.md 2016-09-21 10:00:44 +08:00
Makefile Allow running debug iOS builds on physical device via CLI and Enable Automatic code signing for Debug builds (#15637) 2023-04-19 16:20:26 +05:30
README.md Document new guidelines (#14309) 2022-11-14 07:15:49 -03:00
RELEASES.md notes: updated release notes 2022-08-29 13:54:45 +02:00
VERSION Bump version to 1.22.0 2023-03-30 17:30:05 +01:00
app.json update react-native and project dependencies 2017-12-15 16:06:13 +01:00
babel.config.js feat: add component tests using react-testing-library and jest (#14331) 2022-11-23 05:59:18 -08:00
binding.gyp Add status-go tests 2022-05-25 17:59:02 +01:00
default.nix nix: minor cleanup and documentation updates 2020-06-05 14:49:34 +02:00
index.js Implement Wallet Connect 2.0 2022-03-17 03:46:38 -03:00
metro.config.js Implement Wallet Connect 2.0 2022-03-17 03:46:38 -03:00
package.json fix: android blur view hash mismatch in some locations 2023-05-09 21:36:12 +02:00
react-native.config.js Implement Wallet Connect 2.0 2022-03-17 03:46:38 -03:00
shadow-cljs.edn Make component test helpers usable from the REPL (#15468) 2023-03-27 11:54:56 -03:00
shell.nix nix: minor cleanup and documentation updates 2020-06-05 14:49:34 +02:00
status-go-version.json fix #15899 : failed to reset password (#15914) 2023-05-18 22:30:27 +08:00
supervisord.conf Add docker-compose for development build 2018-04-11 14:58:38 +01:00
yarn.lock fix: android blur view hash mismatch in some locations 2023-05-09 21:36:12 +02:00

README.md

Status - a Mobile Ethereum Operating System

Get it on Google Play Get it on F-Droid Get it on Github

Join us in creating a browser, messenger, and gateway to a decentralized world. Status is a free (libre) open source mobile client targeting Android & iOS built entirely on Ethereum technologies. That's right, no middle men and go-ethereum running directly on your device.

Getting started with Status

Why?

We believe in a medium of pure free trade, economies with fair, permission-less access and a world without intermediaries. We want to create policies that can exist between friends or scale globally, we want to communicate securely and be uninhibited by legacy systems.

We want to take responsibility for our data, the way we conduct ourselves privately and promote this way of life to a mass audience.

We want deep insights into our own economies so we can make informed, data-driven decisions on how to make our lives better. The Ethereum blockchain, Smart Contracts, Swarm and Whisper provides us a path forward.

If this interests you, help us make Status a reality - anyone can contribute and we need everyone at any skill level to participate.

How to Contribute?

Go straight to the docs or join our chat and choose what interests you:

  • Developer Developers are the heart of software and to keep Status beating we need all the help we can get! If you're looking to code in ClojureScript or Golang then Status is the project for you! We use React Native and there is even some Java/Objective-C too! Want to learn more about it? Start by reading our Developer Introduction which guides you through the technology stack and start browsing beginner issues. Then you can read how to Build Status, which talks about managing project dependencies, coding guidelines and testing procedures. The doc/ directory also has valuable information for contributors.

  • Community Management Metcalfe's law states that the value of a network is proportional to the square of the number of connected users of the system - without community Status is meaningless. We're looking to create a positive, fun environment to explore new ideas, experiment and grow the Status community. Building a community takes a lot of work but the people you'll meet and long lasting relationships you form will be well worth it, check out our Mission and Community Principles

  • Specification / Documentation John Dewey once said "Education is not preparation for life; education is life itself ". Developers & Designers need guidance and it all starts from documentation and specifications. Our software is only as good as its documentation, head over to our docs and see how you can improve what we have.

  • Blog Writing Content is King, keeping our blog up to date and informing the community of news helps keep everyone on the same page. Jump into our chat and discuss with the team how you can contribute!

  • Testers It's bug hunting season! Status is currently under active development and there is sure to be a bunch of learning, build status from scratch or if an android user check out our nightly builds. You can shake your phone to submit bug reports, or start browsing our Github Issues. Every bug you find brings Status closer to stable, usable software for everyone to enjoy!

  • Security Status is a visual interface to make permanent changes on the Blockchain, it handles crypto-tokens that have real value and allows 3rd party code execution. Security is paramount to its success. You are given permission to break Status as hard as you can, as long as you share your findings with the community!

  • Evangelism Help us spread the word! Tell a friend right now, in fact tell everyone - yell from a mountain if you have to, every person counts! If you've got a great story to tell or have some interesting way you've spread the word about Status let us know about it in our chat

Status API

View our API Docs and learn how to integrate your DApp into Status. You can read more about how to add your DApp to Status here.

Give me Binaries!

You can get our Beta builds for both Android and iOS on our website, through our nightly builds or by building it yourself.

Core Contributors

Core Team Members

Special thanks to @adrian-tiberius. Without the dedication of these outstanding individuals, Status would not exist.

Contact us

Feel free to email us at support@status.im or better yet, join our chat.

License

Licensed under the Mozilla Public License v2.0

Testing Supported by

BrowserStack Status