Vessel Finance API
    Vessel Finance API
    • Introduction
    • General Info
    • HMAC Signature Guide
    • Poseidon Signature Guide
    • Internal Transfer Signature Guide
    • Error Code
    • Vessel REST API
      • Public
        • Market Data
          • 24hr Ticker Statistics
          • Kline / Candlestick Data
          • Order Book
          • Recent Trades List
          • Average Price
          • AMM Pool Last 24h Data
        • Exchange Data
          • Ticker Info
          • Asset Info
          • Trade Fee
          • AMM Pool Info
      • User
        • Asset
          • User Asset
          • Withdraw
          • Withdraw History
          • Deposit History
          • Claim History
          • Internal Transfer (Send)
          • Internal Transfer History
        • Order
          • Place Order
          • Cancel Order
          • Open Orders
          • Completed Orders
          • All Orders
          • Query Order
          • Modify Order
        • AMM
          • Add Liquidity
          • Remove Liquidity
          • Collect Fee
          • AMM Position
          • AMM Action History
        • Account
          • User Profile
          • User Trade List
    • Vessel WebSocket
      • Market
        • Order Book
        • K Line
        • Recent Trades
        • 24hr Ticker Statistics
        • Ticker Setting Upade
      • User
        • Authorize
        • Balance
        • Account

    Internal Transfer Signature Guide

    To create a valid internal transfer request, you need to generate two different signatures - an EIP 712 signature and a Poseidon signaturePoseidon Signature Guide. Here's how you can do it:

    Generate the EIP 712 Signature:#

    Construct the EIP 712 message parameters, including the domain, message, primary type, and types.
    Use the ethers.js library to sign the EIP 712 message using your private key.
    The resulting eip712Signature will be used in the final request body.

    Generate the Poseidon Hash Signature:#

    Use the circomlibjs library to build the Poseidon hash calculator.
    Fetch the asset information (including the on-chain decimal) from the /api/v1/public/assetInfo endpoint using the provided assetId.
    Calculate the Poseidon hash using the following parameters:
    assetId: The unique identifier of the asset in Vessel.
    toAddress: The user address you want to transfer.
    assetAmount: The amount you want to transfer.
    feeAmount: The fee amount charged by Vessel(Currently, the fee is 0).
    timestamp: Unix timestamp in milliseconds when transfered.
    nonce: An arbitrary number that can be used just once in a cryptographic communication.
    Use the secp256k1 library to sign the Poseidon hash using your private key.
    The resulting signature will be used in the final request body.

    JavaScript Example#

    Here's an example implementation in JavaScript:
    To use this function, you would need to provide the required parameters, such as chainId, assetId, toAddress, assetAmount, feeAmount, timestamp, nonce, address, and privateKey.

    Important Notes#

    Keep Your vesselPrivateKey Secure#

    Never share your vesselPrivateKey with anyone. It's crucial for generating signature for order placement.

    Timestamp Usage#

    The timestamp in the signature cannot be earlier than the order placement request timestamp by more than 60 seconds. Ensure synchronization for accurate results.
    Previous
    Poseidon Signature Guide
    Next
    Error Code
    Built with