Skip to content

Transactions

martiliones edited this page Jun 12, 2023 · 1 revision

Adamant: Transactions

adamantApi.getQueuedTransaction()

Get queued transaction by ID

  • Type

    interface AdamantApi {
      getQueuedTransaction(id: number): Promise<GetQueuedTransactionsResponseDto>;
    }
    
    interface GetQueuedTransactionsResponseDto {
      count: string;
      nodeTimestamp: number;
      success: boolean;
      transactions: QueuedTransaction[];
    }
    
    interface QueuedTransaction {
      amount: number;
      fee: number;
      id: string;
      receivedAt: string;
      recipientId: string;
      relays: number;
      senderId: string;
      senderPublicKey: string;
      signature: string;
      timestamp?: number;
      type: number;
    }

adamantApi.getQueuedTransactions()

Get queued transactions count

  • Type

    interface AdamantApi {
      getQueuedTransactions(): Promise<GetQueuedTransactionsResponseDto>;
    }
    
    interface GetQueuedTransactionsResponseDto {
      count: string;
      nodeTimestamp: number;
      success: boolean;
      transactions: QueuedTransaction[];
    }
    
    interface QueuedTransaction {
      amount: number;
      fee: number;
      id: string;
      receivedAt: string;
      recipientId: string;
      relays: number;
      senderId: string;
      senderPublicKey: string;
      signature: string;
      timestamp?: number;
      type: number;
    }

adamantApi.getTransaction()

Get transaction by ID

  • Type

    interface AdamantApi {
      getTransaction(
        id: number,
        options?: TransactionQuery<TransactionsOptions>
      ): Promise<GetTransactionByIdResponseDto>;
    }
    
    interface TransactionsOptions {
      blockId?: number;
      fromHeight?: number;
      inId?: string;
      limit?: number;
      maxAmount?: number;
      minAmount?: number;
      offset?: number;
      orderBy?: string;
      recipientId?: string;
      recipientIds?: string[];
      recipientPublicKey?: string;
      recipientPublicKeys?: string[];
      returnAsset?: 1 | 0;
      senderId?: string;
      senderIds?: string[];
      senderPublicKey?: string;
      senderPublicKeys?: string[];
      toHeight?: number;
      type?: number;
      types?: number[];
    }
    
    interface GetTransactionByIdResponseDto {
      nodeTimestamp: number;
      success: boolean;
      transaction:
        | VoteForDelegateTransaction
        | never
        | never
        | ChatMessageTransaction
        | TokenTransferTransaction;
    }
    
    type TokenTransferTransaction = {
      asset: TokenTransferAsset;
      type: number;
    } & BaseTransaction;
    
    type ChatMessageTransaction = {
      asset: ChatMessageAsset;
      type: number;
    } & BaseTransaction;
    
    type VoteForDelegateTransaction = {
      asset: VoteForDelegateAsset;
      type: number;
      votes: { added?: string[]; deleted?: string[] };
    } & BaseTransaction;
    
    interface BaseTransaction {
      amount: number;
      asset: object;
      blockId: string;
      block_timestamp: number;
      confirmations: number;
      fee: number;
      height: number;
      id: string;
      recipientId: string;
      recipientPublicKey: string;
      senderId: string;
      senderPublicKey: string;
      signature: string;
      signatures: string[];
      timestamp: number;
      type: number;
    }
    
    type TokenTransferAsset = object;
    
    interface ChatMessageAsset {
      chat: { message?: string; own_message?: string; type?: number };
    }
    
    interface VoteForDelegateAsset {
      votes?: string[];
    }
  • References

    TransactionQuery

adamantApi.getTransactionsCount()

Get confirmed, uncofirmed and queued transactions count

  • Type

    interface AdamantApi {
      getTransactionsCount(): Promise<GetTransactionsCountResponseDto>;
    }
    
    interface GetTransactionsCountResponseDto {
      confirmed: number;
      multisignature: number;
      nodeTimestamp: number;
      queued: number;
      success: boolean;
      unconfirmed: number;
    }

adamantApi.getUnconfirmedTransaction()

Get unconfirmed transaction by ID

  • Type

    interface AdamantApi {
      getUnconfirmedTransaction(
        id: number
      ): Promise<GetUnconfirmedTransactionByIdResponseDto>;
    }
    
    interface GetUnconfirmedTransactionByIdResponseDto {
      nodeTimestamp: number;
      success: boolean;
      transaction: QueuedTransaction;
    }
    
    interface QueuedTransaction {
      amount: number;
      fee: number;
      id: string;
      receivedAt: string;
      recipientId: string;
      relays: number;
      senderId: string;
      senderPublicKey: string;
      signature: string;
      timestamp?: number;
      type: number;
    }

adamantApi.getUnconfirmedTransactions()

Get unconfirmed transactions

  • Type

    interface AdamantApi {
      getUnconfirmedTransactions(): Promise<GetUnconfirmedTransactionsResponseDto>;
    }
    
    interface GetUnconfirmedTransactionsResponseDto {
      count: string;
      nodeTimestamp: number;
      success: boolean;
      transactions: QueuedTransaction[];
    }
    
    interface QueuedTransaction {
      amount: number;
      fee: number;
      id: string;
      receivedAt: string;
      recipientId: string;
      relays: number;
      senderId: string;
      senderPublicKey: string;
      signature: string;
      timestamp?: number;
      type: number;
    }
Clone this wiki locally