[docs]: add webacy #1573
Open
[docs]: add webacy #1573
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cvince
commented
Aug 17, 2024
cvince
commented
- Audience: Third party developers looking for a multi-chain risk data solution
- Problem: Providing a one-stop-shop for all blockchain risk data
- Discovery: Searching for Blockchain risk API solutions
- Document type: Quickstart
- Policy acknowledgment (Third-party docs only): Webacy agrees to the third-party content policy outlined within "Contribute docs"
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
This has been signed |
|
We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please sign the linked documents below to get yourself added. https://na3.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=b15c81cc-b5ea-42a6-9107-3992526f2898&env=na3&acct=6e152afc-6284-44af-a4c1-d8ef291db402&v=2 |
|
@cla-bot check |
|
The cla-bot has been summoned, and re-checked this pull request! |
|
@cvince, apologies. This process took too long. I'm happy to merge it. All I need from you is to update your branch to update this PR. |
|
|
anegg0
reviewed
Dec 17, 2024
Comment on lines
+10
to
+166
|
|
||
| **Threat Risks API** | ||
|
|
||
| This API indicates if a given address is a risk or a threat to others. | ||
|
|
||
| It returns risk data associated with the supplied address. It flags if the address appears in any sanctioned databases, has been historically flagged as malicious, associated with a scam smart contract, and so on. It also includes filtering for spam / sybil signals. | ||
|
|
||
| Some common use cases for this endpoint include: | ||
|
|
||
| - Filtering addresses for spam | ||
|
|
||
| - Blocking high risk addresses from utilizing your service | ||
|
|
||
| - Presenting high risk addresses to others as potentially risky to interact with | ||
|
|
||
| - Protecting your platform by restricting high risk addresses | ||
|
|
||
| - Much more! | ||
|
|
||
| **Approval Risks API** | ||
|
|
||
| This API returns a list of approvals for a given address, and the associated risk of the spender of that approval. Approvals are commonplace in crypto - now you know which ones put you at risk. Check out your own open approvals[ here](https://dapp.webacy.com/?mode=approvals). | ||
|
|
||
| If you're a wallet interested in native revoke and approval risk scoring,[ reach out to us](https://docs.webacy.com/other/contact-us). | ||
|
|
||
| **Transaction Risks API** | ||
|
|
||
| This API returns risk data for a given transaction. Pass in any transaction hash, and the API will return a risk score result that incorporates counterparty EOA risk profiles, address risk, involved asset smart contract risk, and more. | ||
|
|
||
| Some common use cases for this endpoint include: | ||
|
|
||
| - Understanding historical behavior of an address | ||
|
|
||
| - Providing data to give recommendations about on-chain activity | ||
|
|
||
| - Gaining insight on a particular transaction or action | ||
|
|
||
| - Flagging previously unknown activity that was potentially risk | ||
|
|
||
| - And more! | ||
|
|
||
| **Exposure Risk API** | ||
|
|
||
| The original Webacy Safety Score, this API returns a 'risk profile' or 'exposure risk' of a given address. | ||
|
|
||
| This indicates the exposure the address has to risky activity through historical transactions, behavior, and owned assets. This endpoint DOES NOT assess whether the supplied address is a risk to others (Threat Risk). It instead assesses whether the supplied address is AT RISK from others. | ||
|
|
||
| Some common use cases for this endpoint include: | ||
|
|
||
| - Gaining a holistic understanding of a client or personal wallet | ||
|
|
||
| - Enabling recommendations and analysis on past behavior | ||
|
|
||
| - Assessing common traits of a user base | ||
|
|
||
| - Determining types of users to better serve them | ||
|
|
||
| - Triggering warnings to internal teams or external users based on change in risk profile based on ongoing activity | ||
|
|
||
| - Understanding the behavioral activity of a user base | ||
|
|
||
| - And more! | ||
|
|
||
| Check out your own risk exposure[ here](https://dapp.webacy.com/risk-score). | ||
|
|
||
| **Contract Risk API** | ||
|
|
||
| This API returns a contract risk analysis for a given contract address. | ||
|
|
||
| The on-demand analysis leverages multiple techniques such as fuzzing, static analysis, and dynamic analysis for real-time smart contract scanning. | ||
|
|
||
| Some common use cases for this endpoint include: | ||
|
|
||
| - Scanning contracts before listing them on your site | ||
|
|
||
| - Verifying that you are not promoting malicious contracts | ||
|
|
||
| - Checking a contract before interacting with it | ||
|
|
||
| - Reviewing code as you build | ||
|
|
||
| - Assessing your contracts before submitting for a formal audit process | ||
|
|
||
| **URL Risk** | ||
|
|
||
| Given a URL, this endpoint analyzes the safety of it. It helps you determine if a given link is a phishing scam, sending you to a dangerous place, or is otherwise malicious. | ||
|
|
||
| Some common use cases for this endpoint include: | ||
|
|
||
| - Assessing the safety of a dapp / website | ||
|
|
||
| - Warning your end-users from interacting with a potentially malicious website | ||
|
|
||
| - Blocking websites | ||
|
|
||
| **Wallet Watch API** | ||
|
|
||
| These APIs enable you to register users to Webacy's real-time notification infrastructure. | ||
|
|
||
| If you're interested in setting up your own private instance with custom messaging and triggers,[ contact us](https://docs.webacy.com/other/contact-us). |
There was a problem hiding this comment.
Suggested change
| [Webacy](https://webacy.com/) is a risk data network that helps wallets & applications protect their users against scams, hacks, and mistakes across the blockchain. | |
| Wallets, protocols, & applications use Webacy throughout their user experience: | |
| **Address trust and safety** | |
| - Assess the safety of interacting with a given address (any address: EOA, smart contract, token, etc.). Screen for blacklists, sanctioned addresses, malicious behavior, and other potential flags | |
| - Analyze smart contract code in real-time | |
| - Filter spam and sybil addresses | |
| **Connected wallets** | |
| - Block sanctioned addresses and wallets involved in malicious behavior | |
| - Educate users with a Wallet Safety Score | |
| - Delight users by enabling additional features or providing additional value | |
| - Display open approvals and the risk associated | |
| **Before a transaction** | |
| - Block harmful dapps and links | |
| - Review address trust and safety prior to signature | |
| - Protect users from interacting with malicious smart contracts | |
| **Monitoring and Notifications** | |
| - Monitor all on-chain activity associated with your protocol or smart contracts | |
| - Enable wallet monitoring and flag for risky transactions | |
| - Proactively notify users (or be notified) of any potentially risk activity involved with a given address | |
| ## **Get started with Webacy** | |
| Start building in minutes: | |
| - Reach out to info\@webacy.com for an API key | |
| - Check out the[ Quick Start Integration Guide](https://docs.webacy.com/api-embedded-safety/quick-start-integration-guide) | |
| ## **APIs** | |
| [Webacy’s APIs](https://www.webacy.com/safetyscore) are REST based APIs that expose your platform to Webacy's Risk Engine and our Wallet Watch Notifications Platform. | |
| With over 15+ data providers, along with our own data analytics and algorithms, we have the broadest risk coverage across the blockchain ecosystem. From compliance and regulatory data, to social engineering scams and crowdsourced reports, we process millions of monthly signals, updating our models with the latest and most up-to-date information. | |
| For detailed technical documentation, and to begin testing the APIs directly, visit our[ technical documentation](https://webacy.readme.io/reference/webacy-api-overview-pre-release). | |
| Available APIs and corresponding use cases include: | |
| **Threat Risks API** | |
| This API indicates if a given address is a risk or a threat to others. | |
| It returns risk data associated with the supplied address. It flags if the address appears in any sanctioned databases, has been historically flagged as malicious, associated with a scam smart contract, and so on. It also includes filtering for spam / sybil signals. | |
| Some common use cases for this endpoint include: | |
| - Filtering addresses for spam | |
| - Blocking high risk addresses from utilizing your service | |
| - Presenting high risk addresses to others as potentially risky to interact with | |
| - Protecting your platform by restricting high risk addresses | |
| - Much more! | |
| **Approval Risks API** | |
| This API returns a list of approvals for a given address, and the associated risk of the spender of that approval. Approvals are commonplace in crypto - now you know which ones put you at risk. Check out your own open approvals[ here](https://dapp.webacy.com/?mode=approvals). | |
| If you're a wallet interested in native revoke and approval risk scoring,[ reach out to us](https://docs.webacy.com/other/contact-us). | |
| **Transaction Risks API** | |
| This API returns risk data for a given transaction. Pass in any transaction hash, and the API will return a risk score result that incorporates counterparty EOA risk profiles, address risk, involved asset smart contract risk, and more. | |
| Some common use cases for this endpoint include: | |
| - Understanding historical behavior of an address | |
| - Providing data to give recommendations about on-chain activity | |
| - Gaining insight on a particular transaction or action | |
| - Flagging previously unknown activity that was potentially risk | |
| - And more! | |
| **Exposure Risk API** | |
| The original Webacy Safety Score, this API returns a 'risk profile' or 'exposure risk' of a given address. | |
| This indicates the exposure the address has to risky activity through historical transactions, behavior, and owned assets. This endpoint DOES NOT assess whether the supplied address is a risk to others (Threat Risk). It instead assesses whether the supplied address is AT RISK from others. | |
| Some common use cases for this endpoint include: | |
| - Gaining a holistic understanding of a client or personal wallet | |
| - Enabling recommendations and analysis on past behavior | |
| - Assessing common traits of a user base | |
| - Determining types of users to better serve them | |
| - Triggering warnings to internal teams or external users based on change in risk profile based on ongoing activity | |
| - Understanding the behavioral activity of a user base | |
| - And more! | |
| Check out your own risk exposure[ here](https://dapp.webacy.com/risk-score). | |
| **Contract Risk API** | |
| This API returns a contract risk analysis for a given contract address. | |
| The on-demand analysis leverages multiple techniques such as fuzzing, static analysis, and dynamic analysis for real-time smart contract scanning. | |
| Some common use cases for this endpoint include: | |
| - Scanning contracts before listing them on your site | |
| - Verifying that you are not promoting malicious contracts | |
| - Checking a contract before interacting with it | |
| - Reviewing code as you build | |
| - Assessing your contracts before submitting for a formal audit process | |
| **URL Risk** | |
| Given a URL, this endpoint analyzes the safety of it. It helps you determine if a given link is a phishing scam, sending you to a dangerous place, or is otherwise malicious. | |
| Some common use cases for this endpoint include: | |
| - Assessing the safety of a dapp / website | |
| - Warning your end-users from interacting with a potentially malicious website | |
| - Blocking websites | |
| **Wallet Watch API** | |
| These APIs enable you to register users to Webacy's real-time notification infrastructure. | |
| If you're interested in setting up your own private instance with custom messaging and triggers,[ contact us](https://docs.webacy.com/other/contact-us). | |
| [Webacy](https://webacy.com/) is a risk data network that helps wallets & applications protect their users against scams, hacks, and mistakes across the blockchain. | |
| Wallets, protocols, & applications use Webacy throughout their user experience: | |
| ### Address trust and safety | |
| - Assess the safety of interacting with a given address (any address: EOA, smart contract, token, etc.). Screen for blocklists, sanctioned addresses, malicious behavior, and other potential flags | |
| - Analyze smart contract code in real-time | |
| - Filter spam and sybil addresses | |
| ### Connected wallets | |
| - Block sanctioned addresses and wallets involved in malicious behavior | |
| - Educate users with a Wallet Safety Score | |
| - Delight users by enabling additional features or providing additional value | |
| - Display open approvals and the risks associated | |
| ### Before a transaction | |
| - Block harmful dApps and links | |
| - Review address trust and safety prior to signature | |
| - Protect users from interacting with malicious smart contracts | |
| ### Monitoring and Notifications | |
| - Monitor all on-chain activity associated with your protocol or smart contracts | |
| - Enable wallet monitoring and flag for risky transactions | |
| - Proactively notify users (or be notified) of any potentially risk activity involved with a given address | |
| ## Get started with Webacy | |
| Start building in minutes: | |
| - Reach out to info\@webacy.com for an API key | |
| - Check out the[ Quick Start Integration Guide](https://docs.webacy.com/api-embedded-safety/quick-start-integration-guide) | |
| ## APIs | |
| [Webacy’s APIs](https://www.webacy.com/safetyscore) are REST-based APIs that expose your platform to Webacy's Risk Engine and our Wallet Watch Notifications Platform. | |
| With over 15+ data providers, along with our own data analytics and algorithms, we have the broadest risk coverage across the blockchain ecosystem. From compliance and regulatory data to social engineering scams and crowdsourced reports, we process millions of monthly signals, updating our models with the latest and most up-to-date information. | |
| For detailed technical documentation and to begin testing the APIs directly, visit our[ technical documentation](https://webacy.readme.io/reference/webacy-api-overview-pre-release). | |
| Available APIs and corresponding use cases include: | |
| ### Threat risks API | |
| This API indicates if a given address is a risk or a threat to others. | |
| It returns risk data associated with the supplied address. It flags if the address appears in any sanctioned databases, has been historically flagged as malicious, is associated with a scam smart contract, and so on. It also includes filtering for spam / sybil signals. | |
| Some common use cases for this endpoint include: | |
| - Filtering addresses for spam | |
| - Blocking high-risk addresses from utilizing your service | |
| - Presenting high-risk addresses to others as potentially risky to interact with | |
| - Protecting your platform by restricting high-risk addresses | |
| - Much more! | |
| ### Approval risks API | |
| This API returns a list of approvals for a given address and the associated risk of the spender for that approval. Approvals are commonplace in crypto - now you know which ones put you at risk. Check out your own open approvals[ here](https://dapp.webacy.com/?mode=approvals). | |
| If you're a wallet interested in native revoke and approval risk scoring,[ reach out to us](https://docs.webacy.com/other/contact-us). | |
| ### Transaction risks API | |
| This API returns risk data for a given transaction. Pass in any transaction hash, and the API will return a risk score result that incorporates counterparty EOA risk profiles, address risk, involved asset smart contract risk, and more. | |
| Some common use cases for this endpoint include: | |
| - Understanding the historical behavior of an address | |
| - Providing data to give recommendations about on-chain activity | |
| - Gaining insight into a particular transaction or action | |
| - Flagging previously unknown activity that was potentially at risk | |
| - And more! | |
| ### Exposure risk API | |
| The original Webacy Safety Score, this API returns a 'risk profile' or 'exposure risk' of a given address. | |
| This indicates the exposure the address has to risky activity through historical transactions, behavior, and owned assets. This endpoint DOES NOT assess whether the supplied address is a risk to others (Threat Risk). Instead, it assesses whether the supplied address is AT RISK from others. | |
| Some common use cases for this endpoint include: | |
| - Gaining a holistic understanding of a client or personal wallet | |
| - Enabling recommendations and analysis on past behavior | |
| - Assessing common traits of a user base | |
| - Determining types of users to better serve them | |
| - Triggering warnings to internal teams or external users based on changes in risk profile based on ongoing activity | |
| - Understanding the behavioral activity of a user base | |
| - And more! | |
| Check out your own risk exposure[ here](https://dapp.webacy.com/risk-score). | |
| ### Contract risk API | |
| This API returns a contract risk analysis for a given contract address. | |
| The on-demand analysis leverages multiple techniques, such as fuzzing, static analysis, and dynamic analysis, for real-time smart contract scanning. | |
| Some common use cases for this endpoint include: | |
| - Scanning contracts before listing them on your site | |
| - Verifying that you are not promoting malicious contracts | |
| - Checking a contract before interacting with it | |
| - Reviewing code as you build | |
| - Assessing your contracts before submitting them for a formal audit process | |
| ### URL risk | |
| Given a URL, this endpoint analyzes its safety. It helps you determine if a given link is a phishing scam, sending you to a dangerous place, or is otherwise malicious. | |
| Some common use cases for this endpoint include: | |
| - Assessing the safety of a dapp / website | |
| - Warning your end-users from interacting with a potentially malicious website | |
| - Blocking websites | |
| ### Wallet watch API | |
| These APIs enable you to register users to Webacy's real-time notification infrastructure. | |
| If you're interested in setting up your own private instance with custom messaging and triggers,[ contact us](https://docs.webacy.com/other/contact-us). | |
anegg0
approved these changes
Dec 17, 2024
There was a problem hiding this comment.
Thank you for submitting your content, @cvince , and I apologize for the delay.
I batched all my changes into one suggestion, as there are many minor grammar/form fixes. I didn't change the substance in any way.
I'm approving it as such, but I would suggest merging my suggestions to make the article fit with OffchainLabs docs requirements.
As said earlier, please make sure to update your branch, or I won't be able to merge it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.