Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coboglobal/cobo-js-api
Cobo Custody JavaScript SDK
https://github.com/coboglobal/cobo-js-api
bitcoin blockchain cryptocurrency custody
Last synced: 2 months ago
JSON representation
Cobo Custody JavaScript SDK
- Host: GitHub
- URL: https://github.com/coboglobal/cobo-js-api
- Owner: CoboGlobal
- License: gpl-2.0
- Created: 2021-06-22T07:34:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T06:58:00.000Z (9 months ago)
- Last Synced: 2024-05-17T20:15:34.921Z (8 months ago)
- Topics: bitcoin, blockchain, cryptocurrency, custody
- Language: TypeScript
- Homepage: https://cobo.com/custody
- Size: 1.07 MB
- Stars: 2
- Watchers: 1
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# The Official JavaScript SDK for Cobo WaaS API
[](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
[]()
## About
This repository contains the official JavaScript SDK for Cobo WaaS API, enabling developers to integrate with Cobo's Custodial
and/or MPC services seamlessly using the JavaScript programming language.
## Documentation
To access the API documentation, navigate to
the [API references](https://www.cobo.com/developers/api-references/overview/).
For more information on Cobo's JavaScript SDK, refer to
the [JavaScript SDK Guide](https://www.cobo.com/developers/sdks-and-tools/sdks/waas/javascript).
## Usage
### Before You Begin
Ensure that you have created an account and configured Cobo's Custodial and/or MPC services.
For detailed instructions, please refer to
the [Quickstart](https://www.cobo.com/developers/get-started/overview/quickstart) guide.
### Requirements
Node.js v10.18.0 or newer.
### Installation
add dependency in package.json
```json
{
"dependencies": {
"cobo-custody": "https://github.com/CoboGlobal/cobo-js-api/releases/download/v0.53.0/release.tgz"
}
}
```
### Code Sample
#### Generate Key Pair
```javascript
const { LocalSigner } = require('cobo-custody');
const keyPair = LocalSigner.newKeyPair();
console.log(keyPair["privKey"]);
console.log(keyPair["pubKey"]);
```
For more information on the API key, please [click here](https://www.cobo.com/developers/api-references/overview/authentication).
#### Initialize ApiSigner
`ApiSigner` can be instantiated through
```javascript
const { LocalSigner } = require("cobo-custody");
const signer = new LocalSigner(keyPair["privKey"]);
```
In certain scenarios, the private key may be restricted from export, such as when it is stored in AWS Key Management Service (KMS).
In such cases, please pass in a custom implementation using the ApiSigner interface:
#### Initialize RestClient
```javascript
const { Client } = require('cobo-custody');
const { LocalSigner } = require('cobo-custody');
const {DEV,PROD} = require('cobo-custody');
const client = new Client(API_SIGNER, DEV, true)
```
#### Complete Code Sample
```javascript
const { Client } = require('cobo-custody');
const { LocalSigner } = require('cobo-custody');
const {DEV,PROD} = require('cobo-custody');
const keyPair = LocalSigner.newKeyPair();
console.log(keyPair["privKey"]);
console.log(keyPair["pubKey"]);
const signer = new LocalSigner(keyPair["privKey"]);
const client = new Client(keyPair["privKey"], DEV, true)
const res = client.getAccountInfo();
console.log(res)
```