WAX Unity Web3 Suite
AnchorLink
AnchorLink
  • Getting Started
  • Installation
    • WebGL installation
  • Examples
    • Quick Start
    • Login
    • Transact (with a Session)
    • Transact (without a Session)
    • Token Transfer
    • Vote
    • Manage CPU/NET
    • Sell Ram
    • Buy Ram
    • Bid Name
  • API Docs
    • AnchorLinkSharp
      • AnchorLink
      • ChannelInfo
      • Defaults
      • IdentifyResult
      • LinkAbiData
      • LinkCallback
      • LinkChannelSession
      • LinkChannelSessionData
      • LinkConstants
      • LinkCreate
      • LinkFallbackSession
      • LinkFallbackSessionData
      • LinkInfo
      • LinkOptions
      • LinkSession
      • LinkSessionDataBase
      • LinkSessionDataConverter
      • LinkSignatureProvider
      • LinkSignatureProviderArgs
      • LinkUtils
      • LoginResult
      • SealedMessage
      • SerializedLinkSession
      • TransactArgs
      • TransactOptions
      • TransactResult
      • WebSocketWrapper
      • Interfaces
        • ILinkOptions
        • ILinkStorage
        • ILinkTransport
      • Exceptions
        • LinkException
        • IdentityException
        • CancelException
        • SessionException
    • EosioSigningRequest
      • AbiConstants
      • CallbackPayload
      • IZlibProvider
      • IdentityV2
      • IdentityV3
      • InfoPair
      • RejectedPayload
      • RequestSignature
      • ResolvedCallback
      • ResolvedSigningRequest
      • SigningRequest
      • SigningRequestAbi
      • SigningRequestConstants
      • SigningRequestCreateArguments
      • SigningRequestCreateIdentityArguments
      • SigningRequestData
      • SigningRequestEncodingOptions
      • TransactionContext
      • TransactionHeader
    • AnchorLinkTransportSharp
      • Transports
        • UnityTransport
        • UnityCanvasTransport
        • UnityUiToolkitTransport
          • ScreenBase
          • PanelBase
          • FailurePanel
          • LoadingPanel
          • QrCodePanel
          • SigningTimerPanel
          • SuccessPanel
          • TimeoutPanel
          • Utils
      • StorageProviders
        • PlayerPrefsStorage
        • JsonLocalStorage
      • TransportOptions
      • NetZlibProvider
Powered by GitBook
On this page
  • Summary
  • Members
Edit on GitHub
  1. API Docs
  2. AnchorLinkSharp

AnchorLink

class AnchorLinkSharp::AnchorLink
  : public AbiSerializationProvider

Main class

Summary

Members
Descriptions

Transport used to deliver requests to the user wallet.

EOSIO ChainID for which requests are valid.

PlayerPrefsStorage adapter used to persist sessions.

Create a new anchorLink instance.

Fetch the ABI for given account, cached.

Create a new unique buoy callback url.

Create a SigningRequest instance configured for this anchorLink.

Send a SigningRequest instance using this anchorLink.

Sign and optionally broadcast a EOSIO transaction, action or actions.

Send an identity request and verify the identity proof.

Login and create a persistent session.

Restore previous session, see [[AnchorLink.login]] to create a new session.

List stored session auths for given identifier. The most recently used session is at the top (index 0).

Remove stored session for given identifier and auth.

Remove all stored sessions for given identifier.

Create an eosjs compatible signature provider using this anchorLink.

Connect to a WebSocket channel and wait for a message.

Makes sure session is in storage list of sessions and moves it to top (most recently used).

Makes sure session is in storage list of sessions and moves it to top (most recently used).

Session storage key for identifier and suffix.

Members

Transport used to deliver requests to the user wallet.

EOSIO ChainID for which requests are valid.

PlayerPrefsStorage adapter used to persist sessions.

Create a new anchorLink instance.

Fetch the ABI for given account, cached.

Create a new unique buoy callback url.

Create a SigningRequest instance configured for this anchorLink.

Send a SigningRequest instance using this anchorLink.

Sign and optionally broadcast a EOSIO transaction, action or actions.

Example:

var result = await myLink.transact({transaction: myTx})

Parameters

  • args The action, actions or transaction to use.

  • options Options for this transact call.

  • transport Transport override, for internal use.

Send an identity request and verify the identity proof.

Parameters

  • requestPermission Optional request permission if the request is for a specific account or permission.

  • info Metadata to add to the request.

This is for advanced use-cases, you probably want to use [[AnchorLink.login]] instead.

Login and create a persistent session.

Parameters

  • identifier The session identifier, an EOSIO name ([a-z1-5]{1,12}). Should be set to the contract account if applicable.

Restore previous session, see [[AnchorLink.login]] to create a new session.

Parameters

  • identifier The session identifier, should be same as what was used when creating the session with [[AnchorLink.login]].

  • auth A specific session auth to restore, if omitted the most recently used session will be restored.

Returns

A [[LinkSession]] instance or null if no session can be found.

Exceptions

  • If no [[LinkStorage]] adapter is configured or there was an error retrieving the session data.

List stored session auths for given identifier. The most recently used session is at the top (index 0).

Exceptions

  • If no [[LinkStorage]] adapter is configured or there was an error retrieving the session list.

Remove stored session for given identifier and auth.

Exceptions

  • If no [[LinkStorage]] adapter is configured or there was an error removing the session data.

Remove all stored sessions for given identifier.

Exceptions

  • If no [[LinkStorage]] adapter is configured or there was an error removing the session data.

Create an eosjs compatible signature provider using this anchorLink.

Parameters

  • availableKeys Keys the created provider will claim to be able to sign for.

  • transport (internal) Transport override for this call.

We don't know what keys are available so those have to be provided, to avoid this use [[LinkSession.makeSignatureProvider]] instead. Sessions can be created with [[AnchorLink.login]].

Connect to a WebSocket channel and wait for a message.

Makes sure session is in storage list of sessions and moves it to top (most recently used).

Makes sure session is in storage list of sessions and moves it to top (most recently used).

Session storage key for identifier and suffix.

PreviousAnchorLinkSharpNextChannelInfo

Last updated 2 years ago

public readonly

public readonly string

public readonly

public ( options)

public async Task< Abi > (string account)

public string ()

public async Task< SigningRequest > (SigningRequestCreateArguments args, transport)

public async Task< > (SigningRequest request, transport, bool broadcast)

public async Task< > ( args, options, transport)

public async Task< > (PermissionLevel requestPermission, object info)

public async Task< > (string identifier)

public async Task< > (string identifier, PermissionLevel auth)

public async Task< List< PermissionLevel > > (string identifier)

public async Task (string identifier, PermissionLevel auth)

public async void (string identifier)

public LinkSignatureProvider (string[] availableKeys, transport)

public async Task< > (string url)

public async Task (string url)

private readonly string

private readonly SigningRequestEncodingOptions

private readonly Dictionary< string, Abi > = new Dictionary<string, Abi>()

private readonly Dictionary< string, Task< GetAbiResponse > > = new Dictionary<string, Task<GetAbiResponse>>()

private WebSocketWrapper

private async Task (string identifier, PermissionLevel auth, bool remove)

private async Task (string identifier, session)

private string (string identifier, string[] suffixes)

public readonly

public readonly string

public readonly

public ( options)

public async Task< Abi > (string account)

public string ()

public async Task< SigningRequest > (SigningRequestCreateArguments args, transport)

public async Task< > (SigningRequest request, transport, bool broadcast)

public async Task< > ( args, options, transport)

public async Task< > (PermissionLevel requestPermission, object info)

public async Task< > (string identifier)

public async Task< > (string identifier, PermissionLevel auth)

public async Task< List< PermissionLevel > > (string identifier)

public async Task (string identifier, PermissionLevel auth)

public async void (string identifier)

public LinkSignatureProvider (string[] availableKeys, transport)

public async Task< > (string url)

public async Task (string url)

private readonly string

private readonly SigningRequestEncodingOptions

private readonly Dictionary< string, Abi > = new Dictionary<string, Abi>()

private readonly Dictionary< string, Task< GetAbiResponse > > = new Dictionary<string, Task<GetAbiResponse>>()

private WebSocketWrapper

private async Task (string identifier, PermissionLevel auth, bool remove)

private async Task (string identifier, session)

private string (string identifier, string[] suffixes)

ILinkTransport
Transport
ChainId
ILinkStorage
Storage
ILinkOptions
AnchorLink
GetAbi
CreateCallbackUrl
ILinkTransport
CreateRequest
TransactResult
ILinkTransport
SendRequest
TransactResult
TransactArgs
TransactOptions
ILinkTransport
Transact
IdentifyResult
Identify
LoginResult
Login
LinkSession
RestoreSession
ListSessions
RemoveSession
ClearSessions
ILinkTransport
MakeSignatureProvider
CallbackPayload
WaitForCallback
PollForCallback
_serviceAddress
_requestOptions
_abiCache
_pendingAbis
_socket
TouchSession
LinkSession
StoreSession
SessionKey
ILinkTransport
Transport
ChainId
ILinkStorage
Storage
ILinkOptions
AnchorLink
GetAbi
CreateCallbackUrl
ILinkTransport
CreateRequest
TransactResult
ILinkTransport
SendRequest
TransactResult
TransactArgs
TransactOptions
ILinkTransport
Transact
IdentifyResult
Identify
LoginResult
Login
LinkSession
RestoreSession
ListSessions
RemoveSession
ClearSessions
ILinkTransport
MakeSignatureProvider
CallbackPayload
WaitForCallback
PollForCallback
_serviceAddress
_requestOptions
_abiCache
_pendingAbis
_socket
TouchSession
LinkSession
StoreSession
SessionKey