Interface StacksProvider

Hierarchy

StacksProvider

Index

Properties

Methods

authenticationRequest profileUpdateRequest psbtRequest request signatureRequest structuredDataSignatureRequest transactionRequest

Properties

getProductInfo

getProductInfo: (() => {
    meta?: {
        commit?: string;
        tag?: string;
        [key: string]: any;
    };
    name: string;
    version: string;
    [key: string]: any;
})

Type declaration

- (): {
      meta?: {
          commit?: string;
          tag?: string;
          [key: string]: any;
      };
      name: string;
      version: string;
      [key: string]: any;
  }
- Returns {
      meta?: {
          commit?: string;
          tag?: string;
          [key: string]: any;
      };
      name: string;
      version: string;
      [key: string]: any;
  }
  - [key: string]: any
  - Optional meta?: {
        commit?: string;
        tag?: string;
        [key: string]: any;
    }
    - [key: string]: any
    - Optional commit?: string
    - Optional tag?: string
  - name: string
  - version: string

getURL

getURL: (() => Promise<string>)

Type declaration

- (): Promise<string>
- Deprecated
  
  Returns Promise<string>

Methods

authenticationRequest

authenticationRequest(payload: string): Promise<string>
Make an authentication request

Returns
an authResponse string in the form of a JSON web token
Parameters
- payload: string
  
  a JSON web token representing an auth request
Returns Promise<string>
- Defined in packages/connect/dist/types/types/provider.d.ts:21

profileUpdateRequest

profileUpdateRequest(payload: string): Promise<PublicPersonProfile>
Parameters
- payload: string
Returns Promise<PublicPersonProfile>
- Defined in packages/connect/dist/types/types/provider.d.ts:28

psbtRequest

psbtRequest(payload: string): Promise<PsbtData>
Experimental
Parameters
- payload: string
Returns Promise<PsbtData>
- Defined in packages/connect/dist/types/types/provider.d.ts:27

request

request(method: string, params?: any[]): Promise<Record<string, any>>
Parameters
- method: string
- Optional params: any[]
Returns Promise<Record<string, any>>
- Defined in packages/connect/dist/types/types/provider.d.ts:29

signatureRequest

signatureRequest(payload: string): Promise<SignatureData>
Parameters
- payload: string
Returns Promise<SignatureData>
- Defined in packages/connect/dist/types/types/provider.d.ts:22

structuredDataSignatureRequest

structuredDataSignatureRequest(payload: string): Promise<SignatureData>
Parameters
- payload: string
Returns Promise<SignatureData>
- Defined in packages/connect/dist/types/types/provider.d.ts:23

transactionRequest

transactionRequest(payload: string): Promise<FinishedTxPayload | SponsoredFinishedTxPayload>
Make a transaction request
Parameters
- payload: string
  
  a JSON web token representing a transaction request
Returns Promise<FinishedTxPayload | SponsoredFinishedTxPayload>
- Defined in packages/connect/dist/types/types/provider.d.ts:13

Interface StacksProvider

Hierarchy

Index

Properties

Methods

Properties

getProductInfo

Type declaration

Returns { meta?: { commit?: string; tag?: string; [key: string]: any; }; name: string; version: string; [key: string]: any; }

[key: string]: any

Optional meta?: { commit?: string; tag?: string; [key: string]: any; }

[key: string]: any

Optional commit?: string

Optional tag?: string

name: string

version: string

getURL

Type declaration

Deprecated

Returns Promise<string>

Methods

authenticationRequest

Returns

Parameters

payload: string

Returns Promise<string>

profileUpdateRequest

Parameters

payload: string

Returns Promise<PublicPersonProfile>

psbtRequest

Parameters

payload: string

Returns Promise<PsbtData>

request

Parameters

method: string

Optional params: any[]

Returns Promise<Record<string, any>>

signatureRequest

Parameters

payload: string

Returns Promise<SignatureData>

structuredDataSignatureRequest

Parameters

payload: string

Returns Promise<SignatureData>

transactionRequest

Parameters

payload: string

Returns Promise<FinishedTxPayload | SponsoredFinishedTxPayload>

Theme

Returns {
meta?: {
commit?: string;
tag?: string;
[key: string]: any;
};
name: string;
version: string;
[key: string]: any;
}

`Optional` meta?: {
commit?: string;
tag?: string;
[key: string]: any;
}

`Optional` commit?: string

`Optional` tag?: string

`Optional` params: any[]