Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
3623429
Refs: First draft of billing guide and how billing is done concept up…
shaloo Feb 23, 2023
00b232d
Merge branch 'dev' into shaloo/AR-5683-billing
shaloo Feb 27, 2023
ff49e2b
Merge branch 'dev' into shaloo/AR-5683-billing
shaloo Feb 28, 2023
424bef6
Merge branch 'shaloo/AR-5683-billing' into shaloo/AR-5710-billing-update
shaloo Mar 2, 2023
353eed9
Fix: #AR-5710 billing and invoice implementation updates
shaloo Mar 2, 2023
61c65c8
cleanup
shaloo Mar 2, 2023
9e44615
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 2, 2023
d06cbca
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 7, 2023
7941552
Fix: #AR-5717 show wallet update
shaloo Mar 8, 2023
ebb9621
update dictionary
shaloo Mar 8, 2023
678eba3
RN updated for mobile view bug fix for the Arcana wallet
shaloo Mar 8, 2023
707ce12
wallet width note added to RN
shaloo Mar 8, 2023
118a2ca
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 8, 2023
f8bd00d
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 8, 2023
ad0f953
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 8, 2023
32b6a96
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 13, 2023
e164aa9
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 16, 2023
fad1a78
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 28, 2023
e0ba970
billing updates
shaloo Mar 28, 2023
4863c77
billing cleanup
shaloo Mar 28, 2023
6ce609e
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 28, 2023
ba7d0a7
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 28, 2023
5095749
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Mar 31, 2023
13299e1
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Apr 3, 2023
c4986be
Billing cleanup for notifications
shaloo Apr 3, 2023
7d09035
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Apr 3, 2023
27fe075
typo fix
shaloo Apr 3, 2023
1187382
typo fix
shaloo Apr 3, 2023
4403d16
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Apr 5, 2023
ccdcb7b
Remove billing error for address
shaloo Apr 6, 2023
3ad7409
Merge branch 'dev' into shaloo/AR-5710-billing-update
shaloo Apr 8, 2023
101e301
Update billing address and payment method form changes
shaloo Apr 10, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/concepts/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ The following billing notifications are displayed:
TBD
Link the billing errors list here and also link the Troubleshooting guide section on Billing errors.

-->
-->
2 changes: 2 additions & 0 deletions docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ These are the building blocks to help you learn about various {{config.extra.arc

[Auth Types :material-clipboard-text-search-outline:](authtype/index.md){ .md-button }

[Billing :fontawesome-solid-money-check-dollar:](billing.md){ .md-button }

[Dashboard :material-monitor-dashboard:](dashboard.md){ .md-button }

[DKG :material-key-plus:](dkg/index.md){ .md-button }
Expand Down
70 changes: 66 additions & 4 deletions docs/db/config_dApp_with_db.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This guide will walk you through the various configuration options available on

!!! info "{{config.extra.arcana.app_address}}"

The {{config.extra.arcana.app_address}} assigned to your application can be found on the top right of the {{config.extra.arcana.dashboard_name}} screen. ![Dashboard Client Identifier](/img/an_db_app_address.png){.an-screenshots}
The {{config.extra.arcana.app_address}} assigned to your application can be found on the top right of the {{config.extra.arcana.dashboard_name}} screen. ![App Client Identifier](/img/an_db_app_address.png){.an-screenshots}

### Manage Configurations

Expand Down Expand Up @@ -153,9 +153,9 @@ Developers can monitor their registered application usage statistics via the {{c

#### Account Usage Metrics

The *Manage Apps* screen displays Monthly Active Users (MAU) for the developer account. This is an aggregate score across all the applications that are registered for a dev account and configured to use the {{config.extra.arcana.company_name}} Mainnet. Any application using the 'Testnet' are not billed and not included in this overall account usage statistic.
The *Manage Apps* screen displays Monthly Active Users (MAU) for the developer account. This is an aggregate score across all the applications that are registered for a developer account and configured to use the {{config.extra.arcana.company_name}} Mainnet. Any application using the 'Testnet' are not billed and not included in this overall account usage statistic.

![Dashboard metrics](/img/an_db_metrics.png){.an-screenshots}
![App usage metrics](/img/an_db_metrics.png){.an-screenshots}

!!! caution

Expand All @@ -177,11 +177,73 @@ You can use the dropdown in the top right of the application dashboard screen to

![Application Usage Stats Mainnet](/img/an_db_app_usage_metrics_mainnet_anim.gif){.an-screenshots}

### Billing

{{config.extra.arcana.company_name}} tracks the Mainnet app usage for every developer account in terms of MAU. Invoices are generated at the end of each month and the chargeable amount is auto-deducted using the payment method configured by the developer in their profile section. See [billing and pricing]({{page.meta.arcana.root_rel_path}}/concepts/billing.md) for details.

To begin using the {{config.extra.arcana.sdk_name}}, the app developers don't need to update the profile details including the billing information. Once the apps consume the free tier of {{config.extra.arcana.company_name}} Mainnet usage, the developer must provide the billing details via the profile section of the {{config.extra.arcana.dashboard_name}}. Otherwise, the registered apps will be suspended and users will not be allowed to log in to any app that is registered using the developer account.

#### Set up Payment Method

Click on the user icon on the top right of the {{config.extra.arcana.dashboard_name}} screen. Select **Profile** in the dropdown.

![Application Usage Stats Mainnet](/img/an_db_billing_nav.png){.an-screenshots}

You will see the developer's {{config.extra.arcana.company_name}} account profile details. The developer account **name** and **public identifier** (email) are automatically retrieved based on the account used to log into the {{config.extra.arcana.dashboard_name}}.

Developers are required to update the following profile details and then click **Save**.

* Organization
* Billing Address Details
* Payment Method

![Application Usage Stats Mainnet Billing Profile](/img/an_db_billing_profile.gif){.an-screenshots}

!!! note "Payment Method"

By default, the 'Payment Method' section is disabled.

Enter the billing address details and click **Save**. The payment method section is enabled for input only after the billing address details are provided.

#### View Invoices

Click on the user icon on the top right of the {{config.extra.arcana.dashboard_name}} screen. Select **Invoices** in the dropdown.

![Application Usage Stats Mainnet](/img/an_db_invoices_nav.png){.an-screenshots}

On the **Invoices** page, you will see the details of the current pending dues followed by the billing history of previous invoices that can be downloaded for reference.

![Application Usage Stats Mainnet](/img/an_db_invoices_details.png){.an-screenshots}

#### View Billing Notifications

Click the bell icon to view all notifications for the developer account. Check the [billing notifications]({{page.meta.arcana.root_rel_path}}/concepts/billing.md#notifications) list for details.

![Developer account notifications](/img/an_db_notifications_nav.png){.an-screenshots}

<!---

![Billing methods and details](/img/an_db_billing_method_details.png)

#### View Billing History

Refer to the 'Billing Details' screen. The 'Estimated Charges' section on the bottom displays a link to view the billing history and download invoices.

![Billing history](/img/an_db_billing_history.png)

#### Pay Bills

To pay the Arcana Network dues, developers can refer to the 'Estimated Charges' section on the bottom right of the 'Billing Details' screen. Click **Continue** to view invoice details and pay the bill.

![Pay Dues](/img/an_db_billing_dues.png)

-->

### Delete Application

To de-register an application the developers must delete the entry using the {{config.extra.arcana.dashboard_name}}. Go to the 'Manage Apps' dashboard page which lists all the registered applications.

![Manage Apps Dashboard](/img/an_db_manage_apps.png){.an-screenshots}
![Manage Apps Screen](/img/an_db_manage_apps.png){.an-screenshots}

Select the application you wish to de-register and choose **Delete**.

Expand Down
Binary file added docs/img/an_db_billing_allapps_MAU.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/an_db_billing_dues.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/an_db_billing_history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/an_db_billing_method_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/an_db_billing_nav.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/an_db_billing_profile.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/an_db_invoices_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/an_db_invoices_nav.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/an_db_notifications_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/an_db_notifications_nav.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ Welcome to **{{config.extra.arcana.product_name }}** documentation!

==}

{{config.extra.arcana.product_name}} consists of two components:

* {{config.extra.arcana.sdk_name}}
* {{config.extra.arcana.dashboard_name}}

Use {{config.extra.arcana.product_name}} to easily onboard users to Web3 apps through the familiar Web2 authentication providers. The authenticated users can instantly access the embedded, non-custodial {{config.extra.arcana.wallet_name}} and sign blockchain transactions.

Designed for developers and Web3 users, {{config.extra.arcana.product_name}} is easy to integrate and offers a simple yet secure, and customizable user experience for signing blockchain transactions. It is powered by cutting-edge cryptographic algorithms and a built-in _distributed key generation subsystem_ that ensures no single entity owns or manages the user's keys.

!!! note "Already using {{config.extra.arcana.product_name}}?"

{% include "./text-snippets/warn_latest_sdk_version.md" %}

{{config.extra.arcana.product_name}} consists of two components:

* {{config.extra.arcana.sdk_name}}
* {{config.extra.arcana.dashboard_name}}

## {{config.extra.arcana.sdk_name}}

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,4 +281,4 @@ For a complete sample app that addresses polyfill issues - refer to [sources in

While an app is switching over from the default 'app-specific' keys configuration to the 'global keys' configuration, the developer may choose to allow app users to log in before the global features option is approved. Users that log in before the global keys are approved will be assigned 'app-specific' keys. There is some part of key metadata that is stored locally in the authenticated user's device. In this case, once the feature gets **approved**, the user keys are re-assigned. The keys change from 'app-specific' to 'global keys' and this results in new key metadata. There is a mismatch between the keys or {{config.extra.arcana.walket_name}} addresses already in use by the users and the new global keys that are now reconfigured for the app users. As a result, users will not be able to log in to the app anymore.

To fix this issue, the user needs to clear the local storage used by the {{config.extra.arcana.wallet_name}} on their device by clearing the browser cache and then attempting another login from a fresh browser window.
To fix this issue, the user needs to clear the local storage used by the {{config.extra.arcana.wallet_name}} on their device by clearing the browser cache and then attempting another login from a fresh browser window.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ nav:
- Social Providers: concepts/authtype/socialauth.md
- Custom IAM Providers: concepts/authtype/customauth.md
- Passwordless: concepts/authtype/pwdless.md
- Usage & Billing: concepts/billing.md
- Dashboard: concepts/dashboard.md
- DKG:
- concepts/dkg/index.md
Expand Down