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

[WIP] Integrate Portis as a web3 provider #985

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all 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
202 changes: 202 additions & 0 deletions app/assets/v2/js/portis.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
'use strict';
const postMessages = {
PT_RESPONSE: 'PT_RESPONSE',
PT_HANDLE_REQUEST: 'PT_HANDLE_REQUEST',
PT_AUTHENTICATED: 'PT_AUTHENTICATED',
PT_SHOW_IFRAME: 'PT_SHOW_IFRAME',
PT_HIDE_IFRAME: 'PT_HIDE_IFRAME',
PT_USER_DENIED: 'PT_USER_DENIED'
};
var Provider = /** @class */ (function() {
function Provider(opts) {
if (opts === void 0) {
opts = {};
}
this.requests = {};
this.queue = [];
this.authenticated = false;
this.account = null;
this.network = null;
this.isPortis = true;
this.referrerAppOptions = {
network: opts.network || 'ropsten',
appHost: location.host,
appName: opts.appName,
appLogoUrl: opts.appLogoUrl,
portisLocation: opts.portisLocation || 'https://app.portis.io'
};
this.iframe = this.createIframe();
this.listen();
}
Provider.prototype.sendAsync = function(payload, cb) {
this.enqueue(payload, cb);
};
Provider.prototype.send = function(payload) {
var result;

switch (payload.method) {
case 'eth_accounts':
var account = this.account;

result = account ? [account] : [];
break;
case 'eth_coinbase':
result = this.account;
break;
case 'net_version':
result = this.network;
break;
case 'eth_uninstallFilter':
this.sendAsync(payload, function(_) {
return _;
});
result = true;
break;
default:
throw new Error('The Portis Web3 object does not support synchronous methods like ' + payload.method + ' without a callback parameter.');
}
return {
id: payload.id,
jsonrpc: payload.jsonrpc,
result: result
};
};
Provider.prototype.isConnected = function() {
return true;
};
Provider.prototype.createIframe = function() {
var iframe = document.createElement('iframe');
var iframeStyleProps = {
'position': 'fixed',
'top': '20px',
'right': '20px',
'height': '525px',
'width': '390px',
'z-index': '2147483647',
'margin-top': '0px',
'transition': 'margin-top 0.7s',
'box-shadow': 'rgba(0, 0, 0, 0.1) 7px 10px 60px 10px',
'border-radius': '3px',
'border': '1px solid #565656',
'display': 'none'
};
var iframeMobileStyleProps = {
'width': '100%',
'height': '100%',
'top': '0',
'left': '0',
'right': '0',
'border': 'none',
'border-radius': '0'
};

Object.keys(iframeStyleProps).forEach(function(prop) {
return (iframe.style[prop] = iframeStyleProps[prop]);
});
iframe.scrolling = 'no';
if (this.isMobile()) {
Object.keys(iframeMobileStyleProps).forEach(function(prop) {
return (iframe.style[prop] = iframeMobileStyleProps[prop]);
});
}
iframe.id = 'PT_IFRAME';
iframe.src = this.referrerAppOptions.portisLocation + '/send/?p=' + btoa(JSON.stringify(this.referrerAppOptions));
document.body.appendChild(iframe);
return iframe;
};
Provider.prototype.showIframe = function() {
this.iframe.style.display = 'block';
if (this.isMobile()) {
document.body.style.overflow = 'hidden';
}
};
Provider.prototype.hideIframe = function() {
this.iframe.style.display = 'none';
if (this.isMobile()) {
document.body.style.overflow = 'inherit';
}
};
Provider.prototype.enqueue = function(payload, cb) {
this.queue.push({ payload: payload, cb: cb });
if (this.authenticated) {
this.dequeue();
} else if (this.queue.length == 1) {
// show iframe in order to authenticate the user
this.showIframe();
}
};
Provider.prototype.dequeue = function() {
if (this.queue.length == 0) {
return;
}
var _a = this.queue.shift();
var payload = _a.payload;
var cb = _a.cb;

this.sendPostMessage(postMessages.PT_HANDLE_REQUEST, payload);
this.requests[payload.id] = { payload: payload, cb: cb };
this.dequeue();
};
Provider.prototype.sendPostMessage = function(msgType, payload) {
this.iframe.contentWindow.postMessage({ msgType: msgType, payload: payload }, '*');
};
Provider.prototype.listen = function() {
var _this = this;

window.addEventListener('message', function(evt) {
if (evt.origin === _this.referrerAppOptions.portisLocation) {
switch (evt.data.msgType) {
case postMessages.PT_AUTHENTICATED: {
_this.authenticated = true;
_this.dequeue();
break;
}
case postMessages.PT_RESPONSE: {
let id = evt.data.response.id;

_this.requests[id].cb(null, evt.data.response);
if (_this.requests[id].payload.method === 'eth_accounts' || _this.requests[id].payload.method === 'eth_coinbase') {
_this.account = evt.data.response.result[0];
}
if (_this.requests[id].payload.method === 'net_version') {
_this.network = evt.data.response.result;
}
_this.dequeue();
break;
}
case postMessages.PT_SHOW_IFRAME: {
_this.showIframe();
break;
}
case postMessages.PT_HIDE_IFRAME: {
_this.hideIframe();
break;
}
case postMessages.PT_USER_DENIED: {
let id = evt.data.response ? evt.data.response.id : null;

if (id) {
_this.requests[id].cb(new Error('User denied transaction signature.'));
} else {
_this.queue.forEach(function(item) {
return item.cb(new Error('User denied transaction signature.'));
});
}
_this.dequeue();
break;
}
}
}
}, false);
};
Provider.prototype.isMobile = function() {
var check = false;

(function(a) {
if (/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i.test(a) || (/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i).test(a.substr(0, 4)))

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary escape character: -. (no-useless-escape)

check = true;
})(navigator.userAgent || navigator.vendor || window.opera);
return check;
};
return Provider;
}());
24 changes: 24 additions & 0 deletions app/assets/v2/js/shared.js
Original file line number Diff line number Diff line change
Expand Up @@ -558,6 +558,30 @@ var randomElement = function(array) {
return array[randomIndex];
};

var loginPortis = function() {
web3 = new Web3(new Provider({ network: 'mainnet' }));
web3.eth.getAccounts(_ => _);
return false;
};

var unlockPortis = function() {
web3.eth.getAccounts(_ => _);
return false;
};

var usePortis = function() {
if (typeof Web3 === 'undefined') {
var web3script = document.createElement('script');

web3script.setAttribute('src', 'https://cdn.jsdelivr.net/gh/ethereum/web3.js/dist/web3.min.js');
web3script.onload = loginPortis;
document.body.appendChild(web3script);
} else {
loginPortis();
}
return false;
};

var mixpanel_track_once = function(event, params) {
if (document.listen_for_web3_iterations == 1 && mixpanel) {
mixpanel.track(event, params);
Expand Down
2 changes: 1 addition & 1 deletion app/dashboard/templates/shared/no_metamask_error.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h3>{% trans "Please Enable Metamask to Continue." %}</h3>
href="https://github.com/gitcoinco/gitcoinco/issues/4">Can't get web3 to work? Get help here.</a>{% endblocktrans %}
</p>
<p>
{% blocktrans %}The fastest and easiest way to add Web3 to your browser is to install <a target="_blank" rel="noopener noreferrer" href="https://metamask.io/?utm_source=gitcoin.co&utm_medium=referral">Metamask</a>. To continue submitting a bounty, please install Metamask and return to this page.{% endblocktrans %}
{% blocktrans %}The fastest and easiest way to add Web3 to your browser is to install <a target="_blank" rel="noopener noreferrer" href="https://metamask.io/?utm_source=gitcoin.co&utm_medium=referral">Metamask</a> or <a rel="noopener noreferrer" href="#" onClick="return usePortis();">use Portis</a>. To continue submitting a bounty, please install Metamask and return to this page.{% endblocktrans %}
</p>
</div>
<div class="col-lg-2 col-sm-12">
Expand Down
4 changes: 4 additions & 0 deletions app/faucet/templates/shared/faucet_no_metamask_error.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ <h3>{% trans "To continue, enable Web3." %}</h3>
<br>
- {% trans "or" %} -
<br>
<a class="btn btn-sm btn-info mt-3 pulseClick" role="button" href="#" onClick="return usePortis();">{% trans "Use Portis" %}</a>
<br>
- {% trans "or" %} -
<br>
<a href="https://github.com/gitcoinco/gitcoinco/issues/4" target="_blank" rel="noopener noreferrer">{% trans "Can't get web3 to work? Get help here." %}</a>
</p>
</div>
1 change: 1 addition & 0 deletions app/retail/templates/shared/footer_scripts.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
<script src="{% static "v2/js/note.js" %}"></script>
<script src="{% static "v2/js/pages/carousel.js" %}"></script>
<script src="{% static "cookielaw/js/cl.js" %}"></script>
<script src="{% static "v2/js/portis.js" %}"></script>

<script>
var ipfsConfig = {
Expand Down