Usage

The following information is deprecated and may limit its use. Please refer to the WalletConnect 2.0 tab for the latest version of NEOPIN wallet integration: WalletConnect 2.0

To use WalletConnect in your Unity project, simply create an empty GameObject in your Scene and attach the WalletConnect component to your GameObject. Attaching this script will automatically attach any required components as well

Options

  • Default Wallet

    • The default wallet to open up on iOS when no when no wallet is specified in None

  • Auto Save and Resume

    • Automatically saves the session when the application pauses or quits and resumes the session when the app resumes or starts.

  • Connect On Awake

    • Whether you would like WalletConnect to automatically start listening for a Wallet connection on awake. The user will still need to initiate a connection either by scanning a QR code or through deep linking

  • Connect On Start

    • Whether you would like WalletConnect to automatically start listening for a Wallet connection on start. The user will still need to initiate a connection either by scanning a QR code or through deep linking

  • Create New Session On Session Disconnect

    • WalletConnect will create a new session every time the current session ends.

  • Connect Session Retry Count

    • How many times a session should attempt to reconnect to the bridge server before failing.

  • Custom Bridge Url

    • Set a custom bridge to connect to.

    • Set to 'https://wc-bridge.neopin.io' to connect with Neopin.

  • Chain Id

    • Unused will be used to specify chain to interact with.

    • NEOPIN Connect supports the following networks and chainID:

    • NetworkMainNetTestNet

      Klaytn

      8217

      1001

      Polygon

      137

      80001

  • Connected Event

    • A Unity Event that is triggered when a Wallet session has started. Nothing is passed to this event listener.

  • Connected Event Session

    • A Unity Event that is triggered when a Wallet session has started. The Session data is passed to this event listener

  • Disconnected Event Session

    • A Unity Event that is triggered when a Wallet session has disconnected. The Session data is passed to this event listener.

  • Connection Failed Event

    • A Unity Event that is triggered when a Wallet session has failed to connect either due to transport errors, network errors, or user declining to create session. The Session data is passed to this event listener

  • New Session Connected

    • A Unity Event that is triggered when a new Wallet session has been successfully created and connected. The Session data is passed to this event listener. This event will only be called once in a session's lifetime.

  • Resumed Session Connected

    • A Unity Event that is triggered when a Wallet session has been successfully resumed and connected. The Session data is passed to this event listener.

  • App Data

    • This is the Session data that is given and shown in the Wallet

  • name

    • The name that will be displayed in the NEOPIN Wallet.

  • description

    • The description to be displayed along with the name (Optional)

  • icons

    • The icon address to be displayed in the NEOPIN Wallet.

  • url

    • The URL to be displayed along with the name.

  • appId

    • appId is issued by NEOPIN, and consists of a 32 digit string.

    • ex) NWC1004HS6VFTPPPLUGFQBQ5SFNWB79B

    • The Wallet will reject connection of any appId that were not issued normally.

  • deepLink

    • deepLink is required when connecting to the NEOPIN Wallet or returning to the service app after making a transaction.

PreviousInstallationNextSDK Components

Last updated