Skip to content

Feat/intents extrinsics and rpcs #2570

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

Merged
JoeCap08055 merged 21 commits into from
Aug 29, 2025
Merged

Feat/intents extrinsics and rpcs #2570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
260f979
push new feature branch
JoeCap08055 Aug 11, 2025
2eea4f4
Implement types and pallet storage for Intents and IntentGroups (#2560)
JoeCap08055 Aug 15, 2025
a31abf4
feat: types, storage, and runtime RPCs for entity Names (Intent, Inte…
JoeCap08055 Aug 18, 2025
f48bd4f
feat: intent extrinsics, intial pass
JoeCap08055 Aug 20, 2025
1847fbe
feat: intent extrinsics and unit tests
JoeCap08055 Aug 22, 2025
9f2b880
feat: makefile targets for package-constrained unit tests
JoeCap08055 Aug 22, 2025
dc7bf57
feat: intent groups unit tests, formatting
JoeCap08055 Aug 25, 2025
e995020
feat: intent groups benchmarks
JoeCap08055 Aug 25, 2025
8d83ea6
feat: disable intent/group direct creation on mainnet
JoeCap08055 Aug 25, 2025
a1df59b
feat: update name validation, run benchmarks
JoeCap08055 Aug 27, 2025
4feee40
fix: format
JoeCap08055 Aug 27, 2025
b64567b
fix: lint
JoeCap08055 Aug 27, 2025
3b91323
feat: update intent group and unit tests
JoeCap08055 Aug 28, 2025
de49b91
fix: format
JoeCap08055 Aug 28, 2025
309b8bf
feat: unit tests & benchmarks for update intent group
JoeCap08055 Aug 28, 2025
f240945
fix: format
JoeCap08055 Aug 28, 2025
9181583
fix: lint
JoeCap08055 Aug 28, 2025
bfb9b35
fix: fix broken e2e test
JoeCap08055 Aug 28, 2025
21a8490
fix: PR comments
JoeCap08055 Aug 29, 2025
d124a80
fix: format
JoeCap08055 Aug 29, 2025
bbd7b02
fix: lint
JoeCap08055 Aug 29, 2025
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
19 changes: 19 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,25 @@ build-bridging-local:
test:
cargo test --workspace --features runtime-benchmarks,frequency-lint-check

# Convenience targets to run individual package/pallet tests
# To further limit to specific tests, specify `make TEST=<test-name-pattern> <test-target>`
test-frequency-runtime \
test-common-runtime \
test-common-primitives \
test-common-helpers \
test-pallet-capacity \
test-pallet-frequency-tx-payment \
test-pallet-handles \
test-pallet-messages \
test-pallet-msa \
test-pallet-passkey \
test-pallet-schemas \
test-pallet-stateful-storage \
test-pallet-time-release \
test-pallet-treasury@27.0.0 \
test-cli-opt:
cargo test -p $(@:test-%=%) --lib -- $(TEST)

test-migrations:
cargo test --workspace --features runtime-benchmarks,frequency-lint-check,try-runtime

Expand Down
2 changes: 1 addition & 1 deletion common/primitives/src/schema.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ pub struct IntentGroupResponse {
/// The unique identifier for this IntentGroup
pub intent_group_id: u16,
/// The list of currently supported IntentIds for this IntentGroup
pub intent_ids: Option<Vec<IntentId>>,
pub intent_ids: Vec<IntentId>,
Copy link
Collaborator

@shannonwells shannonwells Aug 29, 2025

Choose a reason for hiding this comment

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

Was this never meant to be an option?

Copy link
Collaborator Author

@JoeCap08055 JoeCap08055 Aug 29, 2025

Choose a reason for hiding this comment

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

Not sure what this will eventually look like... an upcoming PR in the epic will revisit these runtime APIs and responses, anyway

}

/// RPC response structure for an Intent
Expand Down
2 changes: 1 addition & 1 deletion e2e/schemas/createSchema.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ describe('#createSchema', function () {
});

it('should fail to create schema with invalid character in name v3', async function () {
const f = ExtrinsicHelper.createSchemaV3(keys, AVRO_GRAPH_CHANGE, 'AvroBinary', 'OnChain', [], 'test2.invalid');
const f = ExtrinsicHelper.createSchemaV3(keys, AVRO_GRAPH_CHANGE, 'AvroBinary', 'OnChain', [], 'test@.invalid');
await assert.rejects(f.fundAndSend(fundingSource), {
name: 'InvalidSchemaNameCharacters',
});
Expand Down
58 changes: 41 additions & 17 deletions pallets/schemas/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,28 +98,40 @@ The Schemas pallet provides for:

### Extrinsics

| Name/Description | Caller | Payment | Key Events | Runtime Added |
|-------------------------------------------------------------------------------------------------------|-------------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| `set_max_schema_model_bytes`<br />Governance action to alter the maximum byte length of Schema models | Governance | Tokens | [`SchemaMaxSizeChanged`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaMaxSizeChanged) | 1 |
| `propose_to_create_schema_v2`<br />Creates a proposal to the Frequency Council for a new schema | Token Account | Tokens | [`Proposed`](https://paritytech.github.io/polkadot-sdk/master/pallet_collective/pallet/enum.Event.html#variant.Proposed) | 66 |
| `create_schema_via_governance_v2`<br />Governance action version of `create_schema_v3` | Frequency Council | Tokens | [`SchemaCreated`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaCreated) | 66 |
| `create_schema_v3`<br />Creates a new Schema. | Mainnet: Governance<br />Testnet: Token Account | Tokens | [`SchemaCreated`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaCreated) | 1 |
| `propose_to_create_schema_name`<br />Creates a Council proposal to set the name of a Schema | Token Account | Tokens | [`Proposed`](https://paritytech.github.io/polkadot-sdk/master/pallet_collective/pallet/enum.Event.html#variant.Proposed) | 1 |
| `create_schema_name_via_governance`<br />Governance action to set the name of a Schema | Frequency Council | Tokens | [`SchemaNameCreated`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaNameCreated) | 66 |
| Name/Description | Caller | Payment | Key Events | Runtime Added |
|---------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| `set_max_schema_model_bytes`<br />Governance action to alter the maximum byte length of Schema models | Governance | Tokens | [`SchemaMaxSizeChanged`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaMaxSizeChanged) | 1 |
| `propose_to_create_schema_v2`<br />Creates a proposal to the Frequency Council for a new schema | Token Account | Tokens | [`Proposed`](https://paritytech.github.io/polkadot-sdk/master/pallet_collective/pallet/enum.Event.html#variant.Proposed) | 66 |
| `create_schema_via_governance_v2`<br />Governance action version of `create_schema_v3` | Frequency Council | Tokens | [`SchemaCreated`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaCreated) | 66 |
| `create_schema_v3`<br />Creates a new Schema. | Mainnet: Governance<br />Testnet: Token Account | Tokens | [`SchemaCreated`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaCreated) | 1 |
| `propose_to_create_schema_name`<br />Creates a Council proposal to set the name of a Schema | Token Account | Tokens | [`Proposed`](https://paritytech.github.io/polkadot-sdk/master/pallet_collective/pallet/enum.Event.html#variant.Proposed) | 1 |
| `create_schema_name_via_governance`<br />Governance action to set the name of a Schema <br/> | Frequency Council | Tokens | [`SchemaNameCreated`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaNameCreated) | 66 |
| `create_intent`<br />Creates a new Intent (local/testnet only) | Mainnet: filtered<br/>Testnet: Token Account | Tokens | `IntentCreated` | ? |
| `create_intent_via_governance`<br/>Governance action version of `create_intent` | Frequency Council | Tokens | `IntentCreated` | ? |
| `propose_to_create_intent`<br/>Creates a proposal to the Frequency Council for a new Intent | Token Account | Tokens | `Proposed` | ? |
| `create_intent_group`<br/>Creates an Intent Group | Mainnet: prohibited<br/>Testnet: Token Account | Tokens | `IntentGroupCreated` | ? |
| `create_intent_group_via_governance`<br/>Governance action version of `create_intent_group` | Frequency Council | Tokens | `IntentGroupCreated` | ? |
| `propose_to_create_intent_group`<br/>Creates a proposal to the Frequency Council for a new Intent Group | Token Account | Tokens | `Proposed` | ? |
| `update_intent_group`<br/>Updates an existing IntentGroup with a new list of Intents | Mainnet: prohibited<br/>Testnet: Token Account | Tokens | `IntentGroupUpdated` | ? |
| `update_intent_group_via_governance`<br/>Governance action verison of `update_intent_group` | Frequency Council | Tokens | `IntentGroupUpdated` | ? |
| `propose_to_update_intent_group`<br/>Creates a proposal to the Frequency Council to update an existing Intent Group | Token Account | Tokens | `Proposed` | ? |

See [Rust Docs](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/struct.Pallet.html) for more details.

### State Queries

| Name | Description | Query | Runtime Added |
|-----------------------------------|---------------------------------------------------------------------|----------------------------------|---------------|
| Get Max Current Schema Identifier | Fetch current Schema Identifier maximum | `currentSchemaIdentifierMaximum` | 1 |
| Get Schema Model Max Bytes | Fetch maximum number of bytes per Schema Model as set by Governance | `governanceSchemaModelMaxBytes` | 1 |
| Get a Schema Info | Fetch the metadata and settings for a schema | `schemaInfos` | 62 |
| Get Schema Ids by Name | Fetch matching Schemas Ids by namespace and name | `schemaNameToIds` | 62 |
| Get Schema Payload/Model | Fetch the payload/model JSON for the specified Schema | `schemaPayloads` | 62 |
| Get Intent Info | Fetch the metadata for an Intent | `intentInfos` | ?? |
| Get Intent Group Info | Fetch the list of Intents registered in an Intent Group | `intentGroups` | ?? |
| Name | Description | Query | Runtime Added |
|-----------------------------------------|---------------------------------------------------------------------|---------------------------------------|---------------|
| Get Max Current Schema Identifier | Fetch current Schema Identifier maximum | `currentSchemaIdentifierMaximum` | 1 |
| Get Max Current Intent Identifier | Fetch current Intent Identifier maximum | `currentIntentIdentifierMaximum` | ?? |
| Get Max Current Intent Group Identifier | Fetch current IntentGroup Identifier maximum | `currentIntentGroupIdentifierMaximum` | ?? |
| Get Schema Model Max Bytes | Fetch maximum number of bytes per Schema Model as set by Governance | `governanceSchemaModelMaxBytes` | 1 |
| Get a Schema Info | Fetch the metadata and settings for a schema | `schemaInfos` | 62 |
| Get Schema Ids by Name | Fetch matching Schemas Ids by namespace and name | `schemaNameToIds` | 62 |
| Get Schema Payload/Model | Fetch the payload/model JSON for the specified Schema | `schemaPayloads` | 62 |
| Get Intent Info | Fetch the metadata for an Intent | `intentInfos` | ?? |
| Get Intent Group Info | Fetch the list of Intents registered in an Intent Group | `intentGroups` | ?? |
| Get Intent/IntentGroup IDs by Name | Fetch matching Intent/IntentGroup IDs by protocol and descriptor | `nameToMappedEntityIds` | ?? |

See the [Rust Docs](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/storage_types/index.html) for
additional state queries and details.
Expand All @@ -138,3 +150,15 @@ Note: May be restricted based on node settings and configuration.

See [Rust Docs](https://frequency-chain.github.io/frequency/pallet_schemas_rpc/trait.SchemasApiServer.html) for more
details.

### Runtime API

| Name | Description | Call | API Version Added | Runtime Added |
|---------------------------------------------------------|----------------------------------------------------------------|-------------------------------|-------------------|---------------|
| Get Schema by Id | Retrieves the schema for the given Schema Id | `getBySchemaId` | 1 | 1 |
| Get Schema Versions by Name | Retrieves the ordered list of Schema Ids for the given name(s) | `getSchemaVersionsByName` | 2 | 66 |
| Get registered entity (Intent, IntentGroup) IDs by Name | Retrieves the entities belonging to the given name(s) | `getRegisteredEntitiesByName` | 3 | ? |

See [Rust Docs](https://frequency-chain.github.io/frequency/pallet_schemas_runtime_api/trait.SchemasRuntimeApi.html) for
more details.

Loading
Loading