From 97464a2303f8197dc213411b781bb9d01a3ae227 Mon Sep 17 00:00:00 2001 From: Iuri Matias Date: Tue, 1 Jun 2021 18:02:35 -0400 Subject: [PATCH] organize statusgo calls --- .../content/api/statusgo/accounts.md | 63 +++ devuser_guide/content/api/statusgo/apis.md | 504 ------------------ devuser_guide/content/api/statusgo/browser.md | 21 + devuser_guide/content/api/statusgo/chat.md | 120 +++++ .../content/api/statusgo/communities.md | 77 +++ .../content/api/statusgo/contacts.md | 27 + .../content/api/statusgo/ethereum.md | 31 ++ devuser_guide/content/api/statusgo/general.md | 78 +++ .../content/api/statusgo/group_chats.md | 43 ++ devuser_guide/content/api/statusgo/wallet.md | 65 +++ 10 files changed, 525 insertions(+), 504 deletions(-) create mode 100644 devuser_guide/content/api/statusgo/accounts.md delete mode 100644 devuser_guide/content/api/statusgo/apis.md create mode 100644 devuser_guide/content/api/statusgo/browser.md create mode 100644 devuser_guide/content/api/statusgo/chat.md create mode 100644 devuser_guide/content/api/statusgo/communities.md create mode 100644 devuser_guide/content/api/statusgo/contacts.md create mode 100644 devuser_guide/content/api/statusgo/ethereum.md create mode 100644 devuser_guide/content/api/statusgo/general.md create mode 100644 devuser_guide/content/api/statusgo/group_chats.md create mode 100644 devuser_guide/content/api/statusgo/wallet.md diff --git a/devuser_guide/content/api/statusgo/accounts.md b/devuser_guide/content/api/statusgo/accounts.md new file mode 100644 index 0000000000..2a17056aa2 --- /dev/null +++ b/devuser_guide/content/api/statusgo/accounts.md @@ -0,0 +1,63 @@ +--- +title : "Accounts" +description: "" +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +menu: + api: + parent: "statusgo" +toc: true +--- + +## RPC Calls + +### `accounts_getAccounts` + +### `accounts_saveAccounts` + +### `accounts_deleteAccount` + +%* [address]) + +### `multiaccounts_storeIdentityImage` + +%* [keyUID, imagePath, aX, aY, bX, bY]).parseJson + +### `multiaccounts_getIdentityImages` + +%* [keyUID]).parseJson + +### `multiaccounts_deleteIdentityImage` + +%* [keyUID]).parseJson + +## Library Calls + +### `multiAccountGenerateAndDeriveAddresses($multiAccountConfig)` + +### `generateAlias(publicKey)` + +### `identicon(publicKey)` + +### `openAccounts(STATUSGODIR).parseJson` + +### `saveAccountAndLogin(accountData, hashedPassword, settingsJSON, configJSON, $subaccountData)` + +### `multiAccountStoreDerivedAccounts($multiAccount);` + +### `multiAccountLoadAccount($inputJson)` + +### `verifyAccountPassword(KEYSTOREDIR, address, hashedPassword)` + +### `multiAccountImportMnemonic($mnemonicJson)` + +### `multiAccountImportPrivateKey($privateKeyJson)` + +### `multiAccountStoreAccount($(%*{"accountID": account.id, "password": hashedPassword})));` + +### `multiAccountDeriveAddresses($deriveJson))` + +### `validateMnemonic(mnemonic)` diff --git a/devuser_guide/content/api/statusgo/apis.md b/devuser_guide/content/api/statusgo/apis.md deleted file mode 100644 index 94d9f1775c..0000000000 --- a/devuser_guide/content/api/statusgo/apis.md +++ /dev/null @@ -1,504 +0,0 @@ ---- -title : "APIs" -description: "" -lead: "" -date: 2020-10-06T08:48:23+00:00 -lastmod: 2020-10-06T08:48:23+00:00 -draft: false -images: [] -menu: - api: - parent: "statusgo" -toc: true ---- - -## RPC Calls - -### `acceptRequestAddressForTransaction` - -%* [messageId, address]) - -### `declineRequestAddressForTransaction` - -%* [messageId]) - -### `declineRequestTransaction` - -%* [messageId]) - -### `requestAddressForTransaction` - -%* [chatId, fromAddress, amount, tokenAddress]) - -### `requestTransaction` - -%* [chatId, amount, tokenAddress, fromAddress]) - -### `accounts_getAccounts` - -") -### `eth_getTransactionReceipt` - -%* [transactionHash]) - -### `eth_getBalance` - -payload)) - -### `wallet_storePendingTransaction` - -payload) - -### `wallet_getPendingTransactions` - -payload) - -### `wallet_getPendingOutboundTransactionsByAddress` - -payload) - -### `wallet_deletePendingTransaction` - -payload) - -### `wallet_setInitialBlocksRange` - -payload) - -### `wallet_watchTransaction` - -payload) - -### `wallet_checkRecentHistory` - -payload) - -### `setInstallationMetadata` - -%* [installationId, {"name": deviceName, "deviceType": deviceType}]) - -### `getOurInstallations` - -%* []).parseJSON()["result"] - -### `syncDevices` - -%* [preferredName, photoPath]) - -### `sendPairInstallation` - -".prefix) -### `enableInstallation` - -%* [installationId]) - -### `disableInstallation` - -%* [installationId]) - -### `wallet_getCustomTokens` - -payload) - -### `wallet_addCustomToken` - -payload) - -### `wallet_deleteCustomToken` - -payload) - -### `wallet_getTokensBalances` - -payload).parseJson - -### `eth_call` - -payload) - -### `settings_saveSetting` - -%* [key, value]) - -### `web3_clientVersion` - -"))["result"].getStr -### `settings_getSettings` - -").parseJSON()["result"] -### `getLinkPreviewWhitelist` - -%* []).parseJSON()["result"] - -### `mailservers_addMailserver` - -%* [ - -### `mailservers_getMailservers` - -").parseJSON()["result"] -### `blockContact` - -%* [ - -### `getContactByID` - -%* [id]) - -### `contacts` - -payload).parseJson - -### `saveContact` - -payload) - -### `sendContactUpdate` - -%* [publicKey, "", ""]) - -### `browsers_storeBookmark` - -payload).parseJson["result"] - -### `browsers_updateBookmark` - -payload) - -### `browsers_getBookmarks` - -payload) - -### `browsers_deleteBookmark` - -payload) - -### `loadFilters` - -%* [filter(filters, proc(x:JsonNode):bool = x.kind != JNull)]) - -### `removeFilters` - -%* [ - -### `saveChat` - -%* [ - -### `createPublicChat` - -%* [{"ID": chatId}]) - -### `createOneToOneChat` - -%* [{"ID": chatId}]) - -### `deactivateChat` - -%* [{ "ID": chat.id }]) - -### `createProfileChat` - -%* [{ "ID": pubKey }]) - -### `chats` - -".prefix)) -### `chatMessages` - -%* [chatId, cursorVal, limit]) - -### `emojiReactionsByChatID` - -%* [chatId, cursorVal, limit]) - -### `sendEmojiReaction` - -%* [chatId, messageId, emojiId]))["result"] - -### `sendEmojiReactionRetraction` - -%* [emojiReactionId]))["result"] - -### `waku_generateSymKeyFromPassword` - -%* [ - -### `sendChatMessage` - -%* [ - -### `sendChatMessages` - -%* [imagesJson]) - -### `markAllRead` - -%* [chatId]) - -### `markMessagesSeen` - -%* [chatId, messageIds]) - -### `confirmJoiningGroup` - -%* [chatId]) - -### `leaveGroupChat` - -%* [nil, chatId, true]) - -### `deleteMessagesByChatID` - -%* [chatId]) - -### `changeGroupChatName` - -%* [nil, chatId, newName]) - -### `createGroupChatWithMembers` - -%* [nil, groupName, pubKeys]) - -### `addMembersToGroupChat` - -%* [nil, chatId, pubKeys]) - -### `removeMemberFromGroupChat` - -%* [nil, chatId, pubKey]) - -### `addAdminsToGroupChat` - -%* [nil, chatId, [pubKey]]) - -### `updateMessageOutgoingStatus` - -%* [messageId, status]) - -### `reSendChatMessage` - -%*[messageId]) - -### `muteChat` - -%*[chatId]) - -### `unmuteChat` - -%*[chatId]) - -### `getLinkPreviewData` - -%*[link]) - -### `communities` - -".prefix).parseJSON() -### `joinedCommunities` - -".prefix).parseJSON() -### `createCommunity` - -%*[{ - -### `createCommunityChat` - -%*[ - -### `createCommunityCategory` - -%*[ - -### `editCommunityCategory` - -%*[ - -### `reorderCommunityChat` - -%*[ - -### `deleteCommunityCategory` - -%*[ - -### `requestCommunityInfoFromMailserver` - -%*[communityId]) - -### `joinCommunity` - -%*[communityId]) - -### `leaveCommunity` - -%*[communityId]) - -### `inviteUsersToCommunity` - -%*[{ - -### `exportCommunity` - -%*[communityId]).parseJson()["result"].getStr - -### `importCommunity` - -%*[communityKey]) - -### `removeUserFromCommunity` - -%*[communityId, pubKey]) - -### `requestToJoinCommunity` - -%*[{ - -### `acceptRequestToJoinCommunity` - -%*[{ - -### `declineRequestToJoinCommunity` - -%*[{ - -### `pendingRequestsToJoinForCommunity` - -%*[communityId]).parseJSON() - -### `myPendingRequestsToJoin` - -".prefix).parseJSON() -### `banUserFromCommunity` - -%*[{ - -### `chatPinnedMessages` - -%* [chatId, cursorVal, limit]) - -### `sendPinMessage` - -%*[{ - -### `startMessenger` - -".prefix) -### `admin_addPeer` - -%* [peer]) - -### `admin_removePeer` - -%* [peer]) - -### `markTrustedPeer` - -%* [peer]) - -### `eth_getBlockByNumber` - -%* [blockNumber, false]) - -### `wallet_getTransfersByAddress` - -%* [address, newJNull(), limit, fetchMore]) - -### `eth_accounts` - -") -### `accounts_saveAccounts` - -%* [ - -### `accounts_deleteAccount` - -%* [address]) - -### `multiaccounts_storeIdentityImage` - -%* [keyUID, imagePath, aX, aY, bX, bY]).parseJson - -### `multiaccounts_getIdentityImages` - -%* [keyUID]).parseJson - -### `multiaccounts_deleteIdentityImage` - -%* [keyUID]).parseJson - -### `eth_estimateGas` - -%*[%tx]) - -### `mailservers_ping` - -%* [ - -### `updateMailservers` - -%* [[peer]]) - -### `mailservers_deleteMailserver` - -%* [peer]) - -### `requestAllHistoricMessages` - -%*[]) - -### `syncChatFromSyncedFrom` - -%*[chatId]) - -### `fillGaps` - -%*[chatId, messageIds]) - - -## Library Calls - -### `validateMnemonic(mnemonic)` - -### `callRPC(inputJSON)` - -### `callPrivateRPC(inputJSON)` - -### `sendTransaction(inputJSON, hashed_password)` - -### `signMessage(rpcParams)` - -### `signTypedData(data, address, password)` - -### `multiAccountGenerateAndDeriveAddresses($multiAccountConfig)` - -### `generateAlias(publicKey)` - -### `identicon(publicKey)` - -### `initKeystore(KEYSTOREDIR)` - -### `openAccounts(STATUSGODIR).parseJson` - -### `saveAccountAndLogin(accountData, hashedPassword, settingsJSON, configJSON, $subaccountData)` - -### `multiAccountStoreDerivedAccounts($multiAccount);` - -### `addPeer(peer)` - -### `login($toJson(account), hashedPassword)` - -### `multiAccountLoadAccount($inputJson)` - -### `verifyAccountPassword(KEYSTOREDIR, address, hashedPassword)` - -### `multiAccountImportMnemonic($mnemonicJson)` - -### `multiAccountImportPrivateKey($privateKeyJson)` - -### `multiAccountStoreAccount($(%*{"accountID": account.id, "password": hashedPassword})));` - -### `multiAccountDeriveAddresses($deriveJson))` - -### `logout(), StatusGoError)` - diff --git a/devuser_guide/content/api/statusgo/browser.md b/devuser_guide/content/api/statusgo/browser.md new file mode 100644 index 0000000000..31760d1174 --- /dev/null +++ b/devuser_guide/content/api/statusgo/browser.md @@ -0,0 +1,21 @@ +--- +title : "Browser" +description: "" +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +menu: + api: + parent: "statusgo" +toc: true +--- + +### `browsers_storeBookmark` + +### `browsers_updateBookmark` + +### `browsers_getBookmarks` + +### `browsers_deleteBookmark` diff --git a/devuser_guide/content/api/statusgo/chat.md b/devuser_guide/content/api/statusgo/chat.md new file mode 100644 index 0000000000..9bd78e479e --- /dev/null +++ b/devuser_guide/content/api/statusgo/chat.md @@ -0,0 +1,120 @@ +--- +title : "Chat" +description: "" +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +menu: + api: + parent: "statusgo" +toc: true +--- + +### `mailservers_addMailserver` + +### `mailservers_getMailservers` + +### `loadFilters` + +%* [filter(filters, proc(x:JsonNode):bool = x.kind != JNull)]) + +### `removeFilters` + +### `saveChat` + +### `createPublicChat` + +%* [{"ID": chatId}]) + +### `createOneToOneChat` + +%* [{"ID": chatId}]) + +### `deactivateChat` + +%* [{ "ID": chat.id }]) + +### `createProfileChat` + +%* [{ "ID": pubKey }]) + +### `chats` + +### `chatMessages` + +%* [chatId, cursorVal, limit]) + +### `emojiReactionsByChatID` + +%* [chatId, cursorVal, limit]) + +### `sendEmojiReaction` + +%* [chatId, messageId, emojiId]))["result"] + +### `sendEmojiReactionRetraction` + +%* [emojiReactionId]))["result"] + +### `waku_generateSymKeyFromPassword` + +### `sendChatMessage` + +### `sendChatMessages` + +%* [imagesJson]) + +### `markAllRead` + +%* [chatId]) + +### `markMessagesSeen` + +%* [chatId, messageIds]) + +### `deleteMessagesByChatID` + +%* [chatId]) + +### `updateMessageOutgoingStatus` + +%* [messageId, status]) + +### `reSendChatMessage` + +%*[messageId]) + +### `muteChat` + +%*[chatId]) + +### `unmuteChat` + +%*[chatId]) + +### `getLinkPreviewData` + +### `getLinkPreviewWhitelist` +%*[link]) + +### `mailservers_ping` + +### `updateMailservers` + +%* [[peer]]) + +### `mailservers_deleteMailserver` + +%* [peer]) + +### `requestAllHistoricMessages` + +### `syncChatFromSyncedFrom` + +%*[chatId]) + +### `fillGaps` + +%*[chatId, messageIds]) diff --git a/devuser_guide/content/api/statusgo/communities.md b/devuser_guide/content/api/statusgo/communities.md new file mode 100644 index 0000000000..f029c5927b --- /dev/null +++ b/devuser_guide/content/api/statusgo/communities.md @@ -0,0 +1,77 @@ +--- +title : "Communities" +description: "" +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +menu: + api: + parent: "statusgo" +toc: true +--- + +## RPC Calls + +### `communities` + +### `joinedCommunities` + +### `createCommunity` + +### `createCommunityChat` + +### `createCommunityCategory` + +### `editCommunityCategory` + +### `reorderCommunityChat` + +### `deleteCommunityCategory` + +### `requestCommunityInfoFromMailserver` + +%*[communityId]) + +### `joinCommunity` + +%*[communityId]) + +### `leaveCommunity` + +%*[communityId]) + +### `inviteUsersToCommunity` + +### `exportCommunity` + +%*[communityId]).parseJson()["result"].getStr + +### `importCommunity` + +%*[communityKey]) + +### `removeUserFromCommunity` + +%*[communityId, pubKey]) + +### `requestToJoinCommunity` + +### `acceptRequestToJoinCommunity` + +### `declineRequestToJoinCommunity` + +### `pendingRequestsToJoinForCommunity` + +%*[communityId]).parseJSON() + +### `myPendingRequestsToJoin` + +### `banUserFromCommunity` + +### `chatPinnedMessages` + +%* [chatId, cursorVal, limit]) + +### `sendPinMessage` diff --git a/devuser_guide/content/api/statusgo/contacts.md b/devuser_guide/content/api/statusgo/contacts.md new file mode 100644 index 0000000000..d9ae427daf --- /dev/null +++ b/devuser_guide/content/api/statusgo/contacts.md @@ -0,0 +1,27 @@ +--- +title : "Contacts" +description: "" +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +menu: + api: + parent: "statusgo" +toc: true +--- + +### `blockContact` + +### `getContactByID` + +%* [id]) + +### `contacts` + +### `saveContact` + +### `sendContactUpdate` + +%* [publicKey, "", ""]) diff --git a/devuser_guide/content/api/statusgo/ethereum.md b/devuser_guide/content/api/statusgo/ethereum.md new file mode 100644 index 0000000000..77899b2f3a --- /dev/null +++ b/devuser_guide/content/api/statusgo/ethereum.md @@ -0,0 +1,31 @@ +--- +title : "Ethereum" +description: "" +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +menu: + api: + parent: "statusgo" +toc: true +--- + +### `eth_getTransactionReceipt` + +%* [transactionHash]) + +### `eth_getBalance` + +### `eth_call` + +### `eth_getBlockByNumber` + +%* [blockNumber, false]) + +### `eth_accounts` + +### `eth_estimateGas` + +%*[%tx]) diff --git a/devuser_guide/content/api/statusgo/general.md b/devuser_guide/content/api/statusgo/general.md new file mode 100644 index 0000000000..4e2ae281d9 --- /dev/null +++ b/devuser_guide/content/api/statusgo/general.md @@ -0,0 +1,78 @@ +--- +title : "General" +description: "" +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +menu: + api: + parent: "statusgo" +toc: true +--- + +## RPC Calls + +### `setInstallationMetadata` + +%* [installationId, {"name": deviceName, "deviceType": deviceType}]) + +### `getOurInstallations` + +%* []).parseJSON()["result"] + +### `syncDevices` + +%* [preferredName, photoPath]) + +### `sendPairInstallation` + +".prefix) +### `enableInstallation` + +%* [installationId]) + +### `disableInstallation` + +%* [installationId]) + +### `settings_getSettings` + +### `settings_saveSetting` + +%* [key, value]) + +### `web3_clientVersion` + +### `startMessenger` + +### `admin_addPeer` + +%* [peer]) + +### `admin_removePeer` + +%* [peer]) + +### `markTrustedPeer` + +%* [peer]) + +## Library Calls + +### `callRPC(inputJSON)` + +### `callPrivateRPC(inputJSON)` + +### `signMessage(rpcParams)` + +### `signTypedData(data, address, password)` + +### `initKeystore(KEYSTOREDIR)` + +### `addPeer(peer)` + +### `login($toJson(account), hashedPassword)` + +### `logout(), StatusGoError)` diff --git a/devuser_guide/content/api/statusgo/group_chats.md b/devuser_guide/content/api/statusgo/group_chats.md new file mode 100644 index 0000000000..8b2999e4f1 --- /dev/null +++ b/devuser_guide/content/api/statusgo/group_chats.md @@ -0,0 +1,43 @@ +--- +title : "Group Chats" +description: "" +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +menu: + api: + parent: "statusgo" +toc: true +--- + +## RPC Calls + +### `confirmJoiningGroup` + +%* [chatId]) + +### `leaveGroupChat` + +%* [nil, chatId, true]) + +### `changeGroupChatName` + +%* [nil, chatId, newName]) + +### `createGroupChatWithMembers` + +%* [nil, groupName, pubKeys]) + +### `addMembersToGroupChat` + +%* [nil, chatId, pubKeys]) + +### `removeMemberFromGroupChat` + +%* [nil, chatId, pubKey]) + +### `addAdminsToGroupChat` + +%* [nil, chatId, [pubKey]]) diff --git a/devuser_guide/content/api/statusgo/wallet.md b/devuser_guide/content/api/statusgo/wallet.md new file mode 100644 index 0000000000..968cceed2a --- /dev/null +++ b/devuser_guide/content/api/statusgo/wallet.md @@ -0,0 +1,65 @@ +--- +title : "Wallet & Transactions" +description: "" +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +menu: + api: + parent: "statusgo" +toc: true +--- + +## RPC Calls + +### `wallet_storePendingTransaction` + +### `wallet_getPendingTransactions` + +### `wallet_getPendingOutboundTransactionsByAddress` + +### `wallet_deletePendingTransaction` + +### `wallet_setInitialBlocksRange` + +### `wallet_watchTransaction` + +### `wallet_checkRecentHistory` + +### `wallet_getCustomTokens` + +### `wallet_addCustomToken` + +### `wallet_deleteCustomToken` + +### `wallet_getTokensBalances` + +## Library Calls + +### `acceptRequestAddressForTransaction` + +%* [messageId, address]) + +### `declineRequestAddressForTransaction` + +%* [messageId]) + +### `declineRequestTransaction` + +%* [messageId]) + +### `requestAddressForTransaction` + +%* [chatId, fromAddress, amount, tokenAddress]) + +### `requestTransaction` + +%* [chatId, amount, tokenAddress, fromAddress]) + +### `sendTransaction(inputJSON, hashed_password)` + +### `wallet_getTransfersByAddress` + +%* [address, newJNull(), limit, fetchMore])