movement-fireblocks-sdk
    Preparing search index...

    Class MovementFireblocksSDK

    Index

    Methods

    createMoveTransaction createTokenTransaction getAccountCoinsData getBalance getBalances getMovementAccountAddress getMovementAccountPublicKey getTransactionsHistory create

    Methods

    • Creates a MOVE transaction to transfer funds to a recipient address. *

      Parameters

      • recipientAddress: string

        The address of the recipient.

      • amount: number

        The amount to transfer in MOVE.

      • OptionalmaxGasAmount: number

        Optional maximum gas amount for the transaction.

      • OptionalgasUnitPrice: number

        Optional gas unit price for the transaction.

      • OptionalexpireTimestamp: number

        Optional expiration timestamp for the transaction.

      • OptionalaccountSequenceNumber: AnyNumber

        Optional sequence number for the account.

      Returns Promise<CommittedTransactionResponse>

      A promise that resolves to a {CommittedTransactionResponse} containing the transaction details.

      If the movement address, public key, or vault ID are not set, or if the transaction creation fails.

    • Creates a token transaction to transfer a specific token type to a recipient address.

      Parameters

      • recipientAddress: string

        The address of the recipient.

      • amount: number

        The amount of the token to transfer.

      • tokenType: string

        The type of the token to transfer (e.g., "USDC", "BTC").

      • OptionalmaxGasAmount: number

        Optional maximum gas amount for the transaction.

      • OptionalgasUnitPrice: number

        Optional gas unit price for the transaction.

      • OptionalexpireTimestamp: number

        Optional expiration timestamp for the transaction.

      • OptionalaccountSequenceNumber: AnyNumber

        Optional sequence number for the account.

      Returns Promise<CommittedTransactionResponse>

      A promise that resolves to a {CommittedTransactionResponse} containing the transaction details.

      If the movement address, public key, or vault ID are not set, or if the transaction creation fails.

    • Retrieves the coins data for the current movement address.

      Returns Promise<
          {
              amount?: any;
              asset_type?: string;
              is_frozen: boolean;
              is_primary?: boolean;
              last_transaction_timestamp?: any;
              last_transaction_version?: any;
              metadata?: {
                  asset_type: string;
                  creator_address: string;
                  decimals: number;
                  icon_uri?: string;
                  last_transaction_timestamp: any;
                  last_transaction_version: any;
                  name: string;
                  project_uri?: string;
                  supply_aggregator_table_handle_v1?: string;
                  supply_aggregator_table_key_v1?: string;
                  symbol: string;
                  token_standard: string;
              };
              owner_address: string;
              storage_id: string;
              token_standard?: string;
          }[],
      >

      A promise that resolves to a {GetAccountCoinsDataResponse} containing data about all coins owned by the account.

      If the movement address is not set or if the coins data retrieval fails.

    • Retrieves all balances for the current movement address, including MOVE and other tokens.

      Returns Promise<GetAllBalancesResponse[]>

      A promise that resolves to an array of {GetAllBalancesResponse} containing all balances.

      If the movement address is not set or if the balance retrieval fails.

    • Retrieves the Movement account address associated with the Fireblocks vault account.

      Returns string

      The Movement account address or empty string if not set.

    • Retrieves the Movement account public key associated with the Fireblocks vault account.

      Returns string

      The Movement account public key or empty string if not set.

    • Retrieves the transaction history for the current movement address.

      Parameters

      • getCachedTransactions: boolean = true
      • limit: number = getTransactionConstants.defaultLimit

        The maximum number of transactions to return (default is 10).

      • offset: number = getTransactionConstants.defaultOffset

        The offset for pagination (default is 0).

      Returns Promise<GetTransactionHistoryResponse[]>

      A promise that resolves to an array of {TransactionResponse} containing transaction history.

      If the movement address is not set or if the transaction history retrieval fails.

    Settings

    Member Visibility

    On This Page

    Methods