Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Predev channels caching #517

Open
wants to merge 14 commits into
base: development
Choose a base branch
from
Open

Predev channels caching #517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3d6be71
Merge pull request #508 from singnet/development
kiruxaspb Jul 30, 2024
6de062c
Start of implementation of channel caching
Arondondon Oct 11, 2024
f036279
Implemented cache updating and loading to output channels info.
Arondondon Oct 14, 2024
53a28d7
Merge pull request #513 from singnet/development
sassless Oct 15, 2024
d63b166
Merge branch 'predev-channels-caching' into channels-caching
Arondondon Oct 15, 2024
14b6ce8
Merge pull request #515 from singnet/channels-caching
Arondondon Oct 15, 2024
bd00e33
Finished changes in "snet channel" section.
Arondondon Oct 16, 2024
d2db5f4
Changed "client call" command. Deleted unnecessary methods in mpe_cha…
Arondondon Oct 16, 2024
8541f4d
Fixed "print" commands in "channel" section.
Arondondon Oct 16, 2024
f694f6a
Removed deprecated functionality
Arondondon Oct 22, 2024
50a4b1d
Fixed "snet channel metadata-init-utility" command with wrong "encodi…
Arondondon Oct 23, 2024
2d4f47b
Updated README.md for building documentation
Arondondon Oct 24, 2024
9ca7975
Got rid of the "goerli" network in the default config.
Arondondon Oct 24, 2024
c2d04c3
Fixed contract names in "snet contract" command.
Arondondon Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,28 +127,49 @@ Backward compatibility for other Python versions is not guaranteed.
$ git clone https://github.com/singnet/snet-cli.git
$ cd snet-cli/packages/snet_cli
```

*

* Install the package in development/editable mode

```bash
$ pip3 install -e .
```

#### Building the Documentation
### Building the Documentation in Markdown files

* Clone repository and install dependencies

* Install sphinx, sphinx-argparse and the rtd theme
```bash
$ git clone https://github.com/singnet/snet-cli.git
$ cd snet-cli/packages/snet_cli
$ pip install sphinx
$ pip install sphinx-argparse
$ pip install sphinx-rtd-theme
```
$ pip install bs4
$ pip install html2text
```

#### On Linux

* Run the build-docs.sh in the docs directory

```bash
$ cd docs
$ sh build-docs.sh
```

The documentation is generated under the docs/build/html folder
#### On Windows

* Install `make` utility and run the build-docs.ps1 in the docs directory

```powershell
choco install make # install choco if it is not already installed
cd docs
powershell -file build-docs.ps1
```

The documentation is generated under the docs/build/markdown folder

### Release

Expand Down
152 changes: 46 additions & 106 deletions snet/cli/arguments.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,6 @@ def add_network_options(parser, config):
help="Name of network to create")
p.add_argument("eth_rpc_endpoint",
help="Ethereum rpc endpoint")
p.add_argument("--default-gas-price",
default="medium",
help="Default gas price (in wei) or gas price strategy ('fast' ~1min, 'medium' ~5min or 'slow' ~60min), default is 'medium'")
p.add_argument("--skip-check",
action="store_true",
help="Skip check that eth_rpc_endpoint is valid")
Expand Down Expand Up @@ -236,11 +233,12 @@ def add_contract_options(parser):

contracts = get_all_abi_contract_files()
for path in contracts:
contract_name = re.search(
r"([^.]*)\.json", os.path.basename(path)).group(1)
contract_p = subparsers.add_parser(
contract_name, help="{} contract".format(contract_name))
add_contract_function_options(contract_p, contract_name)
if "MultiPartyEscrow" in str(path) or "Registry" in str(path) or "SingularityNetToken" in str(path):
contract_name = re.search(
r"([^.]*)\.json", os.path.basename(path)).group(1)
contract_p = subparsers.add_parser(
contract_name, help="{} contract".format(contract_name))
add_contract_function_options(contract_p, contract_name)


def add_organization_arguments(parser):
Expand Down Expand Up @@ -675,53 +673,24 @@ def add_p_open_channel_basic(p):
p.add_argument("--open-new-anyway",
action="store_true",
help="Skip check that channel already exists and open new channel anyway")
add_p_from_block(p)


def add_p_from_block(p):
p.add_argument("--from-block",
type=int,
default=0,
help="Start searching from this block (for channel searching)")


def add_mpe_channel_options(parser):
parser.set_defaults(cmd=MPEChannelCommand)
subparsers = parser.add_subparsers(title="Commands", metavar="COMMAND")
subparsers.required = True

p = subparsers.add_parser("init",
help="Initialize channel taking org metadata from Registry")
p.set_defaults(fn="init_channel_from_registry")

add_p_org_id(p)
add_group_name(p)
add_p_registry_address_opt(p)
add_p_mpe_address_opt(p)
add_p_channel_id(p)

p = subparsers.add_parser("init-metadata",
help="Initialize channel using organization metadata")
p.set_defaults(fn="init_channel_from_metadata")
add_p_org_id(p)
add_group_name(p)
add_p_registry_address_opt(p)
add_p_organization_metadata_file_opt(p)
add_p_mpe_address_opt(p)
add_p_channel_id(p)
add_eth_call_arguments(p)

p = subparsers.add_parser("open-init",
help="Open and initialize channel using organization metadata from Registry")
p.set_defaults(fn="open_init_channel_from_registry")
p = subparsers.add_parser("open",
help="Open channel using organization metadata from Registry")
p.set_defaults(fn="open_channel_from_registry")

add_p_org_id(p)
add_p_registry_address_opt(p)
add_p_open_channel_basic(p)

p = subparsers.add_parser("open-init-metadata",
help="Open and initialize channel using organization metadata")
p.set_defaults(fn="open_init_channel_from_metadata")
p = subparsers.add_parser("open-from-metadata",
help="Open channel using existing organization metadata")
p.set_defaults(fn="open_channel_from_metadata")
add_p_org_id(p)
add_p_registry_address_opt(p)
add_p_open_channel_basic(p)
Expand All @@ -737,22 +706,20 @@ def add_p_set_for_extend_add(_p):
add_p_mpe_address_opt(p)
add_transaction_arguments(p)

p = subparsers.add_parser(
"extend-add", help="Set new expiration for the channel and add funds")
p = subparsers.add_parser("extend-add", help="Set new expiration for the channel and add funds")
p.set_defaults(fn="channel_extend_and_add_funds")
add_p_channel_id(p)
add_p_set_for_extend_add(p)

p = subparsers.add_parser("extend-add-for-org",
help="Set new expiration and add funds for the channel for the given service")
help="Set new expiration and add funds for the channel for the given service (organization and group name)")
p.set_defaults(fn="channel_extend_and_add_funds_for_org")
add_p_org_id(p)
add_group_name(p)
add_p_registry_address_opt(p)
add_p_set_for_extend_add(p)
add_p_group_name(p)
add_p_channel_id_opt(p)
add_p_from_block(p)

p = subparsers.add_parser("block-number",
help="Print the last ethereum block number")
Expand All @@ -761,89 +728,71 @@ def add_p_set_for_extend_add(_p):
def add_p_only_id(_p):
_p.add_argument("--only-id",
action='store_true',
help="Print only id of channels")

def add_p_only_sender_signer(_p):
pm = _p.add_mutually_exclusive_group(required=False)
pm.add_argument("--filter-sender",
action='store_true',
help="Print only channels in which current identity is sender")
pm.add_argument("--filter-signer",
action='store_true',
help="Print only channels in which current identity is signer")
pm.add_argument("--filter-my",
action='store_true',
help="Print only channels in which current identity is sender or signer")
help="Print only id of channels",
default=False)

def add_p_sender(_p):
_p.add_argument("--sender",
default=None,
help="Account to set as sender (by default we use the current identity)")

p = subparsers.add_parser("print-initialized",
help="Print initialized channels.")
p.set_defaults(fn="print_initialized_channels")
add_p_only_id(p)
add_p_only_sender_signer(p)
add_p_mpe_address_opt(p)
add_eth_call_arguments(p)
add_p_registry_address_opt(p)

p = subparsers.add_parser("print-initialized-filter-org",
help="Print initialized channels for the given org (all payment group).")
p.set_defaults(fn="print_initialized_channels_filter_org")
add_p_org_id(p)
add_group_name(p)
add_p_registry_address_opt(p)
add_p_only_id(p)
add_p_only_sender_signer(p)
add_p_mpe_address_opt(p)
add_eth_call_arguments(p)
def add_p_dont_sync_channels(_p):
_p.add_argument("--do-not-sync", "-ds",
action='store_true',
help="Print channels without synchronizing their state",
default=False)

p = subparsers.add_parser("print-all-filter-sender",
p = subparsers.add_parser("print-filter-sender",
help="Print all channels for the given sender.")
p.set_defaults(fn="print_all_channels_filter_sender")
p.set_defaults(fn="print_channels_filter_sender")
add_p_only_id(p)
add_p_mpe_address_opt(p)
add_p_from_block(p)
add_eth_call_arguments(p)
add_p_sender(p)
add_p_dont_sync_channels(p)

p = subparsers.add_parser("print-all-filter-recipient",
p = subparsers.add_parser("print-filter-recipient",
help="Print all channels for the given recipient.")
p.set_defaults(fn="print_all_channels_filter_recipient")
p.set_defaults(fn="print_channels_filter_recipient")
add_p_only_id(p)
add_p_mpe_address_opt(p)
add_p_from_block(p)
add_eth_call_arguments(p)
p.add_argument("--recipient",
default=None,
help="Account to set as recipient (by default we use the current identity)")
add_p_dont_sync_channels(p)

p = subparsers.add_parser("print-all-filter-group",
p = subparsers.add_parser("print-filter-group",
help="Print all channels for the given service.")
p.set_defaults(fn="print_all_channels_filter_group")

p.set_defaults(fn="print_channels_filter_group")
add_p_org_id(p)
add_group_name(p)
add_p_registry_address_opt(p)
add_p_only_id(p)
add_p_mpe_address_opt(p)
add_p_from_block(p)
add_eth_call_arguments(p)
add_p_dont_sync_channels(p)

p = subparsers.add_parser("print-all-filter-group-sender",
p = subparsers.add_parser("print-filter-group-sender",
help="Print all channels for the given group and sender.")
p.set_defaults(fn="print_all_channels_filter_group_sender")

p.set_defaults(fn="print_channels_filter_group_sender")
add_p_org_id(p)
add_group_name(p)
add_p_registry_address_opt(p)
add_p_only_id(p)
add_p_mpe_address_opt(p)
add_p_from_block(p)
add_eth_call_arguments(p)
add_p_sender(p)
add_p_dont_sync_channels(p)

p = subparsers.add_parser("print-all",
help="Print all channels.")
p.set_defaults(fn="print_all_channels")
add_p_registry_address_opt(p)
add_p_only_id(p)
add_p_mpe_address_opt(p)
add_eth_call_arguments(p)
add_p_dont_sync_channels(p)

p = subparsers.add_parser("claim-timeout",
help="Claim timeout of the channel")
Expand All @@ -857,7 +806,6 @@ def add_p_sender(_p):
p.set_defaults(fn="channel_claim_timeout_all")
add_p_mpe_address_opt(p)
add_transaction_arguments(p)
add_p_from_block(p)


def add_mpe_client_options(parser):
Expand Down Expand Up @@ -901,9 +849,7 @@ def add_p_set1_for_call(_p):
add_p_org_id_service_id(p)
add_group_name(p)
add_p_set1_for_call(p)

add_p_channel_id_opt(p)
add_p_from_block(p)
p.add_argument("--yes", "-y",
action="store_true",
help="Skip interactive confirmation of call price",
Expand Down Expand Up @@ -1214,7 +1160,6 @@ def add_p_publish_params(_p):
_p.add_argument("--update-mpe-address",
action='store_true',
help="Update mpe_address in metadata before publishing them")
add_p_storage_param(p)
add_p_mpe_address_opt(_p)

p = subparsers.add_parser("publish",
Expand All @@ -1223,7 +1168,8 @@ def add_p_publish_params(_p):
add_p_publish_params(p)
add_p_service_in_registry(p)
add_transaction_arguments(p)

add_p_storage_param(p)

p = subparsers.add_parser("publish-in-ipfs",
help="Publish metadata only in IPFS, without publishing in Registry")
p.set_defaults(fn="publish_metadata_in_ipfs")
Expand All @@ -1242,6 +1188,7 @@ def add_p_publish_params(_p):
add_p_publish_params(p)
add_p_service_in_registry(p)
add_transaction_arguments(p)
add_p_storage_param(p)

p = subparsers.add_parser("update-add-tags",
help="Add tags to existed service registration")
Expand Down Expand Up @@ -1374,16 +1321,9 @@ def add_sdk_options(parser):
subparsers = parser.add_subparsers(title="Commands", metavar="COMMAND")
subparsers.required = True

supported_languages = ["python", "nodejs"]

p = subparsers.add_parser("generate-client-library",
help="Generate compiled client libraries to call services using your language of choice")
help="Generate compiled client libraries to call services using Python")
p.set_defaults(fn="generate_client_library")
p.add_argument("language",
choices=supported_languages,
help="Choose target language for the generated client library from {}".format(
supported_languages),
metavar="LANGUAGE")
add_p_service_in_registry(p)
p.add_argument("protodir",
nargs="?",
Expand Down
Loading
Loading