airgap-it / beacon-ios-sdk Goto Github PK

There are currently 3 methods for removing permissions removeAll, removeForAccount and removeByType. When theres only 1 wallet, all will do the same thing, as the accountIdentifier is always the same:

 storageManager.removeAllPermissions(where: { $0.accountID == accountIdentifier })

What i'm looking for is to remove a permissions for a specific app. I want to give users the ability to say remove permission for OBJKT.com, for wallet address X. So something more like

 storageManager.removeAllPermissions(where: { $0.appMetadata.senderID == app && $0.address == address })

I'm not sure if accountID is needed in the above as well or not

SDK supports only accounts with public keys of 32 byte.

However Substrate also supports ECDSA signatures on secp256k1 which has public keys 33 bytes long

When trying to connect to a website you need to scan a QR code which has the url tezos://xxxxxxxxx. This will allow users to scan with their camera app and get a link to a wallet/app

There is an issue on iOS though, that when multiple apps request to use tezos as a URL scheme, which one will be launched is "undefined". iOS doesn't currently display a share sheet style screen to list all the apps, it just picks one. While experimenting with this library I had AirGap installed on my phone and was unable to get the QR code to launch my app, until I deleted AirGap. Relying on this as a method of opening apps is going to cause a headache for users as the number of apps grow.

Short term it would be a good idea to promote the idea that third party apps should embed their own QR scanner, it might be good for BeaconSDK to include a basic one in-built in the SDK. I'm also not sure if i missed it or not, but I found no code in the library to take a tezos://xxxxxx URL and turn it into a P2P class or even turn the data into JSON. I also couldn't find any documentation on how it was encoded or what to do with it. I had to go read the code of a website to see what they did. If such a function doesn't exist, it really needs too. If it does, it should be added to the README documentation.

Longer term, it might be a good idea to try build a website with buttons/deeplinks to whitelisted mobile apps. When the QR code is scanned with the inbuilt camera app, it would bring users to an AIrGap website, with a list of options to launch various apps from there. Hopefully it could be done in such a way that scanning with the default camera app went to the webpage, but scanning with custom in-app, would still contain the necessary data

When scanning a QR code and receiving a URL with a tzip standard, it would be great if the Beacon SDK took care of all of the processing and logic and just had an init that took in a URL. It takes a lot of experimentation and research to figure out what needs to be done with the URL

Beacon.P2PPeer(initWithURL: URL)

I have added beacon-ios-sdk repo into my newly created XCode iOS Project but it can't compile due to error

"Type 'Tezos' does not conform to protocol 'Blockchain'

and then 134 others error following.

Using XCode 12.5.1 on Bigsur 11.1

Feature Request

• I'm using the latest version of the SDK.

Summary

Expected Behaviour

Use Case

Additional Context

Originally posted by @Jacobtarango1996 in #26

As mentioned below, the current CocoaPods setup is invalid and must be fixed.

iOS

We're not planning on releasing to CocoaPods. But yes, it's possible to add the dependency directly from GitHub. I'll make sure the pod spec file is up to date and update README with detailed information on how to do it.

I have tried current podspec file from here. There are several building issues due to the fact that Cocoapods builds single framework from subspecs:

• duplicate file AppMetadata.swift
• not needed 'import BeaconCore' in subspecs (for example, BeaconBlockchainSubstrate)
• various definition duplicates, for example, ExtendedDependencyRegistry

Looks like we need a separate podspecs instead of subspecs.

Originally posted by @ERussel in airgap-it/beacon-android-sdk#4 (comment)

Most of the callbacks used are connected to a UI event, but all callbacks are returned on a background thread. I think the majority, if not all, should be bounced back to the main thread.

Examples:

• When a request comes in, first thing I do is put a spinner on the screen to show the user that something is incoming. That means having to put a call to run on main thread at the start of every incoming request
• Removing peers / permissions are trigger via a UI button, its not something I do in the background without user action. Again my exception would be to throw up a spinner, call the code to remove and then remove the spinner and refresh
• Adding peers or permissions, again trigger by UI event

Version: 3.0.1-beta.3

How to reproduce:

1. Open https://andreasgassmann.github.io/apps
2. Choose Nova Wallet
3. Scan QR
4. SDK is successfully connected
5. Accept permission request from DApp
6. Open Accounts -> Send -> Enter amount -> Sign Transaction
7. SDK receives the message for signing

{\"id\":\"7df08e75-a54c-512d-74d7-eae9bf11c473\",\"version\":\"3\",\"senderId\":\"21QXo8LWoWsqd\",\"message\":{\"blockchainData\":{\"address\":\"0x5464864242fd9a50c0aafd65cdc49939d80097e7dc4a741aa1cdbfb61fc7862d\",\"metadata\":{\"genesisHash\":\"\",\"runtimeVersion\":\"\",\"transactionVersion\":\"\"},\"mode\":\"return\",\"payload\":\"0x0403005464864242fd9a50c0aafd65cdc49939d80097e7dc4a741aa1cdbfb61fc7862d02286bee45021000c823000009000000e143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423ede745e5f21c254da470b5f6bd6f60bf1337f752ae06b2d323ca3f324c755179e\",\"scope\":\"sign_raw\"},\"blockchainIdentifier\":\"substrate\",\"type\":\"blockchain_request\",\"accountId\":\"ZwkjmCErtCqLxLGpBdr\"}}

8. SDK throws an error during parsing:

Swift.DecodingError.keyNotFound(CodingKeys(stringValue: "type", intValue: nil), Swift.DecodingError.Context(codingPath: [CodingKeys(stringValue: "message", intValue: nil), CodingKeys(stringValue: "blockchainData", intValue: nil)], debugDescription: "No value associated with key CodingKeys(stringValue: \"type\", intValue: nil) (\"type\").", underlyingError: nil))

Feature Request

• I'm using the latest version of the SDK.

Summary

Expected Behaviour

Use Case

Additional Context

When receiving a signPayload request, I can't find anything to help me convert the hex into a human readable string. I roughly followed a snippet on the Taquito docs to figure out what needs to be done, but i'm not sure if it will cover all cases, if there are tzips etc. And I can't use taquito to parse it.

It would be great if the SDK did this for you, by having a "humanReadable" string property as part of the signPayload request object

As mentioned on slack, i've encountered an issue where the below callback / print out gets executed twice whenever I add a Peer:

beaconClient?.add([.p2p(peer)], completion: { result in
	switch result {
		case .success():
			print("peer added success")
					
			completion(true)
					
		case .failure(_):
			completion(false)
	}
})

Digging through it and a few other issues I ran the leak inspector and found a few leaks while starting beacon, removing peers/permissions and trying to add a new peer:

Not sure if a symptom of: #12 or not

While testing, I connected to the same app over and over, each time removing all peers and permissions in between each test. I repeated this many times. Due to the above mentioned issue, removing the permissions didn't do anything. But the SDK allowed the app to store identical permissions over and over, differing only based on permission.connectedAt

index: 2, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H, sppk7c97qQxH3Dm74qwEbCqT2s7ZHxAbSC7hjevVcow8u4brTDYgzhc [BeaconBlockchainTezos.Tezos.Permission.Scope.operationRequest, BeaconBlockchainTezos.Tezos.Permission.Scope.sign] Network(type: BeaconBlockchainTezos.Tezos.Network.Type.mainnet, name: nil, rpcURL: nil) tz2HmW8Am8cpkvMHMe9sGRykTnrHXCLWVMAu 1652197579646
index: 3, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H, sppk7c97qQxH3Dm74qwEbCqT2s7ZHxAbSC7hjevVcow8u4brTDYgzhc [BeaconBlockchainTezos.Tezos.Permission.Scope.operationRequest, BeaconBlockchainTezos.Tezos.Permission.Scope.sign] Network(type: BeaconBlockchainTezos.Tezos.Network.Type.mainnet, name: nil, rpcURL: nil) tz2HmW8Am8cpkvMHMe9sGRykTnrHXCLWVMAu 1652197725338
index: 4, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H, sppk7c97qQxH3Dm74qwEbCqT2s7ZHxAbSC7hjevVcow8u4brTDYgzhc [BeaconBlockchainTezos.Tezos.Permission.Scope.operationRequest, BeaconBlockchainTezos.Tezos.Permission.Scope.sign] Network(type: BeaconBlockchainTezos.Tezos.Network.Type.mainnet, name: nil, rpcURL: nil) tz2HmW8Am8cpkvMHMe9sGRykTnrHXCLWVMAu 1652198603654
index: 5, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H, sppk7c97qQxH3Dm74qwEbCqT2s7ZHxAbSC7hjevVcow8u4brTDYgzhc [BeaconBlockchainTezos.Tezos.Permission.Scope.operationRequest, BeaconBlockchainTezos.Tezos.Permission.Scope.sign] Network(type: BeaconBlockchainTezos.Tezos.Network.Type.mainnet, name: nil, rpcURL: nil) tz2HmW8Am8cpkvMHMe9sGRykTnrHXCLWVMAu 1652199196001
index: 6, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H, sppk7c97qQxH3Dm74qwEbCqT2s7ZHxAbSC7hjevVcow8u4brTDYgzhc [BeaconBlockchainTezos.Tezos.Permission.Scope.operationRequest, BeaconBlockchainTezos.Tezos.Permission.Scope.sign] Network(type: BeaconBlockchainTezos.Tezos.Network.Type.mainnet, name: nil, rpcURL: nil) tz2HmW8Am8cpkvMHMe9sGRykTnrHXCLWVMAu 1652199264466

I would have expected the same app, requesting access to the same wallet, to overwrite an identical permission to avoid any issues with lingering permissions/connections from causing issues

Can't import via SPM due to an underlying issue with the way sodium is packaged. There is a work around, but the owner refuses to integrate as he wants Apple to fix the underlying issue in Xcode instead. Its listed as an "known issue" in Xcode 13 so will hopefully be fixed with that release.

Someone else made a fork that fixes the issue in most cases for now. You can update your dependency to use:

.package(name: "Sodium", url: "https://github.com/junelife/swift-sodium.git", .branch("spm")),

and remove the line

.product(name: "Clibsodium", package: "Sodium"),

And take note to revert it back when the issue is addressed.

I've tried calling:

beaconClient?.removeAllPermissions(completion: { result in
	...
})

and

beaconClient?.removePermissions(forAccountIdentifier: permission.accountIdentifier, completion: { result in
	...
})

neither are removing any permissions. Here is my console log. I fetched all permissions, found that there were many that should have been removed a long time ago after multiple calls to removeAll.... Tried to delete the first (printing that I have the correct ID), then afterwards reloaded my tableview and all the same ones are present

Removing Peers is working fine

=== Fetching permissions ===
index: 0, name: Mooncakes, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 1, name: Mooncakes, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 2, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 3, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 4, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 5, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 6, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 7, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 8, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 9, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 10, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 11, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 12, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 13, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 14, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 15, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 16, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 17, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 18, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 19, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 20, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 21, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 22, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
=== End Fetching permissions ===


Delete tapped for row: 0
inside permissions
Remove: name: Mooncakes, accountIdentifier: SEJf6AoXUeeELGPmh6H
permission - result: success()


=== Fetching permissions ===
index: 0, name: Mooncakes, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 1, name: Mooncakes, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 2, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 3, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 4, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 5, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 6, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 7, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 8, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 9, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 10, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 11, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 12, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 13, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 14, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 15, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 16, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 17, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 18, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 19, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 20, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 21, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
index: 22, name: objkt.com, accountIdentifier: SEJf6AoXUeeELGPmh6H
=== End Fetching permissions ===

.podspec file

  s.dependency 'BeaconBlockchainSubstrate'
  s.dependency 'BeaconBlockchainTezos'
  s.dependency 'BeaconClientWallet'
  s.dependency 'BeaconCore'
  s.dependency 'BeaconTransportP2PMatrix'
  s.dependency 'BeaconClientDApp'
  s.platform = :ios, '13.0'

Error

[!] Unable to find a specification for `BeaconClientDApp` depended upon by `beacon`

You have either:
 * out-of-date source repos which you can update with `pod repo update` or with `pod install --repo-update`.
 * mistyped the name or version.
 * not added the source repo that hosts the Podspec to your Podfile.

I am trying to publish a beacon plugin for iOS. But I am unable to add beacon-ios-sdk in my plugin.

version on Beacon.Request is not listed as public and not accessible on request objects. One of the constructors for a response required passing in the version, I had to workaround it to store it and retrieve it from elsewhere

private var beaconClient: Beacon.WalletClient? = nil
beaconClient?.getPeers called

I'm confused how to manage beacon within the iOS app lifecycle events (e.g. going to background, foreground, suspend etc.). I have created a Beacon.Client instance, told it to connect, and I registered a function to listen for incoming events. How do I disconnect / stop listening when the app goes into background and reconnect when it's reopened? I can't see any public disconnect / stop listening function, only the ability to remove a peer entirely

Can you expose the underlying URLSession object to devs so that the requests can be mocked easily?

If you expose a URLSession parameter, I can just create a Mock instance of URLProtocol, pass it a list of URLs and file names, and then everything is mocked throughout my app/library with a handful of lines of code. Without that, it means having to subclass and duplicate many classes and understand business logic in order to be able to implement unit tests around the code. Multiple this by 10 third party libraries and it becomes a lot of effort, and going forward having to update whenever a function definition is changed

You can find code in "dev-bibash" branch
https://github.com/bibash28/beacon-ios-sdk/tree/dev-bibash