Function useConnect

Returns {
    authData: FinishedAuthData;
    authOptions: AuthOptions;
    authenticate: ((authOptions: AuthOptions, provider?: StacksProvider) => Promise<void>);
    doAuth: ((options?: Partial<AuthOptions>, provider?: StacksProvider) => void);
    doContractCall: ((options: ContractCallOptions, provider?: StacksProvider) => Promise<void>);
    doContractDeploy: ((options: ContractDeployOptions, provider?: StacksProvider) => Promise<void>);
    doOpenAuth: ((signIn?: boolean, options?: Partial<AuthOptions>, provider?: StacksProvider) => void);
    doProfileUpdate: ((options: ProfileUpdateRequestOptions, provider?: StacksProvider) => Promise<void>);
    doSTXTransfer: ((options: STXTransferOptions, provider?: StacksProvider) => Promise<void>);
    isAuthenticating: boolean;
    isOpen: boolean;
    sign: ((options: SignatureRequestOptions, provider?: StacksProvider) => Promise<void>);
    signPsbt: ((options: PsbtRequestOptions, provider?: StacksProvider) => Promise<void>);
    signStructuredData: ((options: StructuredDataSignatureRequestOptions, provider?: StacksProvider) => Promise<void>);
    userSession: UserSession;
}

• authData: FinishedAuthData

• authOptions: AuthOptions

• authenticate: ((authOptions: AuthOptions, provider?: StacksProvider) => Promise<void>)

  • • (authOptions: AuthOptions, provider?: StacksProvider): Promise<void>

    • Parameters

      • authOptions: AuthOptions

      • Optional provider: StacksProvider

      Returns Promise<void>

• doAuth: ((options?: Partial<AuthOptions>, provider?: StacksProvider) => void)

  • • (options?: Partial<AuthOptions>, provider?: StacksProvider): void

    • Parameters

      • options: Partial<AuthOptions> = {}

      • Optional provider: StacksProvider

      Returns void

• doContractCall: ((options: ContractCallOptions, provider?: StacksProvider) => Promise<void>)

  • • (options: ContractCallOptions, provider?: StacksProvider): Promise<void>

    • Parameters

      • options: ContractCallOptions

      • Optional provider: StacksProvider

      Returns Promise<void>

• doContractDeploy: ((options: ContractDeployOptions, provider?: StacksProvider) => Promise<void>)

  • • (options: ContractDeployOptions, provider?: StacksProvider): Promise<void>

    • Parameters

      • options: ContractDeployOptions

      • Optional provider: StacksProvider

      Returns Promise<void>

• doOpenAuth: ((signIn?: boolean, options?: Partial<AuthOptions>, provider?: StacksProvider) => void)

  • • (signIn?: boolean, options?: Partial<AuthOptions>, provider?: StacksProvider): void

    • Parameters

      • Optional signIn: boolean

        Whether the user should be sent to sign in

      • Optional options: Partial<AuthOptions>

      • Optional provider: StacksProvider

      Returns void

• doProfileUpdate: ((options: ProfileUpdateRequestOptions, provider?: StacksProvider) => Promise<void>)

  • • (options: ProfileUpdateRequestOptions, provider?: StacksProvider): Promise<void>

    • Parameters

      • options: ProfileUpdateRequestOptions

      • Optional provider: StacksProvider

      Returns Promise<void>

• doSTXTransfer: ((options: STXTransferOptions, provider?: StacksProvider) => Promise<void>)

  • • (options: STXTransferOptions, provider?: StacksProvider): Promise<void>

    • Parameters

      • options: STXTransferOptions

      • Optional provider: StacksProvider

      Returns Promise<void>

• isAuthenticating: boolean

• isOpen: boolean

• sign: ((options: SignatureRequestOptions, provider?: StacksProvider) => Promise<void>)

  • • (options: SignatureRequestOptions, provider?: StacksProvider): Promise<void>

    • Parameters

      • options: SignatureRequestOptions

      • Optional provider: StacksProvider

      Returns Promise<void>

• signPsbt: ((options: PsbtRequestOptions, provider?: StacksProvider) => Promise<void>)

  • • (options: PsbtRequestOptions, provider?: StacksProvider): Promise<void>

    • Parameters

      • options: PsbtRequestOptions

      • Optional provider: StacksProvider

      Returns Promise<void>

• signStructuredData: ((options: StructuredDataSignatureRequestOptions, provider?: StacksProvider) => Promise<void>)

  • • (options: StructuredDataSignatureRequestOptions, provider?: StacksProvider): Promise<void>

    • Parameters

      • options: StructuredDataSignatureRequestOptions

      • Optional provider: StacksProvider

      Returns Promise<void>

• userSession: UserSession