STARKNET JS CLIENT

Typescript host client used to interact with Ledger Starknet application

Usage

const starknetClient = require('@ledgerhq/hw-app-starknet');

// TODO: DEMONSTRATE API

API

Table of Contents

• StarknetClient
  • Parameters
  • Examples
  • getAppVersion
  • getPubKey
    • Parameters
    • Examples
  • getStarkKey
    • Parameters
    • Examples
  • signHash
    • Parameters
  • signTx
    • Parameters
  • signTxV1
    • Parameters
  • signDeployAccount
    • Parameters
  • signDeployAccountV1
    • Parameters
  • signMessage
    • Parameters

StarknetClient

Starknet API

Parameters

• transport Transport

Examples

import Stark from "@ledgerhq/hw-app-starknet";
const stark = new StarknetClient(transport)

getAppVersion

get version of Nano Starknet application

Returns Promise<ResponseVersion> an object with a major, minor, patch

getPubKey

get full starknet public key derived from provided derivation path

Parameters

• path string a path in EIP-2645 format (https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2645.md)
• show boolean (optional, default true)

Examples

stark.getPubKey("m/2645'/579218131'/0'/0'").then(o => o.publicKey)

Returns Promise<ResponsePublicKey> an object with publicKey

getStarkKey

get stark key derived from provided derivation path

Parameters

• path string a path in EIP-2645 format (https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2645.md)
• show boolean (optional, default true)

Examples

stark.getPubKey("m/2645'/579218131'/0'/0'").then(o => o.publicKey)

Returns Promise<ResponseStarkKey> an object with publicKey

signHash

sign the given hash over the staRknet elliptic curve

Parameters

• path string Derivation path in EIP-2645 format
• hash string Pedersen hash to be signed

Returns Promise<ResponseHashSign> an object with (r, s, v) signature

signTx

sign a Starknet Tx v3 Invoke transaction

Parameters

• path string Derivation path in EIP-2645 format
• calls Array<Call> List of calls [(to, selector, calldata), (), ...]
• tx TxFields Tx fields (account address, tip, l1_gas_bounds, l2_gas_bounds, chainID, nonce, data_availability_mode)

Returns Promise<ResponseTxSign> an object with Tx hash + (r, s, v) signature

signTxV1

sign a Starknet Tx v1 Invoke transaction

Parameters

• path string Derivation path in EIP-2645 format
• calls Array<Call> List of calls [(to, selector, calldata), (), ...]
• tx TxV1Fields Tx fields (account address, max_fee, chainID, nonce)

Returns Promise<ResponseTxSign> an object with Tx hash + (r, s, v) signature

signDeployAccount

sign a Starknet Tx v3 DeployAccount transaction

Parameters

• path string Derivation path in EIP-2645 format
• tx DeployAccountFields Tx fields (contract_address, tip, resourceBounds, paymaster_data, chain_id, nonce, nonceDataAvailabilityMode, feeDataAvailabilityMode, constructor_calldata, class_hash, contract_address_salt)

Returns Promise<ResponseTxSign> an object with Tx hash + (r, s, v) signature

signDeployAccountV1

sign a Starknet Tx v1 DeployAccount transaction

Parameters

• path string Derivation path in EIP-2645 format
• tx DeployAccountV1Fields Tx fields (contract_address, class_hash, contract_address_salt, constructor_calldata, max_fee, chainID, nonce)

Returns Promise<ResponseTxSign> an object with Tx hash + (r, s, v) signature

signMessage

sign a SNIP-12 encoded message

Parameters

• path string Derivation path in EIP-2645 format
• message TypedData message to be signed
• account string accound address to sign the message

Returns Promise<ResponseHashSign> an object with (r, s, v) signature