Interface AensClaimReturnType

Hierarchy

Properties

blockHash?: string

Base58Check encoded tagged hash

blockHeight?: number
confirmationHeight?: number
extendTtl?: ((nameTtl, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
    id: string;
    owner?: string;
    pointers: ({ key: string; id: string; })[];
    ttl: number;
} & {
    extendTtl: (nameTtl: number, options?: Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> | undefined) => Promise<...> & Promise<...>;
    id: `nm_${string}`;
    owner: `ak_${string}`;
    pointers: NamePointer[] | KeyPointers;
    revoke: ((options?) => Promise<SendTransactionReturnType>);
    transfer: ((account, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
    ttl: number;
    update: ((pointers, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
}>>)

Type declaration

    • (nameTtl, options?): Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & {
          extendTtl: (nameTtl: number, options?: Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> | undefined) => Promise<...> & Promise<...>;
          id: `nm_${string}`;
          owner: `ak_${string}`;
          pointers: NamePointer[] | KeyPointers;
          revoke: ((options?) => Promise<SendTransactionReturnType>);
          transfer: ((account, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
          ttl: number;
          update: ((pointers, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
      }>>
    • Parameters

      Returns Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & {
          extendTtl: (nameTtl: number, options?: Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> | undefined) => Promise<...> & Promise<...>;
          id: `nm_${string}`;
          owner: `ak_${string}`;
          pointers: NamePointer[] | KeyPointers;
          revoke: ((options?) => Promise<SendTransactionReturnType>);
          transfer: ((account, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
          ttl: number;
          update: ((pointers, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
      }>>

hash: `th_${string}`
id?: `nm_${string}`

Base58Check encoded tagged value

owner?: `ak_${string}`

Base58Check encoded tagged pubkey

pointers?: Object
rawTx: `tx_${string}`
revoke?: ((options?) => Promise<SendTransactionReturnType>)

Type declaration

signatures?: string[]

At least one signature is required unless for Generalized Account Meta transactions

transfer?: ((account, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
    id: string;
    owner?: string;
    pointers: ({ key: string; id: string; })[];
    ttl: number;
} & {
    extendTtl: ((nameTtl, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
    id: `nm_${string}`;
    owner: `ak_${string}`;
    pointers: NamePointer[] | KeyPointers;
    revoke: ((options?) => Promise<SendTransactionReturnType>);
    transfer: (account: `ak_${string}`, options?: ({ onNode: Node; } & AensUpdateOptions & AensTransferOptions) | undefined) => Promise<SendTransactionReturnType> & Promise<...>;
    ttl: number;
    update: ((pointers, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
}>>)

Type declaration

    • (account, options?): Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & {
          extendTtl: ((nameTtl, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
          id: `nm_${string}`;
          owner: `ak_${string}`;
          pointers: NamePointer[] | KeyPointers;
          revoke: ((options?) => Promise<SendTransactionReturnType>);
          transfer: (account: `ak_${string}`, options?: ({ onNode: Node; } & AensUpdateOptions & AensTransferOptions) | undefined) => Promise<SendTransactionReturnType> & Promise<...>;
          ttl: number;
          update: ((pointers, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
      }>>
    • Parameters

      Returns Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & {
          extendTtl: ((nameTtl, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
          id: `nm_${string}`;
          owner: `ak_${string}`;
          pointers: NamePointer[] | KeyPointers;
          revoke: ((options?) => Promise<SendTransactionReturnType>);
          transfer: (account: `ak_${string}`, options?: ({ onNode: Node; } & AensUpdateOptions & AensTransferOptions) | undefined) => Promise<SendTransactionReturnType> & Promise<...>;
          ttl: number;
          update: ((pointers, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
      }>>

ttl?: number
tx?: {
    abiVersion?: string;
    accountId?: string;
    amount?: bigint;
    authData?: string;
    authFun?: string;
    callData?: string;
    callerId?: string;
    channelId?: string;
    channelReserve?: bigint;
    clientTtl?: number;
    code?: string;
    commitmentId?: string;
    contractId?: string;
    delegateIds?: { initiator?: string[] | undefined; responder?: string[] | undefined; };
    deposit?: bigint;
    fee: bigint;
    fromId?: string;
    gaId?: string;
    gas?: number;
    gasPrice?: bigint;
    initiatorAmount?: bigint;
    initiatorAmountFinal?: bigint;
    initiatorDelegateIds?: string[];
    initiatorId?: string;
    lockPeriod?: string;
    name?: string;
    nameFee?: bigint;
    nameId?: string;
    nameSalt?: number;
    nameTtl?: number;
    nonce?: number;
    offchainTrees?: string;
    oracleId?: string;
    oracleTtl?: { type: "delta"; value: string; };
    ownerId?: string;
    payerId?: string;
    payload?: string;
    poi?: string;
    pointers?: ({ key: string; id: string; })[];
    query?: string;
    queryFee?: bigint;
    queryFormat?: string;
    queryId?: string;
    queryTtl?: { type: TTLType; value: string; };
    recipientId?: string;
    responderAmount?: bigint;
    responderAmountFinal?: bigint;
    responderDelegateIds?: string[];
    responderId?: string;
    response?: string;
    responseFormat?: string;
    responseTtl?: { type: "delta"; value: string; };
    round?: number;
    senderId?: string;
    stateHash?: string;
    toId?: string;
    ttl?: number;
    tx?: { tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; }; blockHeight: number; blockHash: string; hash: string; signatures: str...;
    type: "Tx";
    update?: ({ op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract"; }) | ({ op: "OffChainTransfer"; from: string; to: string; amount: bigint; }) | ({ op: "OffChainWithdrawal"; to: string; amount: bigint; }) | ({ op: "OffChainDeposit"; from: string; amount: bigint; }) | ({ op: "OffChainNewContract"; owner: string; vmVersion: string; abiVersion: string; code: { bytecode: `cb_${string}`; }; deposit: bigint; callData: string; }) | ({ op: "OffChainCallContract"; caller: string; contract: string; abiVersion: string; amount: bigint; gas: number; gasPrice: bigint; callData: string; });
    version: number;
    vmVersion?: string;
}

A mix of all transaction types.

Type declaration

  • Optional abiVersion?: string
  • Optional accountId?: string

    Base58Check encoded tagged pubkey

  • Optional amount?: bigint
  • Optional authData?: string

    Base64Check encoded tagged byte array

  • Optional authFun?: string

    Contract authorization function hash (hex encoded)

  • Optional callData?: string

    Base64Check encoded tagged byte array

  • Optional callerId?: string

    Base58Check encoded tagged pubkey

  • Optional channelId?: string

    Base58Check encoded tagged pubkey

  • Optional channelReserve?: bigint
  • Optional clientTtl?: number
  • Optional code?: string

    Base64Check encoded tagged byte array

  • Optional commitmentId?: string

    Base58Check encoded tagged value

  • Optional contractId?: string

    Base58Check encoded tagged pubkey

  • Optional delegateIds?: { initiator?: string[] | undefined; responder?: string[] | undefined; }
  • Optional deposit?: bigint
  • fee: bigint
  • Optional fromId?: string

    Base58Check encoded tagged pubkey

  • Optional gaId?: string

    Base58Check encoded tagged pubkey

  • Optional gas?: number
  • Optional gasPrice?: bigint
  • Optional initiatorAmount?: bigint
  • Optional initiatorAmountFinal?: bigint
  • Optional initiatorDelegateIds?: string[]
  • Optional initiatorId?: string

    Base58Check encoded tagged pubkey

  • Optional lockPeriod?: string
  • Optional name?: string
  • Optional nameFee?: bigint
  • Optional nameId?: string

    Base58Check encoded tagged value

  • Optional nameSalt?: number
  • Optional nameTtl?: number
  • Optional nonce?: number
  • Optional offchainTrees?: string

    Base64Check encoded tagged byte array

  • Optional oracleId?: string

    Base58Check encoded tagged pubkey

  • Optional oracleTtl?: { type: "delta"; value: string; }
  • Optional ownerId?: string

    Base58Check encoded tagged pubkey

  • Optional payerId?: string

    Base58Check encoded tagged pubkey

  • Optional payload?: string

    Base64Check encoded tagged byte array

  • Optional poi?: string

    Base64Check encoded tagged byte array

  • Optional pointers?: ({ key: string; id: string; })[]
  • Optional query?: string
  • Optional queryFee?: bigint
  • Optional queryFormat?: string
  • Optional queryId?: string

    Base58Check encoded tagged value

  • Optional queryTtl?: { type: TTLType; value: string; }
  • Optional recipientId?: string

    Base58Check encoded tagged pubkey

  • Optional responderAmount?: bigint
  • Optional responderAmountFinal?: bigint
  • Optional responderDelegateIds?: string[]
  • Optional responderId?: string

    Base58Check encoded tagged pubkey

  • Optional response?: string
  • Optional responseFormat?: string
  • Optional responseTtl?: { type: "delta"; value: string; }
  • Optional round?: number
  • Optional senderId?: string

    Base58Check encoded tagged pubkey

  • Optional stateHash?: string

    Base58Check encoded tagged pubkey

  • Optional toId?: string

    Base58Check encoded tagged pubkey

  • Optional ttl?: number
  • Optional tx?: { tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; }; blockHeight: number; blockHash: string; hash: string; signatures: str...
  • type: "Tx"

    Polymorphic discriminator, which specifies the different types this object can be

  • Optional update?: ({ op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract"; }) | ({ op: "OffChainTransfer"; from: string; to: string; amount: bigint; }) | ({ op: "OffChainWithdrawal"; to: string; amount: bigint; }) | ({ op: "OffChainDeposit"; from: string; amount: bigint; }) | ({ op: "OffChainNewContract"; owner: string; vmVersion: string; abiVersion: string; code: { bytecode: `cb_${string}`; }; deposit: bigint; callData: string; }) | ({ op: "OffChainCallContract"; caller: string; contract: string; abiVersion: string; amount: bigint; gas: number; gasPrice: bigint; callData: string; })
  • version: number
  • Optional vmVersion?: string
update?: ((pointers, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
    id: string;
    owner?: string;
    pointers: ({ key: string; id: string; })[];
    ttl: number;
} & {
    extendTtl: ((nameTtl, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
    id: `nm_${string}`;
    owner: `ak_${string}`;
    pointers: NamePointer[] | KeyPointers;
    revoke: ((options?) => Promise<SendTransactionReturnType>);
    transfer: ((account, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
    ttl: number;
    update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>;
}>>)

Type declaration

    • (pointers, options?): Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & {
          extendTtl: ((nameTtl, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
          id: `nm_${string}`;
          owner: `ak_${string}`;
          pointers: NamePointer[] | KeyPointers;
          revoke: ((options?) => Promise<SendTransactionReturnType>);
          transfer: ((account, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
          ttl: number;
          update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>;
      }>>
    • Parameters

      Returns Promise<SendTransactionReturnType> & Promise<Readonly<{
          id: string;
          owner?: string;
          pointers: ({ key: string; id: string; })[];
          ttl: number;
      } & {
          extendTtl: ((nameTtl, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
          id: `nm_${string}`;
          owner: `ak_${string}`;
          pointers: NamePointer[] | KeyPointers;
          revoke: ((options?) => Promise<SendTransactionReturnType>);
          transfer: ((account, options?) => Promise<SendTransactionReturnType> & Promise<Readonly<{
              id: string;
              owner?: string;
              pointers: ({ key: string; id: string; })[];
              ttl: number;
          } & ({ id: `nm_${string}`; owner: `ak_${string}`; pointers: NamePointer[] | KeyPointers; ttl: number; update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | ... 1 more ... | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>; transfer: (a...)>>);
          ttl: number;
          update: (pointers: KeyPointers, options?: (Omit<{ onNode: Node; } & AensUpdateOptions & AensTransferOptions, "onNode" | "onAccount" | "onCompiler"> & { ...; }) | undefined) => Promise<...> & Promise<...>;
      }>>

Generated using TypeDoc