Skip to content

Commit

Permalink
Fix brave/brave-ios#7779: Support EIP-6963 (brave/brave-ios#8034)
Browse files Browse the repository at this point in the history 
* Update `isBraveWallet`, `request`, `isConnected`, `enable`, `sendAsync` to be non-writable.

* Support EIP-6963

* Use `braveEthereum` as EIP-6963 provider. Freeze announce provider event.

* Use secure copy of `dispatchEvent` & `addEventListener`.

* `window.dispatchEvent` and `window.AddEventListener` are re-initialized by WebKit when deleted. Delete `window.dispatchEvent` and `window.AddEventListener` before use in `$.dispatchEvent` / `$.addEventListener` to guarantee original functions.
  • Loading branch information
@StephenHeaps
StephenHeaps authored Sep 19, 2023
1 parent f5a1521 commit 6997180
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 31 deletions.
14 changes: 7 additions & 7 deletions Sources/Brave/Frontend/Browser/UserScriptManager.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,12 @@ class UserScriptManager {
func fetchWalletScripts(from braveWalletAPI: BraveWalletAPI) {
if let ethJS = braveWalletAPI.providerScripts(for: .eth)[.ethereum] {
let providerJS = """
window.__firefox__.execute(function($, $Object) {
if (window.isSecureContext) {
\(ethJS)
}
});
"""
window.__firefox__.execute(function($, $Object) {
if (window.isSecureContext) {
\(ethJS)
}
});
"""
walletEthProviderScript = WKUserScript(
source: providerJS,
injectionTime: .atDocumentStart,
Expand Down Expand Up @@ -302,7 +302,7 @@ class UserScriptManager {

// Inject ethereum provider
scriptController.addUserScript(script)

if let walletEthProviderScript = walletEthProviderScript {
scriptController.addUserScript(walletEthProviderScript)
}
Expand Down
105 changes: 81 additions & 24 deletions ...end/UserContent/UserScripts/Scripts_Dynamic/Scripts/Paged/WalletEthereumProviderScript.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,24 +30,55 @@ if (window.isSecureContext) {
}));
}

const provider = {
value: {
chainId: undefined,
networkVersion: undefined,
selectedAddress: undefined,
isMetaMask: true,
isBraveWallet: true,
request: $(function (args) /* -> Promise<unknown> */ {
const provider = {value: {}};
$Object.defineProperty(window, 'ethereum', provider);
$Object.defineProperty(window, 'braveEthereum', provider);
// When using `$Object.defineProperties` & setting `writable: false` we cannot
// update properties using `evaluateSafeJavaScript` / `updateEthereumProperties`.
// `chainId`, `networkVersion`, `selectedAddress` differ from desktop (are
// writable) because need to update in `updateEthereumProperties`
$Object.defineProperties(window.ethereum, {
chainId: {
value: undefined,
writable: true, // writable so `updateEthereumProperties()` can update.
},
networkVersion: {
value: undefined,
writable: true, // writable so `updateEthereumProperties()` can update.
},
selectedAddress: {
value: true,
writable: true, // writable so `updateEthereumProperties()` can update.
},
isBraveWallet: {
value: true,
writable: false,
},
isMetaMask: {
value: true,
writable: true, // https://github.com/brave/brave-browser/issues/22213
},
request: {
value: $(function (args) /* -> Promise<unknown> */ {
return post('request', args)
}),
isConnected: $(function() /* -> bool */ {
writable: false,
},
isConnected: {
value: $(function() /* -> bool */ {
return true;
}),
enable: $(function() /* -> void */ {
writable: false
},
enable: {
value: $(function() /* -> void */ {
return post('enable', {})
}),
// ethereum.sendAsync(payload: JsonRpcRequest, callback: JsonRpcCallback): void;
sendAsync: $(function(payload, callback) {
writable: false,
},
// ethereum.sendAsync(payload: JsonRpcRequest, callback: JsonRpcCallback): void;
sendAsync: {
value: $(function(payload, callback) {
post('sendAsync', payload)
.then((response) => {
callback(null, response)
Expand All @@ -56,12 +87,15 @@ if (window.isSecureContext) {
callback(response, null)
})
}),
/*
Available overloads for send:
ethereum.send(payload: JsonRpcRequest, callback: JsonRpcCallback): void;
ethereum.send(method: string, params?: Array<unknown>): Promise<JsonRpcResponse>;
*/
send: $(function(
writable: false,
},
/*
Available overloads for send:
ethereum.send(payload: JsonRpcRequest, callback: JsonRpcCallback): void;
ethereum.send(method: string, params?: Array<unknown>): Promise<JsonRpcResponse>;
*/
send: {
value: $(function(
methodOrPayload /* : string or JsonRpcRequest */,
paramsOrCallback /* : Array<unknown> or JsonRpcCallback */
) {
Expand Down Expand Up @@ -89,13 +123,36 @@ if (window.isSecureContext) {
}
}
}),
isUnlocked: $(function() /* -> Promise<boolean> */ {
return post('isUnlocked', {})
}),
writable: true, // https://github.com/brave/brave-browser/issues/25078
},
});

let uuid = crypto.randomUUID();
if (!uuid) {
return
}
function announceProvider() {
const info = {
walletId: "com.brave.wallet",
rdns: "com.brave.wallet",
uuid: uuid,
name: "Brave Wallet",
icon: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADimHc4AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAA0NSURBVHgB7VxtjB1VGX6n8YcChaJBtJTsbjFR22C/Kf7Q3i2hP+iPbiNVW7G7rfEjNmEXjU1MSO/dQiVShS4JiD/Y7m1iUUsoVZAEaPduMBFB221MK0Zwd2Otlia0Cy1/bHd8nznnzLwzd+7du5ucOXfrPMnsfH/s+5zzfp5zPZ9BOZxhFuVwipwAx8gJcIycAMfICXCMnADHyAlwjJwAx8gJcIycAMfICXCMnADHyAlwjJwAx8gJcIycAMfICXCMD1Ez4oPzRLvXE50dJZrweOFjl7lwdxlrL9q+RNF6Qm/L4xP6eXd2EO14lJoRzUnAwH1EJ4eIgmqppwXqK+Ff8tX+JS869l+Kk2IIuGye10d03Ryi7iI1G5qPgGd6iSoD8WOeXkgT4pnjniaJqq83G+b8npJaNxkJzWUDDrDwf12iUIK+J06aY6SE6om1J87JNZlzvjoGEp4pUzPBa5pRES+wmij3qG3d0EOEet2oIK1+LnnCDpjjeluqoOQzXzhGtGAxNQPc9ICzY2oxGB3WwtcSkipEwrQVTzZ1vXj6eNArPNF7Up65sZ3o1KjafY8N/qkxtXaA7HoAPJonthCNDCsvJ9DPvJq/iOgdPndhPCFv8VnSswkNbbI3UNRD5PUBvOh5ZnNem9o/NRJdc+11RGs6lJ2Y10pZIBsC0MJ7VxNdhOCNLhA6wehyieCrtMENPRzhBSU9nqptuK/6HaZXJN9t7IiBueYmJufpI5mQYF8FBcLnLn/xHMUFMIti6iOAUBtGpZiWKw2yMbqe8YiSasbcK4/Ld2v4ifea1/1rlGjTaqWaLMNuDxg9roUvWz6pbU+roOR29GnR/oT0/3n5MPv0rWxE5y9WwdabTPLrlXRjbexF6juI4qwJknA9esB+uz3BHgHQ+VA770DHCsGr14p9/Q93cqR6QyvR2HHVa2AXxobVZRAshH4zC/yOTqLPs56+Zk78faf5+jcqRAfLRH+oRNExAAGuLCjPZ14LB3n83L7eKI6Qbmzo3upzuPfpQWsk2CNg+xLVAwKk6P0QfGxDkZdS+nNGNAkfbyW6eg41hPe5x50YVkKrJbidHG3v7Yu+QSIWV/jKMP/8INmAPRuwokPsJA0gUahwV6yvLXygbbFaGhU+MJuvvb1Qv9X2MOkLFolAzqtuG8a+3NlBtmCvB0Dvb/lotachybiB1UGxwq27hZwAscDaZRwDvEtVXpER/k2tRK/+g2zBXg9Ai11YiNxJMmtBRmnQnfAB9JDdT1H4Xb4w2CZOuX0V2YRdN/QqDmyqDK/+5zbsUEbXNaDft3ZTKIowwafd42unoPqmAbte0Lb5eidhfFesI/qBMGpQV8iCXhxX92EJbuP7PtZG1MK6+jYW1K0NtEYY4DfZ+L/yHHtDQ0TndIoBgkSkiyALuj8QugbSEBvZY/vrMIWJOwBkzOZ7jp8jW7BHAFLKSD3EdKvR+4PKq5GA0E9UVEY0IGCWusfk/OGKfoSFuJLJ+86j6W5okd93goU/Pi7u86N3Q53AoN7dWd2y4ZquXaJ3vLg7ilgARt0C7KmgoX16wxd2gDfWdlcLH4A6KnQRPT5C9GPOVhY2K7JC8L0XuKW+VCZ6e7j6/j9VeOEWfwGtdUJdjzU8ou4SZ0CPKn8eLT9NrSBG2NqjtsPIWePlQ2QLdnpAqH5MykFHRBAyBDwVHGGBHx5gNVCJWvSz56p7wN+YlK8ujRJ2y7i1byuqAKxRQBV9Yb5SY9Jrhup6dcSKPbDTA8LUA1H0n3jKn58qVrO62MUtd1NR7UPw16QIYm5r9L5d/UT7BqcmfAACvrlFFHz0p1tMVdshAC396uvFAU3GyHGaNjaViG5k4dxSg0Somrl8/jN8vqOLpo1/jqq1iYKxhrtqyRuyQwBigFb2NEzLNx7Q2RFlZKeDM6Nq+Vyh9jXLCiqT+f40W+yenaq1eyIhh2TeynayBXtGeDnCd20IwzwvKQKmQ8LhslrfUkeNfXqxEv7haRjNPfxNfVrNBarHiz57zTqyBXsELFwldkyuRbesAyWiF/uoYaDlvzKgnvGJltrXGTvwRGlqvQDCf6wU7YcpbL22GA3bIwD5+qugN0XqOXRHednL2chKubFn/bJX1ZBhfOfX6QHLV6lnQw2VGyQ4aPklXfARKQgYYhxbsMRqNGw3FXGbUUMSwjtCoFbZV/8ZqAsMlpUw2hbVvxaGeLYWVnnP5L0gEH6v0PnmhBetZnQuqAWtNZmKTqSky92qAFMLz/fpSHYi3f1MYq5WURD+s3V6GMYHBcKneCFGlkmxb1H/A5Z7wLqU14i4AAvyPyhb1iIBtsRkJ/9SYaEyIW8n3FkI+89DRE/2qoAMmM1u8B01hAfhb9+iP8enWK7KE9+G7anGElOE/VER29p0bkc2NaJomIjOPiJuePhoeoYURviHTNK/R6NoGHmh+ayfx8+roSUy/7OUSdu1V+XykwhyPkujb/G0rg+/SagjCB/pC4uwPyoiqIx54oDkWwsfn4FREwd2pj/jxlaifhby14paDXkqL3SMhfP3Y2pMEZ6LVr/9EaKBwXThAw98j2Iq0PdEplwIH8fX2KuEGdgnoNUYTin4pC2YIKqqB6bgnhIbbu4lazopFuABG3s44caVq3t6JnmIn1AzfsJEeZoUX6WtLcO+CjKlyVQkiHj4mHJfG8EA6/unSirx1s0ez1e6G7vvtSE1NLHWAAEAJMD1HH6XbMN+DzBpidQGLuwCdH+jwge6WB19im3AFzsaFz6AVo3sZgDh8cQ+CemHVZQFshmcu6AQJbeSuXbz3081UzrMLfktNqhHh5RxbhRBxrNN53n0u33xLcH2LGsFmCSyIWCFCMhkcUaScdX11DDeYjf0fm0gUYD5bvvUSECZ0US78ls8PzLEV1QPCFSQMXym2xsPiNT+Gw0OfEJF7PvtygsKCOQ/p8eIvr1aVcQmA4ainDwe3eslgsQg/dyS2fyBbAiAHVhgWpTp9gkjCGNdL0GH809y/ugnW3TZkSK1huX0KNE3mZif9VJdYDTce+coPlbJFz3Ctx58SWQ3QQN2IDZExYtaYZig66lO0EHwSMZ9g0uFh/qi+xEPbGDje1cXZ0hbo2eDgDVtaoxoEsj99PdRNKpaBmHCJmSk/4O3ZjZB42SFqNROIuqhwP+XA2TNlxQ61aAujAtFHQAtNhghTSo18fUi0aJC/Pm/5esODRC9PhRFxJ9s5ZLmOqVOkH54jb8h1ggS0bj5NoyEu6ImaBh0saH9YFzvpPnh8rhunUaYUGEbi/UrYgBGSD/eq/x9c6+flgKhamcsSD8vViMoMkK2c8QCV1Pr2QByndDJAISCnvDgEaKHBicXPrCioFIRD/XrdIRMtJk/syg+A5OiazKIfiWyJWC5zAsJnRtrneIYsqkPsDBvLdCUsb6L7cmIKqiYZ4dGe6La/hhYHAmdhmwJWJjwrf1kT5CE8LE/cm33V700bTx4n8p+Vj1bvDLZ8ywXYJLIloCwTAkk/O80pQwfHRO3H9uqxxo1CJQkN6+uUZaU79XvMbBcfkxDtgQAQZEmTeBJ+FHUfGSA6F7O4Z8Zo0mBYKyrXc0ZM8+Jrc22cEXNknHrB7InYFUnxRJgnoiOZaRsYAKkM6zPt3EPOlgnWPsFn9varoKy8GaTakgSLlxQYw++1ElZw81PFcTcUSDpJgo9jVIBZjwGa0+ln1EX2Lwjuh0lyZ+yvv9NWU/U1teZ+cWmJ6W9y8Qf8H7wEwYZI/seAKxF0SRFB6e1UCM8X6iMcpGTceuJ/jOqknBIxj0/kDCsaXGGn+hxFKUftkxWyLEDdz/WUTWLMvgcivcAP5ojbEY9h62bVF0YPeP8+fh8AHnNZT+egU3rCXd3Ee3uJxdwRwDG+2AecVCwT3g/Bjhs1IhJRYSqJSnsFMGHEzRIpBv0DH3zms8uUoX3jL0fAzcqCMAkjeIRPQlDR6dV6kiSIbwVL0W1pBnwAEmPayI6hZy/Q+ED7ggAQAImbGCidmpawghLBlEexSpYsfukeknATwR59z/iXPjB1zTNDzZhfhiGKoa/I6RVR6h6/GobUKVu0o4TxfI+yHJi1nvGOZ9acNsDJJB0w7zhQi1fvF7wluZJJT0qX80PQ6azSYQPNE8PkMAMy2C25Jj4kaZ6BpdSDLI4h6zo7r2ZFloaRXMSAMBLAgkoyNQScOii6vWElxA+73dyq7+36FzX10LzEmCAPND+nWp8qPz90Lp2wFdlyh/tzbS+Ox00PwEAhL+fe8NL+1i4EwljnBITbOpWU1RnN2erl5gZBBi8PEC0b6dKtqUJH62+2K+qYjMEM4sAAPmfMveGFwfiPeHL3Oq/NTNavcTMI8Dg988R/a6sCjx3seu6tEAzETOXgCsEzROI/Z8iJ8AxcgIcIyfAMXICHCMnwDFyAhwjJ8AxcgIcIyfAMXICHCMnwDFyAhwjJ8AxcgIc43+t6oqSdy4VYgAAAABJRU5ErkJggg==",
};
let provider = window.braveEthereum
const event = $Object.freeze(new CustomEvent("eip6963:announceProvider", {
detail: $Object.freeze({ info, provider }),
}));
$.dispatchEvent(event);
}
$.addEventListener(
"eip6963:requestProvider",
(event) => {
announceProvider();
}
};
$Object.defineProperty(window, 'ethereum', provider);
$Object.defineProperty(window, 'braveEthereum', provider);
);

announceProvider();
}

});
16 changes: 16 additions & 0 deletions Sources/Brave/Frontend/UserContent/UserScripts/__firefox__.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -369,15 +369,31 @@ if (!window.__firefox__) {
return result;
};

$.dispatchEvent = function(event) {
delete window.dispatchEvent;
let originalDispatchEvent = window.dispatchEvent(event);
return originalDispatchEvent;
}

$.addEventListener = function(type, listener, optionsOrUseCapture) {
delete window.addEventListener;
let originalAddEventListener = window.addEventListener(type, listener, optionsOrUseCapture);
return originalAddEventListener;
}

// Start securing functions before any other code can use them
$($.deepFreeze);
$($.extensiveFreeze);
$($.postNativeMessage);
$($.dispatchEvent);
$($.addEventListener);
$($);

$.deepFreeze($.deepFreeze);
$.deepFreeze($.extensiveFreeze);
$.deepFreeze($.postNativeMessage);
$.deepFreeze($.dispatchEvent);
$.deepFreeze($.addEventListener);
$.deepFreeze($);

for (const value of secureObjects) {
Expand Down

0 comments on commit 6997180

Please sign in to comment.