Keyless Extension Framework

Key	Required	Type	Description
name	yes	string	The name of the plugin
version	yes	Keyless Extension Framework	A version identifier for your code.
platformVersion	yes	Keyless Extension Framework	A version identifier for the Keyless execution environment.
accounts	no	Keyless Extension Framework	List of web3 accounts that can be made into signers
actions	no	Keyless Extension Framework	List of actions supported by this extension. Can be a create, get, delete or custom action over a particular resource
events	no	Keyless Extension Framework	List of events this extension produce. Events include filters and therefore can be made into triggers for a workflow or specific actions
hydrators	no	Keyless Extension Framework	Hydrators are ways to get data external into your app, e.g for searches and lists
authentication	no	Keyless Extension Framework	Choose what scheme your API uses for authentication.
agents	no	Agent Schema	Specify agent configuration

• Type - object

• Type - object

• Type - object

Key	Required	Type	Description
name	no	string	name of the scheme. Defaults to accounts[i] where i is the index of the account in the accounts list
type	yes	string in ('basic', 'custom', 'digest', 'oauth1', 'oauth2', 'session')	Choose which scheme you want to use.
test	yes	oneOf(Keyless Extension Framework, Keyless Extension Framework)	A function or request that confirms the authentication is working.
fields	no	Keyless Extension Framework	Fields you can request from the user before they connect your app to Keyless.

• Type - object

Key	Required	Type	Description
^[a-zA-Z]+[a-zA-Z0-9_]*$	no	Keyless Extension Framework	Any unique key can be used and its values will be validated against the Keyless Extension Framework .

yaml
actions:
	createItem:
		display:
			label: "Create Item"
			description: "Creates a new item"
		handler: 
			actor:
				require: "./path/to/file.js"
				
		
							

• Type - object

Key	Required	Type	Description
key	yes	string	A key to uniquely identify this action
inputs	no	Keyless Extension Framework	What should the form a user sees and configures look like?
outputs	no	Keyless Extension Framework	What fields of data will this return?
display	yes	Keyless Extension Framework	Configures the UI for this action.
handler	yes	Keyless Extension Framework	Powers the functionality for this action
use_account	no	array [ string ]	if to give this action access to accounts
use_auth	no	boolean	if this action can requires authentication

• Type - object

• Type - object

Key	Required	Type	Description
input	no	Keyless Extension Framework	What should the form a user sees and configures look like?
output	no	Keyless Extension Framework	What fields of data will this return?
type	yes	string in “function” | “contract” | “http”	type of handler
actor	yes	oneOf(Keyless Extension Framework, Keyless Extension Framework, Keyless Extension Framework )	The function / endpoint the keyless execution engine will call when a workflow makes use of this action
concurrent	no	boolean	if this action can be invoked concurrently or a lock should should be applied

• Type - array[oneOf(Keyless Extension Framework, Keyless Extension Framework )]

yaml
DynamicFieldsSchema:
	- key: "Field1"
		label: "Field1"
	- require: "./some/path/to/file.js"

• Type - array[Keyless Extension Framework ]

• Type - object

Key	Required	Type	Description
key	yes	string	A key to uniquely identify this event
matcher	no	string	a dot notation expression conveying which key of the input data object should be used as an identifier to match the event key.
input	no	Keyless Extension Framework	What values are gonna be sent with
display	yes	Keyless Extension Framework	Configures the UI for this action.
handler	yes	Keyless Extension Framework	what should happen when there’s a new event
filter	no	string	an expression to filter out certain events based on specific conditions
subscribe	no	oneOf(Keyless Extension Framework, Keyless Extension Framework)	a call to subscribe to the web-hook event with this key
unsubscribe	no	oneOf(Keyless Extension Framework, Keyless Extension Framework)	a call to unsubscribe from the web-hook event with this key
ㅤ	ㅤ	ㅤ	ㅤ

yaml
Events:
	key: NewDeposit
	matcher: "handler.input.data.eventType"
	display:
		label: "New Deposit Event"
		description: "This webhook event is produced whenever there's a new deposit"
	filter: "input.data.address == handler.input.data.fromAddress"
	subscribe:
		require: "./path/to/subscribe.js"
	unsubscribe:
		require: "./path/to/unsubscribe.js"
	handler:
		actor:
			require: "./path/to/actor.js"
		concurrent: false # or user can implement some distributed locking mechanism to avoid processing a single event multiple times
		
	

• Type - array[Keyless Extension Framework ]

yaml
Hydrators:
	- key: getAllWallets
		actor:
			require: "./path/to/actor.js"
	- key: getAllVaults
		actor:
			require: "./path/to/other/actor.js"

• Type - object

Key	Required	Type	Description
method	no	string in ('GET', 'PUT', 'POST', 'PATCH', 'DELETE', 'HEAD')	The HTTP method for the request.
url	yes	string	A URL for the request (we will parse the querystring and merge with params). Keys and values will not be re-encoded.
body	no	oneOf(null, string, object, array)	Can be nothing, a raw string or JSON (object or array).
params	no	Keyless Extension Framework	A mapping of the query string - will get merged with any query params in the URL. Keys and values will be encoded.
headers	no	Keyless Extension Framework	The HTTP headers for the request.
auth	no	oneOf(array[string],Keyless Extension Framework )	An object holding the auth parameters for OAuth1 request signing, like {oauth_token: 'abcd', oauth_token_secret: '1234'}. Or an array reserved (i.e. not implemented yet) to hold the username and password for Basic Auth. Like ['AzureDiamond', 'hunter2'].

yaml
RequestSchema:
	method: "GET"
	url: "https://ext.withkeyless.com"
	params:
		a: 1
		b: 2
	
# OR 
	
RequestSchema:
	method: "POST"
	url: "https://ext.withkeyless.com"
	body:
		key1: 1
		key2: 2
	headers:
		header1: "some-value"

• Type - object

Key	Required	Type	Description
funcId	yes	string in $namespace.funcId	a unique id of a function to call along side the namespace
args	no	Keyless Extension Framework	Inputs to be passed to the function call
deamon	no	boolean	defines if to treat this function as a deamon or call and wait for response. Useful for long running tasks

yaml
key: "$getItemsById"

• Type - object

Key	Required	Type	Description
contractAddress	yes	`string`	address of the contract to call
method	yes	string	the contract method to invoke
args	no	Keyless Extension Framework	arguments to this contract method call
value	no	number	the value to send along with the contract call
from	no	string	the caller of this contract
gasLimit	no	number	the gas Limit to use for this contract call
gasPrice	no	number
maxFeePerGas	no	number
maxPriorityFeePerGas	no	number
nonce	no	number
type	no	number
accessList	no	array [Keyless Extension Framework] | Keyless Extension Framework
customData	no	Keyless Extension Framework
ccipReadEnabled	no	boolean	This specifies if the CCIP read is enabled.

yaml
callContract:
	contractAddress: "0x..98"
	method: "transfer"
	args: 
		amount: 10
		to: "0x.."

• Type - object

yaml
FlatObjectSchema:
	string_value_key: "1"
	number_value_key: 2
	decimal_value_key: 3.3
	bool_value_key: false
	"some_string_key": "value"  

• Type - array[Keyless Extension Framework ]

yaml
FieldsSchema:
	- key: "Field1"
		label: "Field1"
	- key: "Field2"
		label: "Field2"

• children & type

• children & placeholder

• children & helpText

• Type - object

Key	Required	Type	Description
key	yes	string	A unique machine readable key for this value (IE: "fname").
label	no	string	A human readable label for this value (IE: "First Name").
helpText	no	string	A human readable description of this value (IE: "The first part of a full name."). You can use Markdown.
type	no	string in ('string', 'text', 'integer', 'number', 'boolean', 'datetime', 'file', 'password', 'copy', 'code')	The type of this value. Use string for basic text input, text for a large, <textarea> style box, and code for a <textarea> with a fixed-width font. Field type of file will accept either a file object or a string. If a URL is provided in the string, Keyless will automatically make a GET for that file. Otherwise, a .txt file will be generated.
required	no	boolean	If this value is required or not.
placeholder	no	string	An example value that is not saved.
choices	no	Keyless Extension Framework	An object of machine keys and human values to populate a static dropdown.
search	no	Keyless Extension Framework	A reference to an hydrator that returns a list of items that can be used to power a dynamic search dropdown.
children	no	array [Keyless Extension Framework]	An array of child fields that define the structure of a sub-object for this field. Usually used for line items.
default	no	string	A default value.
dynamic	no	Keyless Extension Framework	A reference to an hydrator that returns a list of items that can be used to power a dynamic search dropdown.

yaml
FieldSchema:
	key: "Field1"
	label: "Field1"

A object containing a reference to an hydrator and keys to map the hydrator data into a Keyless Extension Framework

Key	Required	Type	Description
hydrator	yes	Keyless Extension Framework	an hydrator that provides data for this dynamic input. Must be an hydrator that returns and array of object
label_key	yes	string	the key to use as the choice label key
value_key	yes	string	the key to use as the choice label value

Key	Required	Type	Description
key	yes	Keyless Extension Framework	a reference to a unique hydrator key
inputs	no	Keyless Extension Framework	inputs to the hydrator
filter	no	boolean	if hydrator supports filtering

• Type - oneOf(object, array[oneOf(string, Keyless Extension Framework )])

yaml
FieldChoicesSchema:
	a: '1'
	b: '2'
	c: '3'
		
# OR

FieldChoicesSchema:
	- "first"
	- "second"
	- "third"

• Type - object

yaml
FieldChoiceWithLabelSchema:
	label: "some_label"
	value: "some_value"

A Keyless Extension Framework or Keyless Extension Framework that can be used to get data or list of data into the app.

• Type - object

Key	Required	Type	Description
key	yes	string	A unique identifier of this hydrator
actor	yes	oneOf(Keyless Extension Framework, Keyless Extension Framework)	The function / endpoint the keyless execution engine will call to get the required data
filter	no	boolean	if this is enabled, keyless will leave filtering items to the hydrator by passing a search value to it. otherwise, keyless will get all item and perform filtering from the UI. This can be useful in case of large lists where prefetching all items and filtering through from the UI may be sub-optimal
inputs	no	Keyless Extension Framework	inputs to this hydrator

• Type - string

• Pattern - ^[a-zA-Z0-9_]+\.[a-zA-Z0-9_\s\[\]]+(\.[a-zA-Z0-9_\s\[\]]+(,[a-zA-Z0-9_\s\[\]]+)*)?$

• 'hydrators.getListOfWallets'

• Type - string

• Pattern - ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$

• '1.0.0'

• '2.11.3'

• '999.999.999'

• '1.0.0.0' - Must have only 2 periods

• '1000.0.0' - Each number can be a maximum of 3 digits

• 'v1.0.0' - No letters allowed

• '1.0.0-beta' - undefined

yaml
# Meta
name: "Transaction Sender"
version: 1.0.0
platformVersion: 1.0.0

# Authentication
accounts:
  - name: mainAccount

authentication:
	- name: bitpowr
    type: api
    fields: 
      - key: apiKey
        label: "Bitpowr API Key"
        required: true
        type: string


# Actions
actions:
  signMessageWithPrivateKey:
    inputs: 
      - key: messageToSign
        label: "Message to sign"
        helpText: "Please provide the message you want to sign here"
        type: string
        required: true
        placeholder: "Message To Sign"
      - key: includeTimestamp
        label: "Include timestamp"
        helpText: "If to include timestamp in the signature. Can be useful to restrict the duration of validity of the signed message"
        choices:
          - "Yes"
          - "No"
        default: "No"
    display:
      label: "Sign Message With Private Key"
      description: "Sign a message with a provided key" 
    handler:
      type: function
      actor:
	      funcId: "$namespace.sign"
    outputs:
      - key: signedMessage
        label: "Signed Message"
        type: string
        required: true
        default: ""


  createWallet:
	  use_auth: true
    inputs:
      - key: accountId
        label: "Account ID"
        type: string
        required: true
        dynamic:
          hydrator: getAccounts
          label_key: name
          label_value: accountId

      - key: asset
        label: "Asset Type"
        type: string
        required: true
        dynamic: 
          hydrator: 
            key: getAssetList
            inputs:
              - key: accountId
                value: ${{inputs.accountId}}
          label_key: name
          label_value: assetId

      - key: label
        label: "Label"
        type: string
        placeholder: "My Main Wallet"
    
    display:
      label: "Create Wallet"
      description: "Create a new wallet"

    handler:
      type: function
      actor:
	      funcId: "$namespace.createWallet"
        
	transfer:
		use_account:
			- name: mainAccount
    inputs:
      - key: amount
        label: "Amount"
        type: number
        required: true

      - key: toAddress
        label: "To Address"
        type: string
        required: true
        
    display:
      label: "Transfer USDT"
      description: "Transfer usdt"

    handler:
	    type: contract
	    actor:
	      contractAddress: "0x..98"
				method: "transfer"
				args: 
					amount: 10
					to: "0x.."

# Events
events:
  key: NewWallet
  matcher: "eventType"
  display:
    label: "New Wallet"
    description: "This event is produced when a new wallet is created."
  filter: ${{ evt.payload.accountId == "7f350a1c-a0f4-4920-ab18-5a89c8b596ce" }}
  subscribe: 
    require: "./subscribe.js"
    deamon: true # this way we can subscribe to the event or just have a long polling logic in the subscribe function and run in the background
  unsubscribe:
    require: "./unsubscribe.js"

# Hydrators
hydrators:
  - key: getAccounts
    actor:
      require: "./get-accounts.js"
  - key: getAssetList
    inputs:
      - key: accountId
        type: string
        required: true
    actor:
	    type: http
	    config:
			  url: "https://api.bitpowr.com/assets"
	      method: GET
	      params:
	        page: 1
	        limit: 1000 # we wanna fetch all assets
	        accountId: ${{ input.accountId }}