Class StacksSDK

Index

Methods

allowContractCaller checkEligibility checkStatus createFTTransaction createNativeTransaction createSignerSig65HexFromParams delegateToPool getAddress getBalance getBtcRewardsAddress getFtBalances getPublicKey getTransactionHistory getTxStatusById revokeDelegation stackSolo create

Methods

allowContractCaller

allowContractCaller(
poolsAddress: string,
poolContractName: string,
): Promise<CreateTransactionResponse>
Allows a stacking pool to lock delegated STX on behalf of the delegator.
Parameters
- poolsAddress: string
  The address of the stacking pool.
- poolContractName: string
  The contract name of the stacking pool.
Returns Promise<CreateTransactionResponse>
A promise that resolves to a {CreateTransactionResponse}.

Throws
If the address, public key, or vault ID are not set, or if the process fails.
- Defined in StacksSDK.ts:862

checkEligibility

checkEligibility(
pox: any,
amount: number,
): Promise<{ eligible: boolean; reason?: string }>
Check eligibility for solo stacking.
Parameters
- pox: any
- amount: number
Returns Promise<{ eligible: boolean; reason?: string }>
A promise that resolves to an object indicating eligibility and reason if not eligible.
- Defined in StacksSDK.ts:1059

checkStatus

checkStatus(): Promise<CheckStatusResponse>
Check account status: balance total, locked amount and delegation status.

Returns Promise<CheckStatusResponse>
A promise that resolves to a {CreateTransactionResponse}.
- Defined in StacksSDK.ts:973

createFTTransaction

createFTTransaction(
    recipientAddress: string,
    amount: number,
    token: TokenType,
    note?: string,
): Promise<CreateTransactionResponse>
Creates a fungible token transaction to transfer funds to a recipient address.
Parameters
- recipientAddress: string
  The address of the recipient.
- amount: number
  The amount to transfer in native coin.
- token: TokenType
  The type of fungible token to transfer.
- Optionalnote: string
  Optional note to be attached to the transaction in raw signing.
Returns Promise<CreateTransactionResponse>
A promise that resolves to a {CreateTransactionResponse}.

Throws
If the address, public key, or vault ID are not set, or if the transaction creation fails.
- Defined in StacksSDK.ts:711

createNativeTransaction

createNativeTransaction(
    recipientAddress: string,
    amount: number,
    grossTransaction?: boolean,
    note?: string,
): Promise<CreateTransactionResponse>
Creates a native coin transaction to transfer funds to a recipient address.
Parameters
- recipientAddress: string
  The address of the recipient.
- amount: number
  The amount to transfer in native coin.
- grossTransaction: boolean = false
  Optional flag indicating if the transaction is gross, if so fee will be deducted from recipient (default is false).
- Optionalnote: string
  Optional note to be attached to the transaction in raw signing.
Returns Promise<CreateTransactionResponse>
A promise that resolves to a {CreateTransactionResponse}.

Throws
If the address, public key, or vault ID are not set, or if the transaction creation fails.
- Defined in StacksSDK.ts:639

createSignerSig65HexFromParams

createSignerSig65HexFromParams(
    rewardCycleId: number,
    lockPeriod: number,
    maxAmountUstx: bigint,
    authId?: bigint,
): Promise<string>
Creates a signerSig65Hex from the provided parameters.
Parameters
- rewardCycleId: number
- lockPeriod: number
- maxAmountUstx: bigint
- OptionalauthId: bigint
Returns Promise<string>
the signerSig65Hex.

Throws
If vault ID is not set, or if the process fails.
- Defined in StacksSDK.ts:1124

delegateToPool

delegateToPool(
    poolsAddress: string,
    poolContractName: string,
    amount: number,
    lockPeriod: number,
): Promise<CreateTransactionResponse>
Delegate STX to a stacking pool.
Parameters
- poolsAddress: string
  The address of the stacking pool.
- poolContractName: string
  The contract name of the stacking pool.
- amount: number
  The amount of STX to stack.
- lockPeriod: number
  The lock period in cycles.
Returns Promise<CreateTransactionResponse>
A promise that resolves to a {CreateTransactionResponse}.

Throws
If the address, public key, or vault ID are not set, or if the delegate process fails.
- Defined in StacksSDK.ts:783

getAddress

getAddress(): string
Retrieves the Stacks account address associated with the Fireblocks vault account.

Returns string
The Stacks account address or empty string if not set.
- Defined in StacksSDK.ts:144

getBalance

getBalance(): Promise<GetNativeBalanceResponse>
Retrieves the native coin balance for the current address.

Returns Promise<GetNativeBalanceResponse>
A promise that resolves to a {GetNativeBalanceResponse} containing the native balance information.

Throws
If the address is not set or if the balance retrieval fails.
- Defined in StacksSDK.ts:162

getBtcRewardsAddress

getBtcRewardsAddress(): string
Retrieves the BTC rewards address associated with the Fireblocks vault account (derived from the same public key).

Returns string
The BTC rewards address or empty string if not set.
- Defined in StacksSDK.ts:152

getFtBalances

getFtBalances(): Promise<GetFtBalancesResponse>
Retrieves the fungible tokens balances for the current address.

Returns Promise<GetFtBalancesResponse>
A promise that resolves to a {GetFtBalancesResponse} containing the fungible tokens balances.

Throws
If the address is not set or if the balance retrieval fails.
- Defined in StacksSDK.ts:237

getPublicKey

getPublicKey(): string
Retrieves the Stacks account public key associated with the Fireblocks vault account.

Returns string
The Stacks account public key or empty string if not set.
- Defined in StacksSDK.ts:136

getTransactionHistory

getTransactionHistory(
    getCachedTransactions?: boolean,
    limit?: number,
    offset?: number,
): Promise<Transaction[]>
Retrieves the transaction history for the current address.
Parameters
- getCachedTransactions: boolean = true
  Whether to return cached transactions (default is true).
- limit: number = pagination_defaults.limit
  The maximum number of transactions to return (default is 50).
- offset: number = pagination_defaults.page
  The offset for pagination (default is 0).
Returns Promise<Transaction[]>
A promise that resolves to an array of {Transaction} containing transaction history.

Throws
If the address is not set or if the transaction history retrieval fails.
- Defined in StacksSDK.ts:290

getTxStatusById

getTxStatusById(txId: string): Promise<GetTransactionStatusResponse>
Parameters
- txId: string
Returns Promise<GetTransactionStatusResponse>
- Defined in StacksSDK.ts:185

revokeDelegation

revokeDelegation(): Promise<CreateTransactionResponse>
Revoke any STX delegation to any address for this account.

Returns Promise<CreateTransactionResponse>
A promise that resolves to a {CreateTransactionResponse}.

Throws
If the address, public key, or vault ID are not set, or if the process fails.
- Defined in StacksSDK.ts:923

stackSolo

stackSolo(
    amount: number,
    lockPeriod: number,
    authId?: bigint,
): Promise<CreateTransactionResponse>
Solo stacks a specified amount of STX for a given lock period.
Parameters
- amount: number
  The amount of STX to stack.
- lockPeriod: number
  The number of cycles to lock the STX.
- OptionalauthId: bigint
  Optional authorization ID for the transaction.
Returns Promise<CreateTransactionResponse>
A response indicating success or failure of the transaction.
- Defined in StacksSDK.ts:1175

`Static`create

create(
vaultAccountId: string | number,
fireblocksConfig?: FireblocksConfig,
): Promise<StacksSDK>
Creates an instance of StacksSDK.
Parameters
- vaultAccountId: string | number
  The Fireblocks vault account ID.
- OptionalfireblocksConfig: FireblocksConfig
  Optional Fireblocks configuration.
Returns Promise<StacksSDK>
A Promise that resolves to an instance of StacksSDK.

Throws
Will throw an error if the instance creation fails.
- Defined in StacksSDK.ts:109

Class StacksSDK

Index

Methods

Methods

allowContractCaller

Parameters

Returns Promise<CreateTransactionResponse>

Throws

checkEligibility

Parameters

Returns Promise<{ eligible: boolean; reason?: string }>

checkStatus

Returns Promise<CheckStatusResponse>

createFTTransaction

Parameters

Returns Promise<CreateTransactionResponse>

Throws

createNativeTransaction

Parameters

Returns Promise<CreateTransactionResponse>

Throws

createSignerSig65HexFromParams

Parameters

Returns Promise<string>

Throws

delegateToPool

Parameters

Returns Promise<CreateTransactionResponse>

Throws

getAddress

Returns string

getBalance

Returns Promise<GetNativeBalanceResponse>

Throws

getBtcRewardsAddress

Returns string

getFtBalances

Returns Promise<GetFtBalancesResponse>

Throws

getPublicKey

Returns string

getTransactionHistory

Parameters

Returns Promise<Transaction[]>

Throws

getTxStatusById

Parameters

Returns Promise<GetTransactionStatusResponse>

revokeDelegation

Returns Promise<CreateTransactionResponse>

Throws

stackSolo

Parameters

Returns Promise<CreateTransactionResponse>

Staticcreate

Parameters

Returns Promise<StacksSDK>

Throws

Settings

On This Page

`Static`create