Merge remote-tracking branch 'origin/development' into check_source_sfx

Author: MaciejBaj

client/cli/.gitignore

@@ -0,0 +1 @@
+node_modules

client/cli/README.md

@@ -0,0 +1,35 @@
+## t3rn CLI
+A simple CLI tool for interacting with the t3rn circuit.
+
+### Setup:
+Before interacting with the t3rn circuit, we need to configure a couple of things. The is done in `config/setup.ts`. 
+
+#### Circuit Section:
+Here we simply specify the circuit WS endpoint we want to interact with
+```
+circuit: {
+ rpc: "ws://127.0.0.1:9944",
+},
+```
+
+#### Gateway Section:
+Here we specify the different parameters that describe a gateway. This is important for registrations, but also for handling decimal points, address formats etc. in other transactions
+
+The `transferData` section must also be noted. Here we can specify default values for the transfer command. Currently, fee and receiver can be specified.
+
+
+### Supported Transactions:
+A list of the supported transactions.
+
+#### Register Gateway:
+Currently, the registration for relaychains is only supported. The registration can be executed by running: `ts-node index.ts register roco`. Note that `roco` matches the gatewayId as specified in the configs.
+
+#### setOperational:
+to use a newly registered gateway, it must be set operations. This can be done with: `ts-node index.ts setOperational roco true`
+
+#### Transfer:
+A simple transfer, currently only supporting nativ substrate assets. 
+
+`ts-node index.ts transfer roco 0.1 receiver (optinal) fee (optional)`
+
+If the optional parameters are omitted, the default values specified in the config will be used. 

client/cli/commands/operational.ts

@@ -0,0 +1,14 @@
+import{ ApiPromise, Keyring, WsProvider } from'@polkadot/api';
+
+export const setOperational = async (circuit: ApiPromise, gatewayData: any, argument: boolean) => {
+ switch(gatewayData.registrationData.gatewayVendor) {
+ case "Substrate": {
+ return circuit.tx.multiFinalityVerifierDefault.setOperational(argument, gatewayData.id)
+ break;
+ }
+ default: {
+ console.log(`SetOperational not available for Vendor ${gatewayData.registrationData.gatewayVendor}`)
+ return
+ }
+ }
+}

client/cli/commands/register/register.ts

@@ -0,0 +1,13 @@
+import { registerSubstrate } from "./substrate";
+
+export const register = async (circuitApi: any, gatewayData: any) => {
+ switch(gatewayData.registrationData.gatewayVendor) {
+ case "Substrate": {
+ return registerSubstrate(circuitApi, gatewayData)
+ }
+ default: {
+ console.log(`Registration not available for Vendor ${gatewayData.registrationData.gatewayVendor}`)
+ return
+ }
+ }
+}

client/cli/commands/register/substrate.ts

@@ -0,0 +1,110 @@
+import{ ApiPromise, Keyring, WsProvider } from'@polkadot/api';
+import { extractAuthoritySetFromFinalityProof } from "../../utils/decoder";
+
+const axios = require('axios').default;
+
+export const registerSubstrate = async (circuit: ApiPromise, gatewayData: any) => {
+ const target = await ApiPromise.create({
+ provider: new WsProvider(gatewayData.rpc),
+ })
+
+ if(gatewayData.registrationData.relaychain === null) { // relaychain
+ return registerRelaychain(circuit, target, gatewayData)
+ } else {
+ console.log("Not implemented!")
+ return
+ // registerParachain(target, gatewayData)
+ }
+}
+
+const registerRelaychain = async (circuit: ApiPromise, target: ApiPromise, gatewayData: any) => {
+ const abiConfig = createAbiConfig(circuit, gatewayData.registrationData.gatewayConfig)
+ const gatewayGenesis = createGatewayGenesis(circuit, target);
+ const gatewaySysProps = createGatewaySysProps(circuit, gatewayData.registrationData.gatewaySysProps)
+ const { registrationHeader, authorities, authoritySetId } = await fetchConsensusData(circuit, target, gatewayData)
+ const allowedSideEffects = circuit.createType('Vec<AllowedSideEffect>', gatewayData.registrationData.allowedSideEffects)
+ return circuit.tx.circuitPortal.registerGateway(
+ gatewayData.rpc,
+ gatewayData.id,
+ null,
+ abiConfig,
+ circuit.createType('GatewayVendor', 'Substrate'),
+ circuit.createType('GatewayType', { ProgrammableExternal: 1 }),
+ gatewayGenesis,
+ gatewaySysProps,
+ registrationHeader,
+ authorities,
+ authoritySetId,
+ allowedSideEffects
+ );
+}
+
+const createGatewayGenesis = async (circuit: ApiPromise, target: ApiPromise) => {
+ const [metadata, genesisHash] = await Promise.all([
+ await target.runtimeMetadata,
+ await target.genesisHash,
+ ]);
+ return circuit.createType('GatewayGenesisConfig', [
+ circuit.createType('Option<Bytes>', metadata.asV14.pallets.toHex()),
+ metadata.asV14.extrinsic.version,
+ genesisHash,
+ ]);
+}
+
+const createAbiConfig = (circuiApi: ApiPromise, gatewayConfig: any) => {
+ return circuiApi.createType('GatewayABIConfig', [
+ circuiApi.createType('u16', gatewayConfig.blockNumberTypeSize),
+ circuiApi.createType('u16', gatewayConfig.hashSize),
+ circuiApi.createType('HasherAlgo', gatewayConfig.hasher),
+ circuiApi.createType('CryptoAlgo', gatewayConfig.crypto),
+ circuiApi.createType('u16', gatewayConfig.addressLength),
+ circuiApi.createType('u16', gatewayConfig.valueTypeSize),
+ circuiApi.createType('u16', gatewayConfig.decimals),
+ circuiApi.createType('Vec<StructDecl>', gatewayConfig.structs),
+ ]);
+}
+
+const createGatewaySysProps = (circuiApi: ApiPromise, gatewaySysProps: any) => {
+ return circuiApi.createType('GatewaySysProps', [
+ circuiApi.createType('u16', gatewaySysProps.ss58Format),
+ circuiApi.createType('Vec<u8>', gatewaySysProps.tokenSymbol),
+ circuiApi.createType('u8', gatewaySysProps.tokenDecimals),
+ ]);
+}
+
+const fetchConsensusData = async (circuit: ApiPromise, target: ApiPromise, gatewayData: any) => {
+ const registrationHeight = await fetchLatestAuthoritySetUpdateBlock(gatewayData)
+ console.log("Latest AuthoritySetUpdate:", registrationHeight)
+
+ const registrationHeader = await target.rpc.chain.getHeader(
+ await target.rpc.chain.getBlockHash(registrationHeight)
+ )
+
+ const finalityProof = await target.rpc.grandpa.proveFinality(registrationHeight);
+ const authorities= extractAuthoritySetFromFinalityProof(finalityProof)
+ const authoritySetId = await target.query.grandpa.currentSetId()
+ return {
+ registrationHeader: circuit.createType('Bytes', registrationHeader.toHex()),
+ authorities: circuit.createType('Option<Vec<AccountId>>', authorities),
+ authoritySetId: circuit.createType('Option<SetId>', authoritySetId),
+ }
+}
+
+//for registrations we want to get the justification cotaining the latest authoritySetUpdate, as we can be sure that all authorties are included.
+const fetchLatestAuthoritySetUpdateBlock = async (gatewayData: any) => {
+ return axios.post(gatewayData.subscan + '/api/scan/events', {
+ row: 1,
+ page: 1,
+ module: "grandpa",
+ call: "newauthorities"
+ },
+ {
+ headers: {
+ 'content-type': 'text/json'
+ }
+ }
+ )
+ .then(function (response) {
+ return response.data.data.events.map(entry => entry.block_num)[0]
+ })
+}

client/cli/commands/transfer.ts

@@ -0,0 +1,39 @@
+import { transferAmount } from "../utils/encoder";
+import{ ApiPromise, Keyring, WsProvider }from'@polkadot/api';
+
+export const transfer = async (circuit: ApiPromise, gatewayData: any, amount: number, sender: string, receiver: string, fee: number) => {
+ const keyring = new Keyring({ type: "sr25519" })
+ const signer =
+ process.env.CIRCUIT_KEY === undefined
+ ? keyring.addFromUri("//Alice")
+ : keyring.addFromMnemonic(process.env.CIRCUIT_KEY)
+ return new Promise((res, rej) => {
+ circuit.tx.circuit
+ .onExtrinsicTrigger(
+ [
+ {
+ target: gatewayData.id,
+ prize: 0,
+ ordered_at: 0,
+ encoded_action: [116, 114, 97, 110], //tran
+ encoded_args: [sender, receiver, amount],
+ signature: null,
+ enforce_executioner: null,
+ }
+ ],
+ fee,
+ false
+ )
+ .signAndSend(signer, async result => {
+ // @ts-ignore
+ if (result && result.toHuman().dispatchError !== undefined) { // The pallet doesn't return a proper error
+ // @ts-ignore
+ rej(result.toHuman().dispatchError)
+ } else if (result.isInBlock) {
+ res(true)
+ }
+ })
+ })
+
+
+}

client/cli/config/rpc.json

@@ -0,0 +1,47 @@
+{
+ "circuitPortal": {
+ "readLatestGatewayHeight": {
+ "description": "Returns the gateways height knows by circuit",
+ "params": [
+ {
+ "name": "chain_id",
+ "type": "[u8; 4]"
+ },
+ {
+ "name": "at",
+ "type": "Hash",
+ "isOptional": true
+ }
+ ],
+ "type": "ReadLatestGatewayHeight"
+ }
+ },
+ "xdns": {
+ "fetchRecords": {
+ "description": "Fetches all available XDNS Records on Circuit",
+ "params": [
+ {
+ "name": "at",
+ "type": "Hash",
+ "isOptional": true
+ }
+ ],
+ "type": "FetchXdnsRecordsResponse"
+ },
+ "fetchAbi": {
+ "description": "Fetches abi of a specific gateway",
+ "params": [
+ {
+ "name": "chain_id",
+ "type": "ChainId"
+ },
+ {
+ "name": "at",
+ "type": "Hash",
+ "isOptional": true
+ }
+ ],
+ "type": "GatewayABIConfig"
+ }
+ }
+}

client/cli/config/setup.ts

@@ -0,0 +1,38 @@
+export default {
+ circuit: {
+ rpc: "ws://127.0.0.1:9944",
+ },
+ gateways: [
+ {
+ name: "Rococo",
+ id: "roco",
+ rpc: "wss://rococo-rpc.polkadot.io",
+ subscan: "https://rococo.api.subscan.io",
+ transferData: {
+ receiver: "5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty",
+ fee: 0,
+ },
+ registrationData: {
+ relaychain: null,
+ gatewayConfig: {
+ blockNumberTypeSize: 32,
+ hashSize: 32,
+ hasher: "Blake2",
+ crypto: "sr25519",
+ addressLength: 32,
+ valueTypeSize: 8,
+ decimals: 12,
+ structs: []
+ },
+ gatewayVendor: "Substrate",
+ gatewayType: { ProgrammableExternal: 1 },
+ gatewaySysProps: {
+ tokenSymbol: "ROC",
+ tokenDecimals: 12,
+ ss58Format: 60
+ },
+ allowedSideEffects: ["tran"]
+ }
+ }
+ ]
+}