/sendStarknetTransaction

1 min

POST

sendStarknetTransaction Sends a Starknet (STRK) native token transaction using the specified parameters. This function handles standard STRK transfers between accounts on the Starknet Layer 2 network. Starknet transactions undergo a multi-stage lifecycle including mempool validation, sequencer validation, execution, and eventual L1 proof verification with STARK proofs.

Starknet uses Cairo for smart contracts and follows a unique account abstraction model where all accounts are smart accounts. All transactions are INVOKE transactions that are processed by the account contract's validate and execute functions, providing enhanced flexibility and security features.

Use getSuggestedFee and getGasLimitSuggestedForTransaction to get current fee and gas information before running the transaction for optimal performance and cost efficiency.

NOTE: Success or failure in this API call does not necessarily mean success or failure in the transaction itself. For example, the transaction may succeed, but the "success" response to the client can be lost if the client's internet connection is down. To verify the status of the transaction:

Call getCurrentToken and store the returned token.
Send your transaction. The transaction will use the token from step 1.
Call getTransactionByToken using the stored token to track the status of the transaction.

This function is part of the transaction flow detailed at https://docs.gk8.io/api-v19/sending-transactions-from-the-api. Read more about Starknet transactions: https://docs.starknet.io/architecture-and-concepts/network-architecture/transaction-life-cycle/

return: Transaction submission result with approval status and transaction details.

   -------------------- Request --------------------

  sendStarknetTransaction(
        account_id=1,
        outputs=[("0x062...43E", "100")],
        resource_bounds_mapping=ResourceBoundsMapping(l1_gas=ResourceBounds(10000, 50000), l2_gas=ResourceBounds(1000, 3000), l1_data=ResourceBounds(8000, 10000)),
        description="Monthly transfer to recipient"
        specificFromAddress=None,
        ignore_aml=False,
        aml_note=""
   )

-------------------- Response Example -------------------- { "FunctionData": { "ApprovalRequestStatus": 3, "CoinType": "STRK", "Transactions": [ { "AmountToTransfer": "1000000000000000000", "DestinationAddress": "0x0624...243E" } ] }, "Meta": { "AccessToken": "f192...2c54", "Destination": "045b...9d12", "Source": "6f8f...2e8a", "Time": "2024-12-15 14:22

.749" } }

account_idintegerThe account ID to use for this transaction.

outputsarrayList of tuples representing the destination address and amount to transfer. Format: [(destination_address: str, amount_to_transfer: str)] All Starknet addresses should be in hex format starting with "0x".

descriptionstringInternal description for transaction records. Not sent to the blockchain.

specificFromAddressstringThe specific deposit address to send from. Cannot be used if the account is defined as an Omnibus account.

ignore_amlbooleanIf True, the AML (Anti-Money Laundering) check will be bypassed.

aml_notestringRequired note explaining why AML decision is being overridden. Only applicable when ignore_aml is True.

resource_bounds_mappingobjectMapping of ResourceBounds objects to set up a smart contract transaction. with list of l1 gas.

acceptstringGenerated from available response content types

bodyobjectRequest object for initiating a transaction.

200success

curl --request POST \
     --url '/sendStarknetTransaction?account_id=1&outputs=array&description=Test&specificFromAddress=TPxb...9rQre&ignore_aml=**Not%20yet.&aml_note=**Not%20yet.&resource_bounds_mapping=resource_bounds_mapping%3DResourceBoundsMapping(l1_gas%3DResourceBounds(10000%2C%2050000)%2Cl2_gas%3DResourceBounds(1000%2C%203000)%2Cl1_data%3DResourceBounds(8000%2C%2010000))' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "AccountId": 1,
     "CoinType": "STRK",
     "Fee": {
     "GasLimit": "10000",
     "GasPrice": "1047943695835782"
     },
     "Transactions": [
     {
     "AmountToTransfer": "1000000000000",
     "DestinationAddress": "0x00b8a19d6fAb26b495958506467de9Fa849e66BfbF14CdDAAD34bAD95f4CB3dc"
     }
     ]
     }
     }'