salt-sdk
    Preparing search index...

    Interface SendTransactionParams

    Parameters for a regular (send) transaction where a recipient is specified. An empty string for to is treated as a send and will fail validation.

    interface SendTransactionParams {
        accountId: string;
        chainId: number;
        data?: string;
        gas?: string | number;
        gasPrice?: string | number;
        nonce?: string | number;
        notes?: string;
        organisationId?: string;
        returnHash?: boolean;
        sendingProvider?: Provider;
        signer: Signer;
        to: string;
        value: string;
        vaultAddress: string;
        vaultPublicKey: string;
    }

    Hierarchy

    • TransactionParamsBase
      • SendTransactionParams
    Index

    Properties

    accountId: string

    ID of the Salt account to use for the transaction

    '507f1f77bcf86cd799439010'
    
    chainId: number

    Chain ID of the network (integer)

    11155111
    
    data?: string

    Data of the transaction (e.g. an encoded contract call).

    '0x'
    
    '0x'
    
    gas?: string | number

    Gas fee of the transaction.

    '40000000'
    
    gasPrice?: string | number

    Current gas price of the chain.

    '1000000000000000000'
    
    nonce?: string | number

    Nonce of the transaction. If not provided, it will be fetched from the Salt API

    1
    
    notes?: string

    Notes of the transaction. If not provided, it will be set to an empty string

    'This is a note'
    
    organisationId?: string

    ID of the Salt organisation to use for the transaction

    '507f1f77bcf86cd799439011'
    
    returnHash?: boolean

    Return hash of the transaction. If not provided, it will be set to false

    true
    
    false
    
    sendingProvider?: Provider

    Sending provider of the transaction. If not provided, it will select a provider depending on the chainId

    new providers.JsonRpcProvider('https://rpc.ankr.com/eth')
    
    signer: Signer

    Signer of the transaction. If not provided, it will be set to the accountId

    '0x1234567890123456789012345678901234567890'
    
    to: string

    Recipient address for the transaction. Must be a non-empty valid address; an empty string is treated as a send and will be rejected as invalid.

    '0x1234567890123456789012345678901234567890'
    
    value: string

    Amount to send, denominated in ETH (not wei). Internally converted via parseEther.

    '0' // no value
    
    '0.5' // 0.5 ETH
    
    '0.000000000000000001' // 1 wei
    
    vaultAddress: string

    Vault address of the transaction.

    '0x1234567890123456789012345678901234567890'
    
    vaultPublicKey: string

    Vault public key of the transaction.

    '0x1234567890123456789012345678901234567890'