Sign in now

Apps

Last updated: May 29, 2019

XLDB

Xooa Ledger Database (XLDB) is comprised of two databases: A mutable, document datastore called the State Database (or World State), and an immutable database called the transaction database or simply Ledger. The Ledger is append only, and is cryptographically protected against modifications using blockchain technology.

XLDB World State

World State provides:

  • Access to the state database of XLDB.
  • Allows to search the state database using key or value.
  • Create a new transaction. It will create a new key-value pair and reflect in the World State.
  • Check the history of values for the associated key of world state.

XLDB Transactions

The transactions tab allows to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, transaction id and date range
    • Key

      The key used to save the data in the ledger.

    • Value

      The value saved in the ledger.

    • Is Deleted

      Denotes if the transaction was to delete the value from the ledger.

    • Updated At

      The time at which the transaction was made.

    • tx ID

      A unique transaction ID of the current transaction.

XLDB API

API Documentation

  • API Endpoint

    Endpoint for calling functions in the smart contract.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • APIs

    Test the API endpoints for XLDB upon authorizing using identity API token

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

XLDB Activities

Provides a history of activity related to the app. Activities include things like redeploying the app, identity-related actions, and upgrades.

XLDB Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • Delete identities: Available only for identities not generated from XLDB integrations
  • Update identities: Available only for identities not generated from XLDB integrations
  • Regenerate an API key for an identity: Available only for identities not generated from XLDB integrations
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always create identities with write access to the ledger.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.

Asset management

The asset management is a Xooa managed smart contract app. It provides the APIs to maintain the assets and their ownership. An asset comprises of mutable and immutable components which are asset details and asset properties respectively.

Asset World State

World State provides:

  • Access to the state database of Asset Management ledger. It includes the latest owners and asset details
  • Allows to search the state database using key or value.
  • Check the history of values for the associated key of world state.

Asset Transactions

The transactions tab allows to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value and date range
    • Key

      The key can be owner or asset id.

    • Value

      The value contains the detail about the asset and the owner.

    • Updated At

      The time at which the transaction was made.

    • tx ID

      A unique transaction ID of the current transaction.

Asset API

API Documentation

  • API Endpoint

    Endpoint for calling functions in the smart contract for managing assets.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • APIs

    Test the API endpoints for managing assets upon authorizing using identity API token

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

Asset Activities

Provides a history of activity related to the app. Activities include things like redeploying the app, identity-related actions, and upgrades.

Asset Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • View identities
  • Delete identities
  • Update identities
  • Regenerate an API key for an identity
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always create identities with write access to the ledger.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.
  • Public Key

    A public identifier of the identity. Use the public key to share with other participants to get assets transfered to you.

Custom Smart Contracts

SC Details

The Details tab provides information about your app. Some of the information is descriptive and some of it needed to identify the API endpoint for executing functions in the smart contract.

  • App ID

    Unique ID for this app.

  • App Name

    The display name of your app. The default value is in the Xooa.yaml file, but can be overridden .

  • Description

    Optional description. The default value is in the Xooa.yaml file, but can be overridden.

  • Readme

    Optional. The default value is in the Xooa.yaml file, but can be overridden.

  • Branch

    The GitHub branch from which the smart contract has been deployed.

  • Deployed Version

    A counter registering each upgrade of the app.

  • Blockchain Network

    Blockchain technology used to deploy your smart contract.

  • Smart Contract Language

    Programming language of the smart contract. The default value is in the Xooa.yaml file, but can be overridden.

SC World State

World State provides:

  • Access to the state database of the custom smart contract.
  • Allows to search the state database using key or value.
  • Check the history of values for the associated key of world state.

SC Transactions

The transactions tab allows to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, transaction id and date range
    • Key

      The key used to save the data in the ledger.

    • Value

      The value saved in the ledger.

    • Is Deleted

      Denotes if the transaction was to delete the value from the ledger.

    • Updated At

      The time at which the transaction was made.

    • tx ID

      A unique transaction ID of the current transaction.

SC API

API Documentation

  • API Endpoint

    Endpoint for calling functions in the smart contract.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • APIs

    Test the API endpoints for the custom smart contract upon authorizing using identity API token

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

SC Activities

Provides a history of activity related to the app. Activities include things like redeploying the app, identity-related actions, and upgrades.

SC Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • View identities
  • Delete identities
  • Update identities
  • Regenerate an API key for an identity
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always create identities with write access to the ledger.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.

SC Logs

View smart contract logs from the last 10 minutes. What events are logged depends on how you have coded your smart contract. Click here for details on Hyperledger Fabric’s logging.

SC Manage

Delete your app from xooa or update your app from GitHub.

Upgrade App

Refresh the app with the smart contract code currently in the GitHub repository used for creating this app.

Delete App

Deleting the app will remove the end point and related chaincode from Xooa. This operation is irreversible and you will never be able to access the app data again on Xooa. If you need to download the data, use an External Peer. External peers are not affected by this operation.

ERC20

The ERC20 is a Xooa managed smart contract app deployed on hyperledger fabric. It provides the APIs to create the tokens and transfer between participants. Each ERC20 token comprises of token name, symbol and total supply of tokens.

ERC20 World State

World State provides:

  • Access to the state database of ERC20. It includes the current balances of participants and the token details
  • Allows to search the state database using key or value.
  • Check the history of values for the associated key of world state.

ERC20 Transactions

The transactions tab allows to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, transaction id and date range
    • Key

      The key used to save the data in the ledger.

    • Value

      The value saved in the ledger.

    • Is Deleted

      Denotes if the transaction was to delete the value from the ledger.

    • Updated At

      The time at which the transaction was made.

    • Tx ID

      A unique transaction ID of the current transaction.

ERC20 API

API Documentation

  • API Endpoint

    Endpoint for calling functions in the smart contract.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • APIs

    Test the API endpoints for ERC20 upon authorizing using identity API token. Use these APIs to transfer tokens, approve the transfer of tokens or get various details and limits.

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

ERC20 Activities

Provides a history of activity related to the app. Activities include things like redeploying the app, identity-related actions, and upgrades.

ERC20 Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • View identities
  • Delete identities
  • Update identities
  • Regenerate an API key for an identity
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always create identities with write access to the ledger.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.
  • Public Key

    A public identifier of the identity. Use the public key to share with other participants to receive tokens.

ERC20 Manage

Delete App

Deleting the app will remove the end point and token from Xooa. This operation is irreversible and you will never be able to access the app and token data again on Xooa. If you need to download the data, use an External Peer. External peers are not affected by this operation.