Merge branch 'master' of https://github.com/MetaMask/metamask-docs in…

…to BboyAkers-live-coding

docs/.vuepress/config.js

@@ -2,19 +2,13 @@ const { fs, path } = require('@vuepress/shared-utils')
 
 module.exports = ctx => ({
   dest: 'docs/dist',
-  base: '/metamask-docs/',
 
   locales: {
     '/': {
       lang: 'en-US',
       title: 'MetaMask Docs',
       description: 'Welcome'
     }
-    // '/zh/': {
-    //   lang: 'zh-CN',
-    //   title: 'MetaMask Developer Documentation',
-    //   description: 'Vue 驱动的静态网站生成器'
-    // }
   },
   head: [
     ['link', { rel: 'icon', href: `/metamask-fox.svg` }],
@@ -32,11 +26,6 @@ module.exports = ctx => ({
     repo: 'MetaMask/metamask-docs',
     editLinks: true,
     docsDir: 'packages/docs/dist',
-    // #697 Provided by the official algolia team.
-    // algolia: ctx.isProd ? ({
-    //   apiKey: '3a539aab83105f01761a137c61004d85',
-    //   indexName: 'vuepress'
-    // }) : null,
     locales: {
       '/': {
         label: 'English',
@@ -48,17 +37,6 @@ module.exports = ctx => ({
           '/guide/': getGuideSidebar('Guide', 'API Reference','Best Practices'),
         }
       }
-      // '/zh/': {
-      //   label: '简体中文',
-      //   selectText: '选择语言',
-      //   editLinkText: '在 GitHub 上编辑此页',
-      //   lastUpdated: '上次更新',
-      //   nav: require('./nav/zh'),
-      //   sidebar: {
-      //     '/zh/api/': getApiSidebar(),
-      //     '/zh/guide/': getGuideSidebar('指南', '深入','深入'),
-      //   }
-      // }
     }
   },
   plugins: [
@@ -84,7 +62,6 @@ module.exports = ctx => ({
   ],
   extraWatchFiles: [
     '.vuepress/nav/en.js',
-    // '.vuepress/nav/zh.js',
   ]
 })
 
@@ -124,7 +101,3 @@ function getGuideSidebar (groupA, groupB, groupC) {
   ]
 }
 
-const officalPlugins = fs
-  .readdirSync(path.resolve(__dirname, '../plugin/official'))
-  .map(filename => 'official/' + filename.slice(0, -3))
-  .sort()

docs/guide/experimental-apis.md

@@ -57,3 +57,50 @@ This method returns a `Promise` that resolves to a `Boolean` indicating if the c
 ### `ethereum._metamask.isUnlocked: () => Promise<boolean>`
 
 This method returns a `Promise` that resolves to a `Boolean` indicating if MetaMask is unlocked by the user. This is useful for knowing if MetaMask is unlocked in order to provide meaningful instructions to the user during onboarding. Note that this does not indicate if a user has approved account exposure.
+
+## `eth_` RPC methods
+
+### eth_getEncryptionPublicKey
+
+This method is used for getting a public key that based on the `nacl` [library](https://github.com/dchest/tweetnacl-js). With such a key, you can encrypt a message.
+
+```javascript
+ethereum.sendAsync({
+    jsonrpc: '2.0',
+    method: 'eth_getEncryptionPublicKey',
+    params: [accounts[0]],
+    from: accounts[0],
+}, function(error, encryptionpublickey) {
+    if (!error) {
+	window.encryptionpublickey = encryptionpublickey.result;
+    } else {
+	console.log(error);
+    }
+})
+```
+
+An example of how to encrypt a message via [sigUtil](https://github.com/MetaMask/eth-sig-util)
+
+```javascript
+const encryptedMessage = web3.toHex(JSON.stringify(sigUtil.encrypt(window.encryptionpublickey, {'data': 'Hello world!'}, 'x25519-xsalsa20-poly1305')));
+```
+
+### eth_decrypt
+
+This method is used to decrypt a message that was encrypted using the public key based on the `nacl` [library](https://github.com/dchest/tweetnacl-js).
+
+```javascript
+web3.currentProvider.sendAsync({
+    jsonrpc: '2.0',
+    method: 'eth_decrypt',
+    params: [encryptedMessage, accounts[0]],
+    from: accounts[0],
+}, function(error, message) {
+    console.log(error, message);
+    if (!error) {
+	console.log(message.result); // Hello world!
+    } else {
+	console.log(error.message);
+    }
+});
+```