Skip to content

Commit 1e476b3

Browse files
abdullahvenlyabdullahvenly
authored
Update index.md
1. Update on the name (previously Arkane), now called Venly. 2. Update the links to the correct documentation. 3. Correction of broken links. (as Venly is using a new documentation tool) 4. Update on the Initialization method, as the previous method was outdated. 5. Updated code samples for initialization.
1 parent 141b717 commit 1e476b3

File tree

1 file changed

+81
-28
lines changed

1 file changed

+81
-28
lines changed

‎docs/tools/wallets/venly/index.md‎

Lines changed: 81 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
!!! caution "Content disclaimer"
2-
Please view the third-party content disclaimer [here](https://github.com/0xPolygon/polygon-docs/blob/main/CONTENT_DISCLAIMER.md).
1+
!!! caution "Content disclaimer" Please view the third-party content disclaimer [here](https://github.com/0xPolygon/polygon-docs/blob/main/CONTENT_DISCLAIMER.md).
32

4-
Venly (prev. Arkane Network) allows you to easily integrate your app to the Polygon blockchain, whether you already have an app integrated with Web3 or are building a new app from scratch. Venly provides a smooth and delightful experience for you and your users on both web & mobile.
3+
**Venly** allows you to easily integrate your app to the Polygon blockchain, whether you already have an app integrated with Web3 or are building a new app from scratch. Venly provides a smooth and delightful experience for you and your users on both web & mobile.
54

6-
Venly will help you in interacting with the Polygon network, create blockchain wallets, create different asset types such as fungible (ERC20), and non-fungible tokens (ERC721 and ERC1155) and interact with smart contracts. Next to a superior developer experience, you can give your users a user-friendly interface.
5+
Venly will help you interact with the Polygon network, create blockchain wallets, create different asset types such as fungible (ERC20), and non-fungible tokens (ERC721 and ERC1155), and interact with smart contracts. Next to a superior developer experience, you can give your users a user-friendly interface.
76

8-
Each application is unique and has different needs, therefore they provide different ways of interacting with Venly. We recommend that web3 applications integrate the [Venly web3 provider](https://docs.venly.io/widget/web3-provider/getting-started), others may use the [Venly Widget](https://docs.venly.io/docs/widget-overview).
7+
Each application is unique and has different needs, providing different ways of interacting with Venly. We recommend that web3 applications integrate the [Venly web3 provider](https://docs.venly.io/docs/web3js), others may use the [Venly Widget](https://docs.venly.io/docs/widget-overview).
98

109
## Key Features
1110

@@ -18,50 +17,104 @@ Each application is unique and has different needs, therefore they provide diffe
1817
- Built for a mainstream audience.
1918
- Offers in-app customer support.
2019

21-
## Getting Started
20+
## Getting Started 🎉
2221

23-
If you already support Web3 technology, you can improve the UX within your application by integrating the **Venly Web3 Provider**, a smart wrapper around the existing Web3 Ethereum JavaScript API.
22+
If you already support Web3 technology, you can improve your application's UX by integrating the [Venly Web3 Provider](https://docs.venly.io/docs/web3js), a smart wrapper around the existing Web3 Ethereum JavaScript API.
2423

25-
By making use of our Web3 provider you are able to leverage the full potential of Venly with minimal effort and you will be able to onboard users that are less tech savvy without making them leave your application or download third party plugins. Integrating just takes 2 steps and ~5 minutes.
24+
By using our [Web3 provider](https://docs.venly.io/docs/web3js), you can leverage the full potential of Venly with minimal effort, and you will be able to onboard less tech-savvy users without making them leave your application or download third-party plugins. Integrating just takes two steps and 5 minutes!
2625

27-
!!! tip
28-
Venly provides a [Venly Widget](https://docs.venly.io/widget/) to help developers generate Web 3 support to their applications.
26+
**Don't support Web3 yet?**
2927

30-
### Add the library to your project
28+
> Don't worry we've got you covered with our 📦 [Venly - Widget](https://docs.venly.io/docs/widget-overview).
3129
32-
Install the library by downloading it to your project via NPM.
30+
### Step 1: Add the library to your project
3331

34-
```sh
32+
Install the library by downloading it to your project via NPM
33+
34+
```javascript
3535
npm i @venly/web3-provider
3636
```
3737

38-
Add the script to the head of your page.
38+
Alternatively, you could also include the library directly from a CDN
3939

40-
```js
41-
<script src="/node_modules/@venly/web3-provider/dist/web3-provider.js"></script>
40+
```javascript
41+
<script src="https://unpkg.com/@venly/web3-provider/umd/index.js"></script>
4242
```
4343

44-
After adding the javascript file to your page, a global **Venly** object is added to your window. This object is the gateway for creating the Web3 wrapper and fully integrates the widget - Venly Connect.
44+
```javascript
45+
<script src="https://cdn.jsdelivr.net/npm/@venly/web3-provider/umd/index.js"></script>
46+
```
4547

46-
### Initialize the Web3 provider
48+
## Step 2: Initialize the web3 provider
4749

4850
Add the following lines of code to your project, it will load the Venly web3 provider.
4951

50-
```js
51-
Venly.createProviderEngine({clientId: 'Testaccount'}).then(provider => {
52-
web3 = new Web3(provider);
53-
});
52+
### Simple:
53+
54+
```javascript
55+
import Web3 from 'web3';
56+
import { VenlyProvider } from '@venly/web3-provider';
57+
58+
const Venly = new VenlyProvider();
59+
const options: VenlyProviderOptions = {
60+
clientId: 'YOUR_CLIENT_ID'
61+
};
62+
63+
const provider = await Venly.createProvider(options);
64+
const web3 = new Web3(provider);
65+
```
66+
67+
### Advanced:
68+
69+
```javascript
70+
import Web3 from 'web3';
71+
import { VenlyProvider } from '@venly/web3-provider';
72+
73+
const Venly = new VenlyProvider();
74+
const options = {
75+
clientId: 'YOUR_CLIENT_ID',
76+
environment: 'staging', //optional, production by default
77+
signMethod: 'POPUP', //optional, REDIRECT by default
78+
bearerTokenProvider: () => 'obtained_bearer_token', //optional, default undefined
79+
//optional: you can set an identity provider to be used when authenticating
80+
authenticationOptions: {
81+
idpHint: 'google'
82+
},
83+
secretType: 'ETHEREUM' //optional, ETHEREUM by default
84+
};
85+
86+
const provider = await Venly.createProvider(options);
87+
const web3 = new Web3(provider);
5488
```
5589

56-
The web3 instance now works as if it was injected by Parity or Metamask. You can fetch wallets, sign transactions, and messages.
90+
You can fetch wallets, and sign transactions, and messages.
5791

58-
**Congratulations! Your dApp now supports Venly.**
92+
> 👍
93+
>
94+
> Congratulations, your dapp now supports Venly 🎉
95+
>
96+
> Ready to try out the Wallet-Widget? [Click here to get started](https://docs.venly.io/docs/widget-getting-started).
5997
60-
!!! info
61-
To connect with a personalised [Client ID](https://docs.venly.io/widget/deep-dive/authentication#client-id), and access our production environment, please request access one using this [form](https://forms.venly.io/clientID).
98+
> 📘
99+
>
100+
> Want to know more about the wonderful world Venly has to offer, [check out their documentation](https://docs.venly.io/docs/widget-overview)
62101
63102
## More about Venly
64103

65-
What makes Venly (prev. Arkane) stand out is their commitment to supporting the ecosystem. Not only their wallet users, by explaining what gas is, or by helping them import an Ethereum wallet into Polygon, but also the developers that are using Venly to build new upcoming products.
104+
**Venly** stands out because of its commitment to supporting the ecosystem. Not only their wallet users, by explaining what gas is, or by helping them import an Ethereum wallet into Polygon, but also the developers that are using Venly to build new upcoming products.
105+
106+
At Venly, we offer a diverse range of products spanning various categories, including Wallet Solutions, NFT Tools, and Marketplaces. Let's begin with a brief overview of these three product categories:
107+
108+
[Wallet Solutions](https://docs.venly.io/docs/wallet-api-overview): Empower your users by providing them with a wallet or seamlessly integrating the Venly wallet into your application.
109+
110+
[NFT Tools](https://docs.venly.io/docs/nft-api-overview): Facilitate the creation and distribution of NFTs, along with fetching comprehensive NFT data and information.
111+
112+
[Marketplaces](https://docs.venly.io/docs/market-api-overview): Build your own NFT marketplace or list your NFT collection on our existing marketplace.
113+
114+
Even in their test environments, they add an in-app chat so that developers can directly communicate with the team behind the Venly platform. In case you want to learn more, check out their [detailed product documentation](https://docs.venly.io/docs/getting-started-with-venly).
115+
116+
## Resources:
66117

67-
Even in their test environments, they add an in-app chat so that developers can directly communicate with the team behind the Venly platform. In case you want to learn more, check out their [detailed product documentation](https://docs.venly.io/widget/).
118+
- [Venly Widget](https://docs.venly.io/docs/widget-overview)
119+
- [Web3 Wallet Providers](https://docs.venly.io/docs/ethersjs)
120+
- [Web3.js](https://docs.venly.io/docs/web3js)

0 commit comments

Comments
 (0)