Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@cobo/cobo-waas2

Package Overview
Dependencies
Maintainers
0
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@cobo/cobo-waas2

The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo’s WaaS API offering. It enables you to access Cobo’s full suite of crypto wallet technologies with powerful and flexible access controls. By encapsulating complex security protocols

  • 1.6.0
  • latest
  • npm
  • Socket score

Version published
Maintainers
0
Created
Source

cobo-waas2-js-sdk

CoboWaas2 - JavaScript client for cobo-waas2-js-sdk The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo’s WaaS API offering. It enables you to access Cobo’s full suite of crypto wallet technologies with powerful and flexible access controls. By encapsulating complex security protocols and streamlining blockchain interactions, this API allows you to concentrate on your core business activities without worrying about the safety of your assets. The WaaS 2.0 API presents the following key features:

  • A unified API for Cobo’s all four wallet types
  • Support for 80+ chains and 3000+ tokens
  • A comprehensive selection of webhook events
  • Flexible usage models for MPC Wallets, including Organization-Controlled Wallets and User-Controlled Wallets
  • Programmatic control of smart contract wallets such as Safe{Wallet} with fine-grained access controls
  • Seamlessly transfer funds across multiple exchanges, including Binance, OKX, Bybit, Deribit, and more

For more information about the WaaS 2.0 API, see Introduction to WaaS 2.0.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v2
  • Package version: 1.6.0
  • Generator version: 7.6.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.cobo.com/waas

Installation

npm install @cobo/cobo-waas2 --save

Getting Started

Please follow the installation instruction and execute the following JS code:

const CoboWaas2 = require('@cobo/cobo-waas2');
// initial default api client
const apiClient = CoboWaas2.ApiClient.instance
// for dev env
// apiClient.setEnv(CoboWaas2.Env.DEV);
apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
// call api
const apiInstance = new CoboWaas2.WalletsApi();
const opts = {
  'wallet_type': new CoboWaas2.WalletType().Custodial,
  'wallet_subtype': new CoboWaas2.WalletSubtype().Asset,
  'chain_ids': "BTC,ETH",
  'limit': 10,
  'before': "",
  'after': ""
};
apiInstance.listSupportedChains(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.dev.cobo.com/v2

ClassMethodHTTP requestDescription
CoboWaas2.AddressBooksApilistAddressBooksGET /address_booksList address book entries
CoboWaas2.DevelopersApigetApiKeyInfoGET /developers/api_key_infoGet API key information
CoboWaas2.DevelopersWebhooksApicreateWebhookEndpointPOST /webhooks/endpointsRegister webhook endpoint
CoboWaas2.DevelopersWebhooksApigetWebhookEndpointByIdGET /webhooks/endpoints/{endpoint_id}Get webhook endpoint information
CoboWaas2.DevelopersWebhooksApigetWebhookEventByIdGET /webhooks/endpoints/{endpoint_id}/events/{event_id}Retrieve event information
CoboWaas2.DevelopersWebhooksApilistWebhookEndpointsGET /webhooks/endpointsList webhook endpoints
CoboWaas2.DevelopersWebhooksApilistWebhookEventDefinitionsGET /webhooks/events/definitionsGet webhook event types
CoboWaas2.DevelopersWebhooksApilistWebhookEventLogsGET /webhooks/endpoints/{endpoint_id}/events/{event_id}/logsList webhook event logs
CoboWaas2.DevelopersWebhooksApilistWebhookEventsGET /webhooks/endpoints/{endpoint_id}/eventsList all webhook events
CoboWaas2.DevelopersWebhooksApiretryWebhookEventByIdPOST /webhooks/endpoints/{endpoint_id}/events/{event_id}/retryRetry event
CoboWaas2.DevelopersWebhooksApitriggerTestWebhookEventPOST /webhooks/events/triggerTrigger test event
CoboWaas2.DevelopersWebhooksApiupdateWebhookEndpointByIdPUT /webhooks/endpoints/{endpoint_id}Update webhook endpoint
CoboWaas2.OAuthApigetTokenGET /oauth/tokenGet Org Access Token
CoboWaas2.OAuthApirefreshTokenPOST /oauth/tokenRefresh Org Access Token
CoboWaas2.StakingsApicreateStakeActivityPOST /stakings/activities/stakeCreate stake activity
CoboWaas2.StakingsApicreateUnstakeActivityPOST /stakings/activities/unstakeCreate unstake activity
CoboWaas2.StakingsApicreateWithdrawActivityPOST /stakings/activities/withdrawCreate withdraw activity
CoboWaas2.StakingsApigetStakingActivityByIdGET /stakings/activities/{activity_id}Get staking activity details
CoboWaas2.StakingsApigetStakingByIdGET /stakings/{staking_id}Get staking position details
CoboWaas2.StakingsApigetStakingEstimationFeePOST /stakings/estimate_feeEstimate staking fees
CoboWaas2.StakingsApigetStakingPoolByIdGET /stakings/pools/{pool_id}Get staking pool details
CoboWaas2.StakingsApilistStakingActivitiesGET /stakings/activitiesList staking activities
CoboWaas2.StakingsApilistStakingPoolsGET /stakings/poolsList staking pools
CoboWaas2.StakingsApilistStakingsGET /stakingsList staking positions
CoboWaas2.TransactionsApibroadcastSignedTransactionsPOST /transactions/broadcastBroadcast signed transactions
CoboWaas2.TransactionsApicancelTransactionByIdPOST /transactions/{transaction_id}/cancelCancel transaction
CoboWaas2.TransactionsApicheckLoopTransfersGET /transactions/check_loop_transfersCheck Cobo Loop transfers
CoboWaas2.TransactionsApicreateContractCallTransactionPOST /transactions/contract_callCall smart contract
CoboWaas2.TransactionsApicreateMessageSignTransactionPOST /transactions/message_signSign message
CoboWaas2.TransactionsApicreateTransferTransactionPOST /transactions/transferTransfer token
CoboWaas2.TransactionsApidropTransactionByIdPOST /transactions/{transaction_id}/dropDrop transaction
CoboWaas2.TransactionsApiestimateFeePOST /transactions/estimate_feeEstimate transaction fee
CoboWaas2.TransactionsApigetTransactionByIdGET /transactions/{transaction_id}Get transaction information
CoboWaas2.TransactionsApilistTransactionsGET /transactionsList all transactions
CoboWaas2.TransactionsApiresendTransactionByIdPOST /transactions/{transaction_id}/resendResend transaction
CoboWaas2.TransactionsApispeedupTransactionByIdPOST /transactions/{transaction_id}/speedupSpeed up transaction
CoboWaas2.WalletsApicheckAddressChainsValidityGET /wallets/check_address_chains_validityCheck address validity across chains
CoboWaas2.WalletsApicheckAddressValidityGET /wallets/check_address_validityCheck address validity
CoboWaas2.WalletsApicheckAddressesValidityGET /wallets/check_addresses_validityCheck addresses validity
CoboWaas2.WalletsApicreateAddressPOST /wallets/{wallet_id}/addressesCreate addresses in wallet
CoboWaas2.WalletsApicreateWalletPOST /walletsCreate wallet
CoboWaas2.WalletsApideleteWalletByIdPOST /wallets/{wallet_id}/deleteDelete wallet
CoboWaas2.WalletsApigetChainByIdGET /wallets/chains/{chain_id}Get chain information
CoboWaas2.WalletsApigetMaxTransferableValueGET /wallets/{wallet_id}/max_transferable_valueGet maximum transferable value
CoboWaas2.WalletsApigetTokenByIdGET /wallets/tokens/{token_id}Get token information
CoboWaas2.WalletsApigetWalletByIdGET /wallets/{wallet_id}Get wallet information
CoboWaas2.WalletsApilistAddressesGET /wallets/{wallet_id}/addressesList wallet addresses
CoboWaas2.WalletsApilistEnabledChainsGET /wallets/enabled_chainsList enabled chains
CoboWaas2.WalletsApilistEnabledTokensGET /wallets/enabled_tokensList enabled tokens
CoboWaas2.WalletsApilistSupportedChainsGET /wallets/chainsList supported chains
CoboWaas2.WalletsApilistSupportedTokensGET /wallets/tokensList supported tokens
CoboWaas2.WalletsApilistTokenBalancesForAddressGET /wallets/{wallet_id}/addresses/{address}/tokensList token balances by address
CoboWaas2.WalletsApilistTokenBalancesForWalletGET /wallets/{wallet_id}/tokensList token balances by wallet
CoboWaas2.WalletsApilistUtxosGET /wallets/{wallet_id}/utxosList UTXOs
CoboWaas2.WalletsApilistWalletsGET /walletsList all wallets
CoboWaas2.WalletsApilockUtxosPOST /wallets/{wallet_id}/utxos/lockLock UTXOs
CoboWaas2.WalletsApiunlockUtxosPOST /wallets/{wallet_id}/utxos/unlockUnlock UTXOs
CoboWaas2.WalletsApiupdateWalletByIdPUT /wallets/{wallet_id}Update wallet
CoboWaas2.WalletsExchangeWalletApilistAssetBalancesForExchangeWalletGET /wallets/{wallet_id}/exchanges/assetsList asset balances
CoboWaas2.WalletsExchangeWalletApilistExchangesGET /wallets/exchangesList supported exchanges
CoboWaas2.WalletsExchangeWalletApilistSupportedAssetsForExchangeGET /wallets/exchanges/{exchange_id}/assetsList supported assets
CoboWaas2.WalletsExchangeWalletApilistSupportedChainsForExchangeGET /wallets/exchanges/{exchange_id}/assets/{asset_id}/chainsList supported chains
CoboWaas2.WalletsMPCWalletsApicancelTssRequestByIdPOST /wallets/mpc/vaults/{vault_id}/tss_requests/{tss_request_id}/cancelCancel TSS request
CoboWaas2.WalletsMPCWalletsApicreateKeyShareHolderGroupPOST /wallets/mpc/vaults/{vault_id}/key_share_holder_groupsCreate key share holder group
CoboWaas2.WalletsMPCWalletsApicreateMpcProjectPOST /wallets/mpc/projectsCreate project
CoboWaas2.WalletsMPCWalletsApicreateMpcVaultPOST /wallets/mpc/vaultsCreate vault
CoboWaas2.WalletsMPCWalletsApicreateTssRequestPOST /wallets/mpc/vaults/{vault_id}/tss_requestsCreate TSS request
CoboWaas2.WalletsMPCWalletsApideleteKeyShareHolderGroupByIdPOST /wallets/mpc/vaults/{vault_id}/key_share_holder_groups/{key_share_holder_group_id}/deleteDelete key share holder group
CoboWaas2.WalletsMPCWalletsApigetKeyShareHolderGroupByIdGET /wallets/mpc/vaults/{vault_id}/key_share_holder_groups/{key_share_holder_group_id}Get key share holder group information
CoboWaas2.WalletsMPCWalletsApigetMpcProjectByIdGET /wallets/mpc/projects/{project_id}Get project information
CoboWaas2.WalletsMPCWalletsApigetMpcVaultByIdGET /wallets/mpc/vaults/{vault_id}Get vault information
CoboWaas2.WalletsMPCWalletsApigetTssRequestByIdGET /wallets/mpc/vaults/{vault_id}/tss_requests/{tss_request_id}Get TSS request
CoboWaas2.WalletsMPCWalletsApilistCoboKeyHoldersGET /wallets/mpc/cobo_key_share_holdersList all Cobo key share holders
CoboWaas2.WalletsMPCWalletsApilistKeyShareHolderGroupsGET /wallets/mpc/vaults/{vault_id}/key_share_holder_groupsList all key share holder groups
CoboWaas2.WalletsMPCWalletsApilistMpcProjectsGET /wallets/mpc/projectsList all projects
CoboWaas2.WalletsMPCWalletsApilistMpcVaultsGET /wallets/mpc/vaultsList all vaults
CoboWaas2.WalletsMPCWalletsApilistTssRequestsGET /wallets/mpc/vaults/{vault_id}/tss_requestsList TSS requests
CoboWaas2.WalletsMPCWalletsApiupdateKeyShareHolderGroupByIdPUT /wallets/mpc/vaults/{vault_id}/key_share_holder_groups/{key_share_holder_group_id}Update key share holder group
CoboWaas2.WalletsMPCWalletsApiupdateMpcProjectByIdPUT /wallets/mpc/projects/{project_id}Update project name
CoboWaas2.WalletsMPCWalletsApiupdateMpcVaultByIdPUT /wallets/mpc/vaults/{vault_id}Update vault name
CoboWaas2.WalletsSmartContractWalletsApilistSafeWalletDelegatesPOST /wallets/{wallet_id}/smart_contracts/delegatesList Delegates

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

CoboAuth

  • Type: API key
  • API key parameter name: BIZ-API-KEY
  • Location: HTTP header

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://auth.cobo.com/authorize
  • Scopes:
    • custodial_asset_wallet:create: Create access to custodial asset wallets
    • custodial_asset_wallet:add: Generate address access to custodial asset wallets
    • custodial_asset_wallet:edit: Change wallet name access to custodial asset wallets
    • custodial_asset_wallet:withdraw: Withdraw access to custodial asset wallets
    • mpc_organization_controlled_wallet:create: Create access to MPC organization-controlled wallets
    • mpc_organization_controlled_wallet:add: Generate address access to MPC organization-controlled wallets
    • mpc_organization_controlled_wallet:edit: Change wallet name access to MPC organization-controlled wallets
    • mpc_organization_controlled_wallet:withdraw: Withdraw access to MPC organization-controlled wallets
    • mpc_organization_controlled_wallet:contract_call: Contract call access to MPC organization-controlled wallets
    • mpc_organization_controlled_wallet:message_sign: Message sign access to MPC organization-controlled wallets
    • mpc_organization_controlled_vault:manage: Create/Edit access to MPC organization-controlled vaults
    • mpc_organization_controlled_key_group:manage: Create/Edit/Delete access to MPC organization-controlled key groups
    • mpc_organization_controlled_tss_request:manage: Create/Cancel access to MPC organization-controlled tss requests
    • mpc_user_controlled_wallet:create: Create access to MPC user-controlled wallets
    • mpc_user_controlled_wallet:add: Generate address access to MPC user-controlled wallets
    • mpc_user_controlled_wallet:edit: Change wallet name access to MPC user-controlled wallets
    • mpc_user_controlled_wallet:withdraw: Withdraw access to MPC user-controlled wallets
    • mpc_user_controlled_wallet:contract_call: Contract call access to MPC user-controlled wallets
    • mpc_user_controlled_wallet:message_sign: Message sign access to MPC user-controlled wallets
    • mpc_user_controlled_project:manage: Create/Edit access to MPC user-controlled projects
    • mpc_user_controlled_vault:manage: Create/Edit access to MPC user-controlled vaults
    • mpc_user_controlled_key_group:manage: Create/Edit/Delete access to MPC user-controlled key groups
    • mpc_user_controlled_tss_request:manage: Create/Cancel access to MPC user-controlled tss requests
    • webhook:resend: Resend access to webhook events
    • webhook_url:edit: Create/Edit access to webhook urls

FAQs

Package last updated on 13 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc