@stacks/cli

Command line interface to interact with auth, storage and Stacks transactions.

Installation

npm install @stacks/cli

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AppKeyInfoType

AppKeyInfoType: { keyInfo: { address: string; privateKey: string }; legacyKeyInfo: { address: string; privateKey: string }; ownerKeyIndex: number }

Type declaration

keyInfo: { address: string; privateKey: string }
- address: string
- privateKey: string
legacyKeyInfo: { address: string; privateKey: string }
- address: string
- privateKey: string
ownerKeyIndex: number

NameInfoType

NameInfoType: { address: string; blockchain?: string; did?: string; expire_block?: number; grace_period?: number; last_txid?: string; renewal_deadline?: number; resolver?: string | null; status?: string; zonefile?: string | null; zonefile_hash?: string | null }

Type declaration

address: string
Optional blockchain?: string
Optional did?: string
Optional expire_block?: number
Optional grace_period?: number
Optional last_txid?: string
Optional renewal_deadline?: number
Optional resolver?: string | null
Optional status?: string
Optional zonefile?: string | null
Optional zonefile_hash?: string | null

OwnerKeyInfoType

OwnerKeyInfoType: { idAddress: string; index: number; privateKey: string; version: string }

Type declaration

idAddress: string
index: number
privateKey: string
version: string

PaymentKeyInfoType

PaymentKeyInfoType: { address: { BTC: string; STACKS: string }; index: number; privateKey: string }

Type declaration

address: { BTC: string; STACKS: string }
- BTC: string
- STACKS: string
index: number
privateKey: string

StacksKeyInfoType

StacksKeyInfoType: { address: string; btcAddress: string; index: number; privateKey: string; wif: string }

Type declaration

address: string
btcAddress: string
index: number
privateKey: string
wif: string

Variables

Const ADDRESS_CHARS

ADDRESS_CHARS: "[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{1,35}" = '[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{1,35}'

Const ADDRESS_PATTERN

ADDRESS_PATTERN: string = ...

Const BOOLEAN_PATTERN

Const C32_ADDRESS_CHARS

C32_ADDRESS_CHARS: "[0123456789ABCDEFGHJKMNPQRSTVWXYZ]+" = '[0123456789ABCDEFGHJKMNPQRSTVWXYZ]+'

Const CLI_ARGS

CLI_ARGS: { additionalProperties: boolean; properties: CLI_PROP; strict: boolean; type: string } = ...

Type declaration

additionalProperties: boolean
properties: CLI_PROP
strict: boolean
type: string

Const DEFAULT_CONFIG_PATH

DEFAULT_CONFIG_PATH: "~/.blockstack-cli.conf" = '~/.blockstack-cli.conf'

Const DEFAULT_CONFIG_REGTEST_PATH

DEFAULT_CONFIG_REGTEST_PATH: "~/.blockstack-cli-regtest.conf" = '~/.blockstack-cli-regtest.conf'

Const DEFAULT_CONFIG_TESTNET_PATH

DEFAULT_CONFIG_TESTNET_PATH: "~/.blockstack-cli-testnet.conf" = '~/.blockstack-cli-testnet.conf'

Const DEFAULT_MAX_ID_SEARCH_INDEX

DEFAULT_MAX_ID_SEARCH_INDEX: 256 = 256

Const DERIVATION_PATH

DERIVATION_PATH: "m/44'/5757'/0'/0/0" = "m/44'/5757'/0'/0/0"

Const ID_ADDRESS_PATTERN

ID_ADDRESS_PATTERN: string = ...

Const INT_PATTERN

INT_PATTERN: "^-?[0-9]+$" = '^-?[0-9]+$'

Const NAMESPACE_PATTERN

NAMESPACE_PATTERN: "^([0-9a-z_-]{1,19})$" = '^([0-9a-z_-]{1,19})$'

Const NAME_PATTERN

NAME_PATTERN: "^([0-9a-z_.+-]{3,37})$" = '^([0-9a-z_.+-]{3,37})$'

Const PRIVATE_KEY_MULTISIG_PATTERN

PRIVATE_KEY_MULTISIG_PATTERN: "^([0-9]+),([0-9a-f]{64,66},)*([0-9a-f]{64,66})$" = '^([0-9]+),([0-9a-f]{64,66},)*([0-9a-f]{64,66})$'

Const PRIVATE_KEY_NOSIGN_PATTERN

PRIVATE_KEY_NOSIGN_PATTERN: string = ...

Const PRIVATE_KEY_PATTERN

PRIVATE_KEY_PATTERN: "^([0-9a-f]{64,66})$" = '^([0-9a-f]{64,66})$'

Const PRIVATE_KEY_PATTERN_ANY

PRIVATE_KEY_PATTERN_ANY: string = ...

Const PRIVATE_KEY_SEGWIT_P2SH_PATTERN

PRIVATE_KEY_SEGWIT_P2SH_PATTERN: "^segwit:p2sh:([0-9]+),([0-9a-f]{64,66},)*([0-9a-f]{64,66})$" = '^segwit:p2sh:([0-9]+),([0-9a-f]{64,66},)*([0-9a-f]{64,66})$'

Const PRIVATE_KEY_UNCOMPRESSED_PATTERN

PRIVATE_KEY_UNCOMPRESSED_PATTERN: "^([0-9a-f]{64})$" = '^([0-9a-f]{64})$'

Const PUBLIC_KEY_PATTERN

PUBLIC_KEY_PATTERN: "^([0-9a-f]{66,130})$" = '^([0-9a-f]{66,130})$'

Const SIGNIN_CSS

SIGNIN_CSS: "\nh1 { \n font-family: monospace; \n font-size: 24px; \n font-style: normal; \n font-variant: normal; \n font-weight: 700; \n line-height: 26.4px; \n} \nh3 { \n font-family: monospace; \n font-size: 14px; \n font-style: normal; \n font-variant: normal; \n font-weight: 700; \n line-height: 15.4px; \n}\np { \n font-family: monospace; \n font-size: 14px; \n font-style: normal; \n font-variant: normal; \n font-weight: 400; \n line-height: 20px; \n}\nb {\n background-color: #e8e8e8;\n}\npre { \n font-family: monospace; \n font-size: 13px; \n font-style: normal; \n font-variant: normal; \n font-weight: 400; \n line-height: 18.5714px;\n}" = ...

Const SIGNIN_DESC

SIGNIN_DESC: "Sign-in request for \"{appName}\"" = 'Sign-in request for "{appName}"'

Const SIGNIN_FMT_ID

SIGNIN_FMT_ID: "<a href=\"{authRedirect}\">{idAddress}</a> (anonymous)" = '<a href="{authRedirect}">{idAddress}</a> (anonymous)'

Const SIGNIN_FMT_NAME

SIGNIN_FMT_NAME: "<a href=\"{authRedirect}\">{blockstackID}</a> ({idAddress})" = '<a href="{authRedirect}">{blockstackID}</a> ({idAddress})'

Const SIGNIN_FOOTER

SIGNIN_FOOTER: "</body></html>" = '</body></html>'

Const SIGNIN_HEADER

SIGNIN_HEADER: string = ...

Const SIGNIN_SCOPES

SIGNIN_SCOPES: "Requested scopes: \"{appScopes}\"" = 'Requested scopes: "{appScopes}"'

Const STACKS_ADDRESS_PATTERN

STACKS_ADDRESS_PATTERN: string = ...

Const STRENGTH

STRENGTH: 128 = 128

Const STX_WALLET_COMPATIBLE_SEED_STRENGTH

STX_WALLET_COMPATIBLE_SEED_STRENGTH: 256 = 256

Const SUBDOMAIN_PATTERN

SUBDOMAIN_PATTERN: "^([0-9a-z_+-]{1,37}).([0-9a-z_.+-]{3,37})$" = '^([0-9a-z_+-]{1,37}).([0-9a-z_.+-]{3,37})$'

Const TXID_PATTERN

TXID_PATTERN: "^([0-9a-f]{64})$" = '^([0-9a-f]{64})$'

Const URL_PATTERN

URL_PATTERN: "^http[s]?://.+$" = '^http[s]?://.+$'

Const USAGE

USAGE: string = ...

Const ZONEFILE_HASH_PATTERN

ZONEFILE_HASH_PATTERN: "^([0-9a-f]{40})$" = '^([0-9a-f]{40})$'

Const testables

testables: undefined | { addressConvert: (network: CLINetworkAdapter, args: string[]) => Promise<string> } = ...

Functions

CLIMain

CLIMain(): void

- Defined in packages/cli/src/cli.ts:1761
Returns void

CLIOptAsBool

CLIOptAsBool(opts: CLI_OPTS, key: string): boolean

- Defined in packages/cli/src/argparse.ts:3161
Parameters
- opts: CLI_OPTS
- key: string
Returns boolean

CLIOptAsString

CLIOptAsString(opts: CLI_OPTS, key: string): string | null

- Defined in packages/cli/src/argparse.ts:3151
Parameters
- opts: CLI_OPTS
- key: string
Returns string | null

CLIOptAsStringArray

CLIOptAsStringArray(opts: CLI_OPTS, key: string): string[] | null

- Defined in packages/cli/src/argparse.ts:3179
Parameters
- opts: CLI_OPTS
- key: string
Returns string[] | null

JSONStringify

JSONStringify(obj: AnyJson, stderr?: boolean): string

- Defined in packages/cli/src/utils.ts:382
Parameters
- obj: AnyJson
- stderr: boolean = false
Returns string

answerToClarityValue

answerToClarityValue(answer: any, arg: ClarityFunctionArg): ClarityValue

- Defined in packages/cli/src/utils.ts:862
Parameters
- answer: any
- arg: ClarityFunctionArg
Returns ClarityValue

argToPrompt

argToPrompt(arg: ClarityFunctionArg): InquirerPrompt

- Defined in packages/cli/src/utils.ts:797
Parameters
- arg: ClarityFunctionArg
Returns InquirerPrompt

broadcastTransactionAndZoneFile

broadcastTransactionAndZoneFile(network: CLINetworkAdapter, tx: string, zonefile?: string): Promise<{ error: string; status: boolean; txid: string } | { error: undefined; status: boolean; txid: string } | { error: string; message: any; stacktrace: any; status: boolean }>

- Defined in packages/cli/src/utils.ts:507
Parameters
- network: CLINetworkAdapter
- tx: string
- Optional zonefile: string
Returns Promise<{ error: string; status: boolean; txid: string } | { error: undefined; status: boolean; txid: string } | { error: string; message: any; stacktrace: any; status: boolean }>

canonicalPrivateKey

canonicalPrivateKey(privkey: string): string

- Defined in packages/cli/src/utils.ts:428
Parameters
- privkey: string
Returns string

checkArgs

checkArgs(argList: string[]): CheckArgsSuccessType | CheckArgsFailType

- Defined in packages/cli/src/argparse.ts:3299
Parameters
- argList: string[]
Returns CheckArgsSuccessType | CheckArgsFailType

checkUrl

checkUrl(url: string): string

- Defined in packages/cli/src/utils.ts:454
Parameters
- url: string
Returns string

decodePrivateKey

decodePrivateKey(serializedPrivateKey: string): string | CLITransactionSigner

- Defined in packages/cli/src/utils.ts:347
Parameters
- serializedPrivateKey: string
Returns string | CLITransactionSigner

decryptBackupPhrase

decryptBackupPhrase(dataBuffer: string | Buffer, password: string): Promise<string>

- Defined in packages/cli/src/encrypt.ts:7
Parameters
- dataBuffer: string | Buffer
- password: string
Returns Promise<string>

encryptBackupPhrase

encryptBackupPhrase(plaintextBuffer: string, password: string): Promise<Buffer>

- Defined in packages/cli/src/encrypt.ts:3
Parameters
- plaintextBuffer: string
- password: string
Returns Promise<Buffer>

extractAppKey

extractAppKey(network: CLINetworkAdapter, appKeyInfo: { keyInfo: { address: string; privateKey: string }; legacyKeyInfo: { address: string; privateKey: string } }, appAddress?: string): string

- Defined in packages/cli/src/keys.ts:266
Parameters
- network: CLINetworkAdapter
- appKeyInfo: { keyInfo: { address: string; privateKey: string }; legacyKeyInfo: { address: string; privateKey: string } }
  - keyInfo: { address: string; privateKey: string }
    - address: string
    - privateKey: string
  - legacyKeyInfo: { address: string; privateKey: string }
    - address: string
    - privateKey: string
- Optional appAddress: string
Returns string

findIdentityIndex

findIdentityIndex(network: CLINetworkAdapter, mnemonic: string, idAddress: string, maxIndex?: number): Promise<number>

- Defined in packages/cli/src/keys.ts:176
Parameters
- network: CLINetworkAdapter
- mnemonic: string
- idAddress: string
- Optional maxIndex: number
Returns Promise<number>

gaiaAuth

gaiaAuth(network: CLINetworkAdapter, appPrivateKey: string | null, hubUrl: string | null, ownerPrivateKey?: string): Promise<UserData>

- Defined in packages/cli/src/data.ts:85
Parameters
- network: CLINetworkAdapter
- appPrivateKey: string | null
- hubUrl: string | null
- Optional ownerPrivateKey: string
Returns Promise<UserData>

gaiaConnect

gaiaConnect(network: CLINetworkAdapter, gaiaHubUrl: string, privateKey: string, ownerPrivateKey?: string): Promise<GaiaHubConfig>

- Defined in packages/cli/src/data.ts:114
Parameters
- network: CLINetworkAdapter
- gaiaHubUrl: string
- privateKey: string
- Optional ownerPrivateKey: string
Returns Promise<GaiaHubConfig>

gaiaUploadProfile

gaiaUploadProfile(network: CLINetworkAdapter, gaiaHubURL: string, gaiaData: string, privateKey: string, blockstackID?: string): Promise<string>

- Defined in packages/cli/src/data.ts:221
Parameters
- network: CLINetworkAdapter
- gaiaHubURL: string
- gaiaData: string
- privateKey: string
- Optional blockstackID: string
Returns Promise<string>

gaiaUploadProfileAll

gaiaUploadProfileAll(network: CLINetworkAdapter, gaiaUrls: string[], gaiaData: string, privateKey: string, blockstackID?: string): Promise<{ dataUrls?: string[] | null; error?: string | null }>

- Defined in packages/cli/src/data.ts:251
Parameters
- network: CLINetworkAdapter
- gaiaUrls: string[]
- gaiaData: string
- privateKey: string
- Optional blockstackID: string
Returns Promise<{ dataUrls?: string[] | null; error?: string | null }>

generateExplorerTxPageUrl

generateExplorerTxPageUrl(txid: string, network: StacksNetwork): string

- Defined in packages/cli/src/utils.ts:893
Parameters
- txid: string
- network: StacksNetwork
Returns string

getApplicationKeyInfo

getApplicationKeyInfo(network: CLINetworkAdapter, mnemonic: string, idAddress: string, appDomain: string, idIndex?: number): Promise<AppKeyInfoType>

- Defined in packages/cli/src/keys.ts:218
Parameters
- network: CLINetworkAdapter
- mnemonic: string
- idAddress: string
- appDomain: string
- Optional idIndex: number
Returns Promise<AppKeyInfoType>

getBackupPhrase

getBackupPhrase(backupPhraseOrCiphertext: string, password?: string): Promise<string>

- Defined in packages/cli/src/utils.ts:656
Parameters
- backupPhraseOrCiphertext: string
- Optional password: string
Returns Promise<string>

getCLIOpts

getCLIOpts(argv: string[], opts?: string): CLI_OPTS

- Defined in packages/cli/src/argparse.ts:3094
Parameters
- argv: string[]
- opts: string = 'deitUxC:F:B:P:D:G:N:H:T:I:m:M:X:u:p:'
Returns CLI_OPTS

getCommandArgs

getCommandArgs(command: string, argsList: string[]): { arguments: undefined; error: string; status: boolean } | { arguments: string[]; error: undefined; status: boolean }

- Defined in packages/cli/src/argparse.ts:3194
Parameters
- command: string
- argsList: string[]
Returns { arguments: undefined; error: string; status: boolean } | { arguments: string[]; error: undefined; status: boolean }

getGaiaAddressFromProfile

getGaiaAddressFromProfile(network: CLINetworkAdapter, profile: any, appOrigin: string): string

- Defined in packages/cli/src/data.ts:343
Parameters
- network: CLINetworkAdapter
- profile: any
- appOrigin: string
Returns string

getGaiaAddressFromURL

getGaiaAddressFromURL(appUrl: string): string

- Defined in packages/cli/src/data.ts:330
Parameters
- appUrl: string
Returns string

getIDAddress

getIDAddress(network: CLINetworkAdapter, nameOrIDAddress: string): Promise<string>

- Defined in packages/cli/src/utils.ts:715
Parameters
- network: CLINetworkAdapter
- nameOrIDAddress: string
Returns Promise<string>

getIDAppKeys

getIDAppKeys(network: CLINetworkAdapter, nameOrIDAddress: string, appOrigin: string, mnemonicOrCiphertext: string): Promise<IDAppKeys>

- Defined in packages/cli/src/utils.ts:758
Parameters
- network: CLINetworkAdapter
- nameOrIDAddress: string
- appOrigin: string
- mnemonicOrCiphertext: string
Returns Promise<IDAppKeys>

getMaxIDSearchIndex

getMaxIDSearchIndex(): number

- Defined in packages/cli/src/cli.ts:124
Returns number

getNameInfoEasy

getNameInfoEasy(network: CLINetworkAdapter, name: string): Promise<NameInfoType | null>

- Defined in packages/cli/src/utils.ts:552
Parameters
- network: CLINetworkAdapter
- name: string
Returns Promise<NameInfoType | null>

getNetwork

getNetwork(configData: CLI_CONFIG_TYPE, regTest: boolean): BlockstackNetwork

- Defined in packages/cli/src/network.ts:332
Parameters
- configData: CLI_CONFIG_TYPE
- regTest: boolean
Returns BlockstackNetwork

getOwnerKeyFromIDAddress

getOwnerKeyFromIDAddress(network: CLINetworkAdapter, mnemonic: string, idAddress: string): Promise<string>

- Defined in packages/cli/src/utils.ts:732
Parameters
- network: CLINetworkAdapter
- mnemonic: string
- idAddress: string
Returns Promise<string>

getOwnerKeyInfo

getOwnerKeyInfo(network: CLINetworkAdapter, mnemonic: string, index: number, version?: string): Promise<OwnerKeyInfoType>

- Defined in packages/cli/src/keys.ts:80
Parameters
- network: CLINetworkAdapter
- mnemonic: string
- index: number
- version: string = 'v0.10-current'
Returns Promise<OwnerKeyInfoType>

getPaymentKeyInfo

getPaymentKeyInfo(network: CLINetworkAdapter, mnemonic: string): Promise<PaymentKeyInfoType>

- Defined in packages/cli/src/keys.ts:107
Parameters
- network: CLINetworkAdapter
- mnemonic: string
Returns Promise<PaymentKeyInfoType>

getPrivateKeyAddress

getPrivateKeyAddress(network: CLINetworkAdapter, privateKey: string | CLITransactionSigner): string

- Defined in packages/cli/src/utils.ts:403
Parameters
- network: CLINetworkAdapter
- privateKey: string | CLITransactionSigner
Returns string

getPublicKeyFromPrivateKey

getPublicKeyFromPrivateKey(privateKey: string): string

- Defined in packages/cli/src/utils.ts:394
Parameters
- privateKey: string
Returns string

getStacksWalletKeyInfo

getStacksWalletKeyInfo(network: CLINetworkAdapter, mnemonic: string): Promise<StacksKeyInfoType>

- Defined in packages/cli/src/keys.ts:134
Parameters
- network: CLINetworkAdapter
- mnemonic: string
Returns Promise<StacksKeyInfoType>

getpass

getpass(promptStr: string, cb: (passwd: string) => void): void

- Defined in packages/cli/src/utils.ts:628
Parameters
- promptStr: string
- cb: (passwd: string) => void
  - - (passwd: string): void
    - Parameters
      - passwd: string
      Returns void
Returns void

handleAuth

handleAuth(network: CLINetworkAdapter, mnemonic: string, gaiaHubUrl: string, profileGaiaHub: string, port: number, req: express.Request, res: express.Response): Promise<any>

- Defined in packages/cli/src/auth.ts:365
Parameters
- network: CLINetworkAdapter
- mnemonic: string
- gaiaHubUrl: string
- profileGaiaHub: string
- port: number
- req: express.Request
- res: express.Response
Returns Promise<any>

handleSignIn

handleSignIn(network: CLINetworkAdapter, mnemonic: string, appGaiaHub: string, profileGaiaHub: string, req: express.Request, res: express.Response): Promise<any>

- Defined in packages/cli/src/auth.ts:588
Parameters
- network: CLINetworkAdapter
- mnemonic: string
- appGaiaHub: string
- profileGaiaHub: string
- req: express.Request
- res: express.Response
Returns Promise<any>

hasKeys

hasKeys(signer: string | CLITransactionSigner): boolean

- Defined in packages/cli/src/utils.ts:224
Parameters
- signer: string | CLITransactionSigner
Returns boolean

hash160

hash160(buff: Buffer): Buffer

- Defined in packages/cli/src/utils.ts:446
Parameters
- buff: Buffer
Returns Buffer

isSubdomain

isSubdomain(name: string): boolean

- Defined in packages/cli/src/utils.ts:420
Parameters
- name: string
Returns boolean

isTestnetAddress

isTestnetAddress(address: string): boolean

- Defined in packages/cli/src/utils.ts:901
Parameters
- address: string
Returns boolean

loadConfig

loadConfig(configFile: string, networkType: string): CLI_CONFIG_TYPE

- Defined in packages/cli/src/argparse.ts:3383
Load the config file and return a config dict. If no config file exists, then return the default config.

configpath

(string) the path to the config file.

networktype

(sring) 'mainnet', 'regtest', or 'testnet'

Parameters
- configFile: string
- networkType: string
Returns CLI_CONFIG_TYPE

loadNamedIdentities

loadNamedIdentities(network: CLINetworkAdapter, mnemonic: string): Promise<NamedIdentityType[]>

- Defined in packages/cli/src/auth.ts:261
Parameters
- network: CLINetworkAdapter
- mnemonic: string
Returns Promise<NamedIdentityType[]>

makeAllCommandsHelp

makeAllCommandsHelp(): string

- Defined in packages/cli/src/argparse.ts:2990
Returns string

makeAllCommandsList

makeAllCommandsList(): string

- Defined in packages/cli/src/argparse.ts:2959
Returns string

makeAssociationToken

makeAssociationToken(appPrivateKey: string, identityKey: string): string

- Defined in packages/cli/src/data.ts:63
Parameters
- appPrivateKey: string
- identityKey: string
Returns string

makeCommandUsageString

makeCommandUsageString(command?: string): string

- Defined in packages/cli/src/argparse.ts:3013
Parameters
- Optional command: string
Returns string

makeDIDConfiguration

makeDIDConfiguration(network: CLINetworkAdapter, blockstackID: string, domain: string, privateKey: string): Promise<{ entries: { did: string; jwt: string }[] }>

- Defined in packages/cli/src/utils.ts:477
Parameters
- network: CLINetworkAdapter
- blockstackID: string
- domain: string
- privateKey: string
Returns Promise<{ entries: { did: string; jwt: string }[] }>

makeProfileJWT

makeProfileJWT(profileData: Object, privateKey: string): string

- Defined in packages/cli/src/utils.ts:470
Parameters
- profileData: Object
- privateKey: string
Returns string

makePromptsFromArgList

makePromptsFromArgList(expectedArgs: ClarityFunctionArg[]): InquirerPrompt[]

- Defined in packages/cli/src/utils.ts:784
Parameters
- expectedArgs: ClarityFunctionArg[]
Returns InquirerPrompt[]

makeUsageString

makeUsageString(): string

- Defined in packages/cli/src/argparse.ts:3044
Returns string

makeZoneFileFromGaiaUrl

makeZoneFileFromGaiaUrl(network: CLINetworkAdapter, name: string, gaiaHubUrl: string, ownerKey: string): Promise<any>

- Defined in packages/cli/src/data.ts:296
Parameters
- network: CLINetworkAdapter
- name: string
- gaiaHubUrl: string
- ownerKey: string
Returns Promise<any>

mkdirs

mkdirs(path: string): void

- Defined in packages/cli/src/utils.ts:684
Parameters
- path: string
Returns void

nameLookup

nameLookup(network: CLINetworkAdapter, name: string, includeProfile?: boolean): Promise<{ profile: any; profileUrl?: string; zonefile?: string }>

- Defined in packages/cli/src/utils.ts:574
Parameters
- network: CLINetworkAdapter
- name: string
- includeProfile: boolean = true
Returns Promise<{ profile: any; profileUrl?: string; zonefile?: string }>

parseClarityFunctionArgAnswers

parseClarityFunctionArgAnswers(answers: any, expectedArgs: ClarityFunctionArg[]): ClarityValue[]

- Defined in packages/cli/src/utils.ts:849
Parameters
- answers: any
- expectedArgs: ClarityFunctionArg[]
Returns ClarityValue[]

parseMultiSigKeys

parseMultiSigKeys(serializedPrivateKeys: string): MultiSigKeySigner

- Defined in packages/cli/src/utils.ts:253
Parameters
- serializedPrivateKeys: string
Returns MultiSigKeySigner

parseNullSigner

parseNullSigner(addrString: string): NullSigner

- Defined in packages/cli/src/utils.ts:238
Parameters
- addrString: string
Returns NullSigner

parseSegwitP2SHKeys

parseSegwitP2SHKeys(serializedPrivateKeys: string): SegwitP2SHKeySigner

- Defined in packages/cli/src/utils.ts:291
Parameters
- serializedPrivateKeys: string
Returns SegwitP2SHKeySigner

printUsage

printUsage(): void

- Defined in packages/cli/src/argparse.ts:3079
Returns void

sumUTXOs

sumUTXOs(utxos: UTXO[]): number

- Defined in packages/cli/src/utils.ts:439
Parameters
- utxos: UTXO[]
Returns number

@stacks/cli

Installation

Usage

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AppKeyInfoType

Type declaration

keyInfo: { address: string; privateKey: string }

address: string

privateKey: string

legacyKeyInfo: { address: string; privateKey: string }

address: string

privateKey: string

ownerKeyIndex: number

NameInfoType

Type declaration

address: string

Optional blockchain?: string

Optional did?: string

Optional expire_block?: number

Optional grace_period?: number

Optional last_txid?: string

Optional renewal_deadline?: number

Optional resolver?: string | null

Optional status?: string

Optional zonefile?: string | null

Optional zonefile_hash?: string | null

OwnerKeyInfoType

Type declaration

idAddress: string

index: number

privateKey: string

version: string

PaymentKeyInfoType

Type declaration

address: { BTC: string; STACKS: string }

BTC: string

STACKS: string

index: number

privateKey: string

StacksKeyInfoType

Type declaration

address: string

btcAddress: string

index: number

privateKey: string

wif: string

Variables

Const ADDRESS_CHARS

Const ADDRESS_PATTERN

Const BOOLEAN_PATTERN

Const C32_ADDRESS_CHARS

Const CLI_ARGS

Type declaration

additionalProperties: boolean

properties: CLI_PROP

strict: boolean

type: string

Const DEFAULT_CONFIG_PATH

Const DEFAULT_CONFIG_REGTEST_PATH

Const DEFAULT_CONFIG_TESTNET_PATH

Const DEFAULT_MAX_ID_SEARCH_INDEX

Const DERIVATION_PATH

Const ID_ADDRESS_PATTERN

Const INT_PATTERN

Const NAMESPACE_PATTERN

Const NAME_PATTERN

Const PRIVATE_KEY_MULTISIG_PATTERN

Const PRIVATE_KEY_NOSIGN_PATTERN

Const PRIVATE_KEY_PATTERN

Const PRIVATE_KEY_PATTERN_ANY

Const PRIVATE_KEY_SEGWIT_P2SH_PATTERN

Const PRIVATE_KEY_UNCOMPRESSED_PATTERN

Const PUBLIC_KEY_PATTERN

Const SIGNIN_CSS