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.

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

docs: add w3 space basic spec #93

Merged
merged 2 commits into from
Jan 19, 2024
Merged

docs: add w3 space basic spec #93

merged 2 commits into from
Jan 19, 2024

Conversation

vasco-santos
Copy link
Contributor

Adds basic space spec. While at first considered to add it to w3-account or w3-access, I realized that account has a specific focus on high level account with multiple spaces, while access focus on "aggregating and managing delegated capabilities across agents". Therefore, ended up with new spec document to reflect the basics of a space protocol.

It is complemented by w3-account and w3-provider on how to integrate account and providers, while in its basic form adds wire protocol for the space specific capabilities that do not fall under the umbrella of account and provider.

w3-space.md Outdated
}
```

### `space/allocate`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to document this? AFAIK it is not used by our client/server as an invoked capability...although the handler is used by store/add handler.

However it doesn't do anything related to allocating space - it rate limits and checks for storage provider.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is used by store/add yes. I think it should be documented, as store/add may happen in another place in the future.

However it doesn't do anything related to allocating space - it rate limits and checks for storage provider.

I think because it is not implemented? But that is the goal here? We can make that clear in the spec if that would be the desire.

Maybe @travis can help out with decision here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is used by store/add yes. I think it should be documented, as store/add may happen in another place in the future.

Right but I think that should be in w3-store.md and should say that store/add MAY rate limit and SHOULD ensure the space is provisioned properly.

I think because it is not implemented? But that is the goal here? We can make that clear in the spec if that would be the desire.

I would just remove it - it is not invoked and does nothing to do with allocating space. The handler function should instead be a lib/utility function.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, I removed until we decide what to do

@vasco-santos vasco-santos requested a review from alanshaw January 19, 2024 13:23
@vasco-santos vasco-santos merged commit 049fc08 into main Jan 19, 2024
2 checks passed
@vasco-santos vasco-santos deleted the docs/add-w3-space branch January 19, 2024 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants