ao-js-sdk - v0.0.9
    Preparing search index...

    Interface IRandomClient

    interface IRandomClient {
        claimRewards(): Promise<void>;
        commit(
            params: {
                puzzle: { input: string; modulus: string };
                requestId: string;
            },
        ): Promise<void>;
        crank(): Promise<void>;
        createRequest(
            providersIds: string[],
            requestedInputs: number,
            callbackId: string,
        ): Promise<boolean>;
        getAllProviderActivity(): Promise<ProviderActivity[]>;
        getAllUserInfo(): Promise<GetUserInfoResponse[]>;
        getOpenRandomRequests(
            provider: string,
        ): Promise<GetOpenRandomRequestsResponse>;
        getProviderActivity(providerId: String): Promise<ProviderActivity>;
        getProviderAvailableValues(
            provider: string,
        ): Promise<GetProviderAvailableValuesResponse>;
        getRandomRequests(
            randomnessRequestIds: string[],
        ): Promise<GetRandomRequestsResponse>;
        getRandomRequestViaCallbackId(
            callbackId: string,
        ): Promise<GetRandomRequestsResponse>;
        getUserInfo(userId: string): Promise<GetUserInfoResponse>;
        prepay(quantity: number, userId?: string): Promise<boolean>;
        redeem(
            providersIds?: string[],
            requestedInputs?: number,
            callbackId?: string,
        ): Promise<boolean>;
        reveal(
            params: { requestId: string; rsa_key: { p: string; q: string } },
        ): Promise<void>;
        updateProviderAvailableValues(
            amount: number,
            info?: MonitoringData,
        ): Promise<boolean>;
    }

    Implemented by

    Index

    Methods

    claimRewards commit crank createRequest getAllProviderActivity getAllUserInfo getOpenRandomRequests getProviderActivity getProviderAvailableValues getRandomRequests getRandomRequestViaCallbackId getUserInfo prepay redeem reveal updateProviderAvailableValues

    Methods

    • Posts a timeunlocked commitement to a randomness request

      Parameters

      • params: { puzzle: { input: string; modulus: string }; requestId: string }
        • puzzle: { input: string; modulus: string }
          • input: string

            The timelock puzzle input base64 (no 0x)

          • modulus: string

            The timelock puzzle modulus base64 (no 0x)

        • requestId: string

          Id of the randomness request to commit to

      Returns Promise<void>

    • Creates a new randomness request using a list of provider IDs.

      Parameters

      • providersIds: string[]

        An array of provider IDs to include in the request.

      • requestedInputs: number

        The number of requested random inputs.

      • callbackId: string

        A unique identifier for tracking the request callback.

      Returns Promise<boolean>

      • A promise that resolves with a boolean indicating success.

    • Redeem random credits

      Parameters

      • OptionalprovidersIds: string[]
      • OptionalrequestedInputs: number
      • OptionalcallbackId: string

      Returns Promise<boolean>

    • Posts a timeunlocked commitement to a randomness request

      Parameters

      • params: { requestId: string; rsa_key: { p: string; q: string } }
        • requestId: string

          Id of the randomness request to reveal

        • rsa_key: { p: string; q: string }
          • p: string

            base64 (no 0x)

          • q: string

            base64 (no 0x)

      Returns Promise<void>

    • Updates the count of available random values for a specific provider.

      Parameters

      • amount: number

        The new amount of random values available.

      • Optionalinfo: MonitoringData

        An optional MonitoringData object containing provider monitoring information.

      Returns Promise<boolean>

      • A promise that resolves with a boolean indicating success.

    Settings

    Member Visibility

    On This Page

    Methods