gear-tech / gear-program Goto Github PK

Problem to Solve

complete the docs for crates.io

Possible Solution

• write more docs
• inject README.md into lib.rs automatically

Notes

No response

Problem to Solve

When I try to run gear program from different process for a same node and in the same time, then I often get this error:

thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: SubxtBasic(Rpc(Call(Custom(ErrorObject { code: ServerError(1014), message: "Priority is too low: (242 vs 242)", data: Some(RawValue("The transaction has too low priority to replace another transaction already in the pool.")) }))))',

Possible Solution

_

Notes

No response

Problem to Solve

At the moment credentials are stored in a plain (text) file, check src/cmd/login.rs#L7-L23 . I would like to suggest to use specialized vault for such data.

Possible Solution

Some links for further investigations:

• MacOS keychain
• Windows Credential manager
• Linux keyring

Notes

No response

Problem to Solve

Expected status:

$ gear load <json-file>
loggined as xxx

Possible Solution

https://github.com/polkadot-js/common/blob/2d4509c32ab1bcddb85c2db16c8d40d03e85aae5/packages/util-crypto/src/json/decryptData.ts#L12

https://github.com/polkadot-js/common/blob/3597a4eb4e0cf9985104568058c5cd23701bbaed/packages/keyring/src/keyring.ts#L164

Notes

No response

Problem to Solve

Supports all extrinsics of pallet-gear https://github.com/gear-tech/gear/blob/12a0a165e8f6c36383c701c885d4d12a3cec467a/pallets/gear/src/lib.rs#L401

• send_message
• send_reply
• submit_code
• claim_value_from_mailbox

Possible Solution

add these calls in crate::api::calls, mb renaming callls to extrinsics

• add flag --code to command deploy, if --code, only accept wasm file
• add command send with flag reply
• add command claim

Notes

No response

Problem to Solve

similar to #2

Possible Solution

submit the submit_program and listen to events, exit after program initialized

Notes

No response

I think we also need to declare the params { endpoint, passwd } outside of specfied commands, make them global arugments, these two params are shared for most of the commands indeed.

Originally posted by @clearloop in #8 (comment)

Problem to Solve

It is really hard to write examples for each command in README, we can show them in the examples folder

Possible Solution

The integraion tests for commands under tests/cmd/*.rs already can treat as examples, what we need to do is copying the main logic to examples/*.rs

Notes

No response

File Location(s)

https://github.com/gear-tech/gear-program/blob/master/src/api/mod.rs

Proposal

Big changes in this version, Events hardly can be decoded as what we are dealing with now, considering waiting for 0.24.0

Problem to Solve

Compiling the code taking too much time, let's go with docker

Possible Solution

Use docker to run the integration tests

Notes

No response

but some functions/events only work on the matched spec_version, if we align to the lastest version of gear-node, this program may not work for the gear testnet

We are to keep the API/runtime part up to date and detect incompatibility with the node at early stages (another task to CI I guess, maybe some nighly job that compares actual API with the generated.rs).

Ideally, every new feature should be accompanied by the corresponding test/example.

Originally posted by @shamilsan in #6 (comment)

Problem to Solve

the logs of gear-program are all raw stdout for now

Possible Solution

mb we need to use log or color-eyre, log for custom logs, color-eyre for error outputs

• replace the events' outputs
• replace the cmmand outputs
• replace the tx status' outputs

Notes

No response

Problem to Solve

We have several restrictions on our extrinsics: for example, we deny ability to send more gas than maximal block gas limit, we deny ability to deploy different programs under the same program/actor id. Some things can be caught for free locally, avoiding wasting money and time for extrinsic fail.

Possible Solution

• Validate salt on program upload
• Validate binary code on upload
• Validate destination ID on send
• Validate value
• Validate gas limit
• Validate mailbox on reply/claim

But I'd recommend adding some smoke tests to CI against the latest node running in the dev node (it can be downloaded here: https://github.com/gear-tech/gear/releases/download/build/gear-node).

We run the node in a detached mode for such kind of purpose: https://github.com/gear-tech/gear/blob/master/scripts/src/test.sh#L98

Originally posted by @shamilsan in #6 (review)

File Location(s)

No response

Proposal

We can not build docs on docs.rs with the current build script since it requires write access to the file system

Problem

gear will not exit when error occurs since there is another process waiting for events, and the two process are combined with one join!

Steps

Possible Solution

exit on errors

Notes

No response

Relevant Log Output

<Paste your log here>

Problem to Solve

Most of the commands were written before the implementation of the integration tests utils, now we need to complete them

Possible Solution

Add integration tests for the commands below

• claim
• reply
• send
• submit
• transfer

Notes

No response

Problem to Solve

the api in gp is built with subxt-0.22.0, we need subxt-cli-0.22.0 to generate the apis

Possible Solution

add more checks in generate-api.sh

Notes

No response

Problem to Solve

Need to add docs for how to use the scirpts in developing, for example update the api

Possible Solution

add a new chapter dev in README

Notes

No response

Problem to Solve

Usage:

gear meta `*.meta.wasm`

Possible Solution

https://github.com/gear-tech/gear-js/tree/master/utils/meta-cli

Notes

No response

File Location(s)

No response

Proposal

https://docs.rs/subxt/0.22.0/subxt/rpc/struct.RpcClientBuilder.html#method.request_timeout

Problem to Solve

enhance the log output after executing extrinsics

Possible Solution

show the balances status after submiting extrinsics

Notes

No response

Problem to Solve

This project is outdated in crates.io

Possible Solution

Trigger cargo publish on merging master

Notes

No response

Problem to Solve

The code under the builder should not be embedded inside the main crate since user will never use it

Possible Solution

Create a new crate for it

Notes

No response

What about submit_program?

I'm okay with both, one concern is each of the commands is a single word for now. ( deploy for submit_program, submit for submit_code )

I've already offered renaming: submit_code -> upload_code, submit_program -> create_program, so it will be single-word some time soon

I'd add only submit program at the moment

Originally posted by @breathx in #13 (comment)

Problem to Solve

Allow users transfering balance via binary gear

Possible Solution

add command transfer

Notes

No response

Problem to Solve

This is useful for integration tests and debugging.

• Add a interface parsing meta.wasm to rust structure
• Add command read

Possible Solution

https://github.com/gear-tech/gear-js/blob/0045753ccbc43ca15dd9254355a4b121ffa8cdbd/api/src/wasm/WasmMeta.ts#L5

Notes

No response

Problem

can not login if there is no .gear

Steps

Possible Solution

recheck the mkdir code for this

Notes

No response

Relevant Log Output

<Paste your log here>

Problem to Solve

Add command printing the mailbox's content of address

Possible Solution

we already have

Notes

No response

File Location(s)

https://github.com/gear-tech/gear-program/tree/master/src/cmd

Proposal

Since we have requirements for using this project for writing tests, we can trim the cmd folder if users just want to use the library of this project

[features]
default = [ "cmd" ]
cmd = []
node-key = []

for using this library

gear-program = { version = "0.1.2", default-featulres = false }

Problem to Solve

here we need to exit the process after MessageDispatched, show the succeed or the failure log

Possible Solution

send / reply message and listen to the event, exit process after MessageDispatched

Notes

No response

Problem to Solve

needs to refactor the template apps registry since we don't maintain gear-tech/apps anymore

Possible Solution

write each of the git repo of gear program templates into static array and just clone them.

Notes

No response

File Location(s)

https://github.com/gear-tech/gear-program/blob/master/src/api/mod.rs#L26

Proposal

we are currently binding the Signer with Api, which makes it unavaiable to call runtime apis without a signer.

1. create a new Signer type
2. pass the Signer to the api Client when it is needed

It is really overhead to decode non-exists structure from bytes and output them in rust, as a solution for reading state, I'll just create a new wasm project with the type registry providing functions like encode_input and decode_output

Originally posted by @clearloop in #32 (comment)

Once we decoded the PortableRegistry from meta_registry, we can generate rust types from it into a new wasm project, which provides

extern "C" fn encode_$type() {
   hex::encode(...)
}

extern "C" fn encode_$type() {
   serde_json::from_str(...)
}

to do the encoding/decoding stuffs

The best solution I can figure out is do it in wasm, which can solve this problem dynamically, we also need to cache "*.meta.wasm" and the generated wasm project uner ~/.gear for re-using purposes.

Problem to Solve

Update this repo when gear-tech/gear updates.

Possible Solution

https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule

• run the checking per day
• if spec_version changed, run scripts/generate-api.sh and check if the project can be compiled,
  • if it can be compiled, commit the changes to master and publish a new version

Notes

No response

Problem to Solve

instroduce sign && verify ability in gear-program

Possible Solution

The command would be like

gear key

sign <pk> <msg> —scheme <SCHEME>
verify <msg> <pk> —scheme <SCHEME>
/// list all avaible keys
list <keystore-path>
/// inspect from private key bytes, only get public from it momentary
inspect <pk-bytes> —scheme <SCHEME>

Notes

@EugenWay, @shamilsan feel free to comment on this