Which API Do You Need?
To use the CASPUnbound’s Crypto Asset Security Platform (“CASP”) provides the advanced
technology and the architecture to secure crypto asset transactions. API, follow these steps:
- Select the implementation scenario of the CASP
Unbound’s Crypto Asset Security Platform (“CASP”) provides the advanced technology and the architecture to secure crypto asset transactions. API that you need:
- If you want to use the built-in CASP
Unbound’s Crypto Asset Security Platform (“CASP”) provides the advanced technology and the architecture to secure crypto asset transactions. wallets (supporting Bitcoin, Ethereum, and ERC-20), use the Built-in Wallets API.
- If you want to implement your own full custom wallet and use CASP
Unbound’s Crypto Asset Security Platform (“CASP”) provides the advanced technology and the architecture to secure crypto asset transactions. for key protection and quorum
One or more groups, comprised of participants signing use the BYOW
Bring Your Own Wallet - support any coin or crypto asset type using the CASP APIs to control the vault and key operations. API.
- Read the General API Information.
- Consult the detailed API Reference for your implementation scenario.
Note
If you are designing for multiple coin types, it is possible that you use multiple implementation scenarios.
These implementation scenarios are explained in the following sections.
Built-in Wallets
CASPUnbound’s Crypto Asset Security Platform (“CASP”) provides the advanced
technology and the architecture to secure crypto asset transactions. provides built-in support for different wallets. A wallet contains a specific crypto currency that has its own associated ledger where transactions are recorded. CASP
Unbound’s Crypto Asset Security Platform (“CASP”) provides the advanced
technology and the architecture to secure crypto asset transactions. supports the following wallets:
- btc - bitcoin.
- btctest - bitcoin Testnet3.
- eth - Ethereum.
- ethtest - Ethereum testnet, for networks supported by Infura.
- ERC-20 - Ethereum and Ethereum testnet blockchain tokens that are compliant with ERC-20. A list of supported tokens can be found here.
See the CASP User Guide for information on how to configure these wallets.
Built-in Wallets with Custom Chain Connectors
CASPUnbound’s Crypto Asset Security Platform (“CASP”) provides the advanced
technology and the architecture to secure crypto asset transactions. provides plugins that can be adapted to different types of crypto asset
Digital information that needs to be securely stored. ledgers.
Prerequisites
- Node-js 10.17.0
- typescript (run
npm i -g typescript
) - ts-node (run
npm i -g ts-node
) - Unbound Wallet GitHub repository - contact Unbound Support to get access.
Note
The links in the following steps only work after you have access to the GitHub repository.
Setup and Sanity Test
- Clone the repository:
- Navigate to the wallets directory that you downloaded.
- Install the project.
- Run the sanity tests. All should pass.
git clone https://github.com/unboundsecurity/wallets
cd wallets
npm i
npm test
To add your own plugin, please follow these steps:
- Create a folder under
src/blockchainProviders
with the new chain connector name. For example:src/blockchainProviders/xrp
- Create a file implementing BlockchainProvider, such as
XrpProvider.js
. This file should export one class, which is the blockchainProvider that implements_getLedgers()
andgetId()
. - Create an
index.js
file in the provider folder that references and exports your blockchain provider file. - Implement one or more instances of LedgerAdaptor and return them from
_getLedgers()
in your provider. - Edit the configuration file and add your provider under
chainProviders
. - Change the
useLedger
attribute in your configuration file to the specific ledger name that you want to use. For example:XRP-TEST
. A ledger with that ID must be returned fromgetLedgers
from your chain connector. - Run the demo.
Navigate to the src directory.
cd src
Create your configuration file by copying the template in
/config/cli/config.js
and adding configuration for your chain connector.Run:
node ./cli.js --config=<path-to-your-config-file>
If no config is specified, the default config file in /config/cli/config.js is used.
Follow the instructions on the screen. The demo is designed to require minimal input from the user.
Refer to the README in Github for more information.
Bring Your Own Wallet (BYOW)
CASPUnbound’s Crypto Asset Security Platform (“CASP”) provides the advanced
technology and the architecture to secure crypto asset transactions. provides the necessary APIs so that you can bring your own wallet (BYOW
Bring Your Own Wallet - support any coin or crypto asset type using the CASP APIs to control the vault and key operations.), meaning that you can use whatever ledger you have, and control the vault and key operations with CASP
Unbound’s Crypto Asset Security Platform (“CASP”) provides the advanced
technology and the architecture to secure crypto asset transactions.. Using BYOW
Bring Your Own Wallet - support any coin or crypto asset type using the CASP APIs to control the vault and key operations., you can create an implementation that can handle any coin type, as well as any special operations that you use to communicate with your ledger and for ledger processing.
You may want to use BYOWBring Your Own Wallet - support any coin or crypto asset type using the CASP APIs to control the vault and key operations. when using one of the built-in wallets, but need other features, such as using your own nodes and address caching. You may already have management in your application for one of the built-in wallets and want to use CASP
Unbound’s Crypto Asset Security Platform (“CASP”) provides the advanced
technology and the architecture to secure crypto asset transactions. for key management and protection. BYOW
Bring Your Own Wallet - support any coin or crypto asset type using the CASP APIs to control the vault and key operations. provides the flexibility to be used with any blockchain application.
In these scenarios CASPUnbound’s Crypto Asset Security Platform (“CASP”) provides the advanced
technology and the architecture to secure crypto asset transactions. handles key management, protection and signing operations based on the quorum
One or more groups, comprised of participants specification. It is your responsibility to manage:
- Blockchain communication
- Building transactions
- Balance management and retrieval
Setup the basic system components, accounts and participants, using the CASPUnbound’s Crypto Asset Security Platform (“CASP”) provides the advanced
technology and the architecture to secure crypto asset transactions. APIs. Once the relevant participants exist, you can start creating your own vaults.