@coolwallet/atom

CoolWallet Cosmos (ATOM) SDK

Typescript library with support for the integration of ATOM for third party application, include the functionalities of generation of addresses, signed transactions, and staking.

Install

npm i @coolwallet/atom

Usage

import ATOM from '@coolwallet/atom';
import { crypto } from '@coolwallet/core';
import { createTransport } from '@coolwallet/transport-web-ble';

const atom = new ATOM();

const transport = await createTransport();

const { privateKey: appPrivateKey } = crypto.key.generateKeyPair();

const appId = 'appId that had been registered by wallet';

const address = await atom.getAddress(transport, appPrivateKey, appId, 0);

const normalTransaction = {
    chainId: "cosmoshub-4",
    txType: "MsgSend",
    fromAddress: "cosmos1ry7vmlmmn6z9zyglpjp7jz82kf84nyuts4xdhl",
    toAddress: "cosmos1gmezj8ws4467l4qxm7fs9a4gh60mygpf67vlmt",
    amount: 10,
    feeAmount: 5000,
    gas: 200000,
    accountNumber: 121641,
    sequence: "14",
    memo: "test signature"
}

const signData = {
    transport,
    appPrivateKey,
    appId,
    addressIndex: 0,
    transaction: normalTransaction,
    txType: TX_TYPE.SEND,
}

const normalTx = await atom.signTransaction(signData);

Methods

getAddress

Description

Get address by address index.

The ATOM address generated is compatible to BIP44 with account and change set to 0, which means calling getAddress with addressIndex = i will get the address of folllowing path:

m/44'/118'/0'/0/{i}

In the design of current hardware, we only support path m/44'/118'/0'/0/{i} for speed optimization. This might change in the future and we will then open a more general interface to deal with custom path.

async getAddress(
    transport: Transport, 
    appPrivateKey: string, 
    appId: string, 
    addressIndex: number
): Promise<string>

Arguments

Arg	Description	Type	Required
transport	Object to communicate with CoolWallet device	Transport	True
appPrivateKey	Private key for the connected application	string	True
appId	ID for the connected application	string	True
addressIndex	The from address index in BIP44 derivation	number	True

signTransaction

Description

Sign ATOM Transaction.

async signTransaction(signData: types.SignDataType): Promise<string>

SignType Arguments

Arg	Description	Type	Required
transport	Object to communicate with CoolWallet device	Transport	True
appPrivateKey	Private key for the connected application	string	True
appId	ID for the connected application	string	True
addressIndex	The from address index in BIP44 derivation	number	True
confirmCB	Callback of confirmation data to the connected application	Function	False
authorizedCB	Callback of authorized transaction data to the connected application	Function	False
tx_Type	Type of transaction (SEND, DELEGATE, UNDELEGATE, WITHDRAW)	TX_TYPE	True
transaction	The transaction interface based on the type of transaction	Interface	True

Cosmos transaction can be extended based on the tx_type for staking purposes, which could be SEND, DELEGATE, UNDELEGATE, or WITHDRAW.

MsgSend

Description

To transfer ATOM

Arguments

Arg	Description	Type	Required
fromAddress	From address for the transaction	string	True
toAddress	To address for the transaction	string	True
amount	Amount to transfer	number	True

MsgDelegate & MsgUndelegate

Description

To delegate & to undelegate ATOM

Arguments

Arg	Description	Type	Required
delegatorAddress	Address of delegator	string	True
validatorAddress	Address of validator	string	True
amount	Amount for delegating	number	True

const delegate = {
    delegatorAddress: "cosmos1uqnpy2ay7rsjyd4s3562d9nyd8ag0kjqseg3gz",
    validatorAddress: "cosmosvaloper1we6knm8qartmmh2r0qfpsz6pq0s7emv3e0meuw",
    amount: 100000
}

const undelegate = {
    delegatorAddress: "cosmos1uqnpy2ay7rsjyd4s3562d9nyd8ag0kjqseg3gz",
    validatorAddress: "cosmosvaloper1we6knm8qartmmh2r0qfpsz6pq0s7emv3e0meuw",
    amount: 100000
}

MsgWithdrawDelegationReward

Description

To withdraw the delegation and claim the reward

Arguments

Arg	Description	Type	Required
delegatorAddress	Address of delegator	string	True
validatorAddress	Address of validator	string	True

const withDrawDelegationReward = {
    delegatorAddress: "cosmos1uqnpy2ay7rsjyd4s3562d9nyd8ag0kjqseg3gz",
    validatorAddress: "cosmosvaloper1we6knm8qartmmh2r0qfpsz6pq0s7emv3e0meuw"
}