Merge pull request #74 from mlabs-haskell/misha/spitting-addons

Splitting demo project, CIP-30 addon and Paima addon

Author: rmgaray

.gitignore

@@ -6,10 +6,12 @@
 /private-testnet/
 *.so
 *.dll
+*.wasm
 .godot/
 seed_phrase.txt
 preview_token.txt
 result*
 */.godot/
 .pre-commit-config.yaml
+.vscode
 */.home/

addons/@mlabs-haskell/cip-30-callbacks/cip_30_callbacks.gd

@@ -0,0 +1,96 @@
+extends Node
+class_name Cip30Callbacks
+## Provides a CIP-30 wrapper for a wallet in a web environment.
+## 
+## Used to register a CIP-30 wallet in a browser environment by adding
+## GDScript callbacks to the global [code]window.cardano.godot[/code] Object. These callbacks
+## defer their implementation to a [Cip30WalletApi] object, which is required for
+## initializing the class ([method Cip30Callbacks._init]).
+
+# NOTE
+# [JsCip30Api] contains a JS script that creates the `window.cardano.godot` Object
+# and also wraps these callbacks one more time to return a Promise in the JS side.
+# Promises are returned because it is not clear how to get `return` value back from [JavaScriptBridge] callbacks
+# (see https://forum.godotengine.org/t/getting-return-value-from-js-callback/54190/3)
+
+# NOTE
+# If [RefCounted] is used, then GDScript callbacks stop working - they are not called at all.
+# Probably coz references to callbacks are lost (see below).
+# (?) Alternative is to keep reference to `RefCounted` on root node (main.gd)
+
+var _cip_30_wallet: Cip30WalletApi
+
+# This references must be kept
+# See example: https://docs.godotengine.org/en/stable/classes/class_javascriptobject.html#javascriptobject
+var _js_cb_get_unused_addresses = JavaScriptBridge.create_callback(_cb_get_unused_addresses)
+var _js_cb_get_used_addresses = JavaScriptBridge.create_callback(_cb_get_used_addresses)
+var _js_cb_sign_data = JavaScriptBridge.create_callback(_cb_sign_data)
+
+## Configure the CIP-30 API to use the provided [param cip_30_wallet]
+func _init(cip_30_wallet: Cip30WalletApi):
+	_cip_30_wallet = cip_30_wallet
+
+# TODO: CIP-30 compliant errors
+## Initialize the CIP-30 API by adding it to the global window object.
+func add_to(window):
+	if !window:
+		print("GD: Browser 'window' not found - skip adding CIP-30 callbacks")
+		return
+	
+	# JsCip30Api initiates `window.cardano.godot` Object where callbacks are added
+	# so this step should be executed before setting GDScript callbacks
+	JsCip30Api.new().init_cip_30_api()
+	# Setting GDScript callbacks
+	window.cardano.godot.callbacks.get_used_addresses = _js_cb_get_used_addresses
+	window.cardano.godot.callbacks.get_unused_addresses = _js_cb_get_unused_addresses
+	window.cardano.godot.callbacks.sign_data = _js_cb_sign_data
+	print("GD: CIP-30 JS API initialization is done")
+
+func _cb_get_used_addresses(args):
+	prints("GD: _cb_get_used_addresses")
+	var addresses = JavaScriptBridge.create_object("Array", 1)
+	addresses[0] = _cip_30_wallet.get_address()
+	var promise_resolve: JavaScriptObject = args[0]
+	promise_resolve.call("call", promise_resolve.this, addresses)
+
+func _cb_get_unused_addresses(args):
+	var addresses = JavaScriptBridge.create_object("Array", 0)
+	var promise_resolve: JavaScriptObject = args[0]
+	promise_resolve.call("call", promise_resolve.this, addresses)
+
+# TODO: CIP-30 sign errors
+#DataSignErrorCode {
+	#ProofGeneration: 1,
+	#AddressNotPK: 2,
+	#UserDeclined: 3,
+#}
+#type DataSignError = {
+	#code: DataSignErrorCode,
+	#info: String
+#}
+func _cb_sign_data(args):
+	var promise_resolve: JavaScriptObject = args[0]
+	var promise_reject: JavaScriptObject = args[1]
+	var signing_address: String = args[2]
+	var data_hex: String = args[3]
+	
+	# TODO: If we want proper CIP-30 support, we should parse the address (could be hex or bech32)
+	# to pub key and differentiate between ProofGeneration and AddressNotPK errors
+	
+	# Paima framework will pass bech32 encoded Address into the sing request if the wallet is not Nami
+	if !_cip_30_wallet.owns_address(signing_address):
+		var sign_error = JavaScriptBridge.create_object("Object")
+		sign_error.code = 1
+		sign_error.info = "Wallet can't sign data - address does not belong to the wallet, or not properly encoded (expecting hex)"
+		promise_reject.call("call", promise_reject.this, sign_error)
+		return
+	
+	prints("GD:CIP-30:sign data:", "address: ", signing_address, ", data hex: ", data_hex)
+	var sign_result = _cip_30_wallet.sign_data("", data_hex)
+	promise_resolve.call("call", promise_resolve.this, sign_result)
+
+func _ready():
+	pass
+
+func _process(delta):
+	pass

addons/@mlabs-haskell/cip-30-callbacks/cip_30_js_api.gd

@@ -0,0 +1,60 @@
+extends RefCounted
+class_name JsCip30Api
+
+## Class responsible for initilizing the global Cardano object in a web environment
+##
+## This class is used internally by [Cip30Callbacks]. If you want to use the wallet
+## provided by godot-cardano in a web environment, check the documentation for that
+## class instead.[br][br]
+##
+## You should only use this class if you know what you are doing.
+
+## Initialize `window.cardano` (if it does not exist yet) and register the
+## godot-cardano wallet.
+func init_cip_30_api():
+	JavaScriptBridge.eval("""
+	function initCip30Godot() {
+			if (!window.cardano) {
+				window.cardano = new Object();
+			}
+			window.cardano.godot = cip30Godot;
+			console.log('GD:JS eval: done setting CIP-30 Godot wallet to `window.cardano.godot`');
+		}
+
+	const cip30Godot = {
+			name: "godot",
+			icon: null,
+			enable: enableGodotCardano,
+			callbacks: new Object()
+		}
+
+	async function enableGodotCardano() {
+			return cip30ApiGodot
+		}
+
+	const cip30ApiGodot = {
+			name: "godot",
+			getUsedAddresses: () => wrapCb(window.cardano.godot.callbacks.get_used_addresses),
+			getUnusedAddresses: () => wrapCb(window.cardano.godot.callbacks.get_unused_addresses),
+			signData: (address, message) => wrapSignCb(
+				window.cardano.godot.callbacks.sign_data,
+				address,
+				message
+			),
+		}
+
+	function wrapCb(cb) {
+			let { promise, resolve, reject } = Promise.withResolvers();
+			cb(resolve);
+			return promise;
+		}
+
+	function wrapSignCb(cb, address, message) {
+			let { promise, resolve, reject } = Promise.withResolvers();
+			cb(resolve, reject, address, message);
+			return promise;
+		}
+	
+	initCip30Godot();
+		
+	""")

addons/@mlabs-haskell/cip-30-callbacks/cip_30_wallet_api.gd

@@ -0,0 +1,27 @@
+extends RefCounted
+class_name Cip30WalletApi
+
+## Virtual class for implementing a CIP-30 compatible wallet
+##
+## This class represents a CIP-30 compatible wallet. Inherit it and override
+## all of its methods to obtain a CIP-30 wallet that may be used to initialize
+## a [Cip30Callbacks] object (check [method Cip30Callbacks._init]).
+
+## [b]WARNING: Virtual function.[/b][br]
+## Return the address of the wallet as a [String].
+func get_address() -> String:
+		assert(false, "Not implemented: get_address()")
+		return ""
+
+## [b]WARNING: Virtual function.[/b][br]
+## Check whether [param address] is owned by the wallet or not.
+func owns_address(address: String) -> bool:
+	assert(false, "Not implemented: owns_address()")
+	return false
+
+## [b]WARNING: Virtual function.[/b][br]
+## Sign a piece of [param hex_encoded_data] using the [param password].
+func sign_data(password: String, hex_encoded_data: String) -> JavaScriptObject:
+	assert(false, "Not implemented: sign_data()")
+	return JavaScriptBridge.create_object("Object")
+

addons/@mlabs-haskell/godot-cardano/bin/libcsl_godot.gdextension

@@ -21,3 +21,5 @@ android.debug.x86_64 = "res://addons/@mlabs-haskell/godot-cardano/bin/libcsl_god
 android.release.x86_64 = "res://addons/@mlabs-haskell/godot-cardano/bin/libcsl_godot.android.template_release.x86_64.so"
 android.debug.arm64 = "res://addons/@mlabs-haskell/godot-cardano/bin/libcsl_godot.android.template_debug.arm64.so"
 android.release.arm64 = "res://addons/@mlabs-haskell/godot-cardano/bin/libcsl_godot.android.template_release.arm64.so"
+web.debug.wasm32 = "res://addons/@mlabs-haskell/godot-cardano/bin/csl_godot.wasm"
+web.release.wasm32 = "res://addons/@mlabs-haskell/godot-cardano/bin/csl_godot.wasm"

addons/@mlabs-haskell/godot-cardano/src/abstract.gd

@@ -1,12 +1,12 @@
 class_name Abstract
+extends RefCounted
+
 ## Used for representing abstract classes
 ##
 ## Used to represent abstract classes which should never be instantiated. 
 ## Concrete classes inheriting from this class should always override
 ## [method Abstract._init].
 
-extends RefCounted
-
 ## [b]WARNING: Do not use without overriding![/b].
 func _init() -> void:
 	var abstract_name: String = get("_abstract_name")

addons/@mlabs-haskell/godot-cardano/src/address/address.gd

@@ -1,11 +1,11 @@
 extends RefCounted
+class_name Address
+
 ## A Cardano address
 ##
 ## This class represents a Cardano address consisting of a payment [Credential]
 ## and a (optional) staking [Credential].
 
-class_name Address
-
 var _address: _Address
 
 enum Status { SUCCESS = 0, BECH32_ERROR = 1 }
@@ -47,6 +47,9 @@ func to_bech32() -> String:
 		_:
 			push_error("An error was found while encoding an address as bech32", result.error)
 			return ""
+			
+func to_hex() -> String:
+	return _address._to_hex()
 
 func _to_string() -> String:
 	return to_bech32()

addons/@mlabs-haskell/godot-cardano/src/address/credential.gd

@@ -1,8 +1,8 @@
 extends RefCounted
-## A Cardano credential
-
 class_name Credential
 
+## A Cardano credential
+
 var _credential: _Credential = null
 
 enum CredentialType {

addons/@mlabs-haskell/godot-cardano/src/address/pub_key_hash.gd

@@ -1,8 +1,8 @@
 extends RefCounted
-## A public key hash
-
 class_name PubKeyHash
 
+## A public key hash
+
 var _pub_key_hash: _PubKeyHash
 
 enum Status { SUCCESS = 0, FROM_HEX_ERROR = 1 }

addons/@mlabs-haskell/godot-cardano/src/address/script_hash.gd

@@ -1,5 +1,4 @@
 extends RefCounted
-
 class_name ScriptHash
 
 var _script_hash: _ScriptHash