Skip to content

Commit

Permalink
Overhaul readme, overview, status badges and authors.
Browse files Browse the repository at this point in the history
  • Loading branch information
sea-snake committed Dec 9, 2024
1 parent 3534ca7 commit 51c7f41
Show file tree
Hide file tree
Showing 12 changed files with 360 additions and 132 deletions.
202 changes: 159 additions & 43 deletions README.md

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions topics/ICRC-21/icrc_21_consent_msg.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# ICRC-21: Canister Call Consent Messages

[![Status Badge](https://img.shields.io/badge/STATUS-WG_APPROVED-purple.svg)](https://github.com/orgs/dfinity/projects/31)
![APPROVED]

**Authors:** [Frederik Rothenberger](https://github.com/frederikrothenberger)

## Summary
This specification describes a protocol for obtaining human-readable consent messages for canister calls. These messages are intended to be shown to users to help them make informed decisions about whether to approve a canister call / sign a transaction.
Expand Down Expand Up @@ -230,4 +232,6 @@ The message will then be shown to the user in the following context:
│ │ Reject │ │ Approve │ │
│ └───────────┘ └───────────┘ │
└─────────────────────────────────┘
```
```

[APPROVED]: https://img.shields.io/badge/STATUS-APPROVED-ed1e7a.svg
10 changes: 7 additions & 3 deletions topics/icrc_25_signer_interaction_standard.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# ICRC-25: Signer Interaction Standard
# ICRC-25: Signer Interaction

[![Status Badge](https://img.shields.io/badge/STATUS-WG_APPROVED-purple.svg)](https://github.com/orgs/dfinity/projects/31)
![APPROVED]

**Authors:** [Frederik Rothenberger](https://github.com/frederikrothenberger), [Thomas Gladdines](https://github.com/sea-snake), [Dan Ostrovsky](https://github.com/dostro)

<!-- TOC -->
* [ICRC-25: Signer Interaction Standard](#icrc-25-signer-interaction-standard)
* [ICRC-25: Signer Interaction](#icrc-25-signer-interaction)
* [Summary](#summary)
* [Terminology](#terminology)
* [Types](#types)
Expand Down Expand Up @@ -389,3 +391,5 @@ The error is an object comprising the `code`, `message` and optional `data` fiel
}
}
```

[APPROVED]: https://img.shields.io/badge/STATUS-APPROVED-ed1e7a.svg
9 changes: 7 additions & 2 deletions topics/icrc_27_accounts.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# ICRC-27: Accounts

[![Status Badge](https://img.shields.io/badge/STATUS-WG_APPROVED-purple.svg)](https://github.com/orgs/dfinity/projects/31)
[![Extension Badge](https://img.shields.io/badge/Extends-ICRC--25-ffcc222.svg)](./icrc_25_signer_interaction_standard.md)
![APPROVED] [![EXTENDS 25]](./icrc_25_signer_interaction_standard.md)

**Authors:** [Thomas Gladdines](https://github.com/sea-snake)

<!-- TOC -->
* [ICRC-27: Accounts](#icrc-27-accounts)
Expand Down Expand Up @@ -136,3 +137,7 @@ signer does not have the capability to show and transfer tokens of this token st

A relying party MAY only transfer unsupported tokens to a signer account if the relying party is at least able to offer
the capability to show and transfer the tokens held by the signer account itself.

[APPROVED]: https://img.shields.io/badge/STATUS-APPROVED-ed1e7a.svg

[EXTENDS 25]: https://img.shields.io/badge/EXTENDS-ICRC--25-ed1e7a.svg
9 changes: 6 additions & 3 deletions topics/icrc_28_trusted_origins.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# ICRC-28: Trusted Origins

[![Status Badge](https://img.shields.io/badge/STATUS-WG_APPROVED-purple.svg)](https://github.com/orgs/dfinity/projects/31)
[![Standard Issue](https://img.shields.io/badge/ISSUE-ICRC--28-blue?logo=github)](https://github.com/dfinity/wg-identity-authentication/issues/115)
![APPROVED]

**Authors:** [Dan Ostrovsky](https://github.com/dostro)

<!-- TOC -->
* [ICRC-28: Trusted Origins](#icrc-28-trusted-origins)
Expand Down Expand Up @@ -112,4 +113,6 @@ sequenceDiagram
Note over RP, S: Signer allows only Relying Party Delegation selection
S ->> RP: Signed Relying Party Delegation
end
```
```

[APPROVED]: https://img.shields.io/badge/STATUS-APPROVED-ed1e7a.svg
10 changes: 8 additions & 2 deletions topics/icrc_29_window_post_message_transport.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# ICRC-29: Window Post Message Transport for ICRC-25
# ICRC-29: Browser Post Message Transport

[![Status Badge](https://img.shields.io/badge/STATUS-WG_APPROVED-purple.svg)](https://github.com/orgs/dfinity/projects/31)
![APPROVED] [![EXTENDS 25]](./icrc_25_signer_interaction_standard.md)

**Authors:** [Frederik Rothenberger](https://github.com/frederikrothenberger), [Thomas Gladdines](https://github.com/sea-snake)

## Summary

Expand Down Expand Up @@ -87,3 +89,7 @@ If the signer window is closed unexpectedly, the relying party will stop receivi
### Invalid Messages

If either party receives malformed, unexpected, or otherwise invalid messages, it should ignore them.

[APPROVED]: https://img.shields.io/badge/STATUS-APPROVED-ed1e7a.svg

[EXTENDS 25]: https://img.shields.io/badge/EXTENDS-ICRC--25-ed1e7a.svg
10 changes: 8 additions & 2 deletions topics/icrc_32_sign_challenge.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# ICRC-32: Sign Challenge

[![Status Badge](https://img.shields.io/badge/STATUS-DRAFT-ffcc00.svg)](https://github.com/orgs/dfinity/projects/31)
[![Extension Badge](https://img.shields.io/badge/Extends-ICRC--25-ffcc222.svg)](./icrc_25_signer_interaction_standard.md)
![ON HOLD] [![EXTENDS 25]](./icrc_25_signer_interaction_standard.md)

**Authors:** [Philipp Litzenberger](https://github.com/plitzenberger), [Frederik Rothenberger](https://github.com/frederikrothenberger)

<!-- TOC -->
* [ICRC-32: Sign Challenge](#icrc-32-sign-challenge)
Expand All @@ -18,6 +19,7 @@
* [Without Delegation](#without-delegation)
* [With Delegation](#with-delegation)
<!-- TOC -->

## Summary

The purpose of the `icrc32_sign_challenge` method is for the relying party to receive a cryptographic proof of ownership for the users identities.
Expand Down Expand Up @@ -204,3 +206,7 @@ Response
}
}
```

[ON HOLD]: https://img.shields.io/badge/STATUS-ON_HOLD-222222.svg

[EXTENDS 25]: https://img.shields.io/badge/EXTENDS-ICRC--25-ed1e7a.svg
10 changes: 7 additions & 3 deletions topics/icrc_34_delegation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ICRC-34: Delegation

[![Status Badge](https://img.shields.io/badge/STATUS-WG_APPROVED-purple.svg)](https://github.com/orgs/dfinity/projects/31)
[![Extension Badge](https://img.shields.io/badge/EXTENDS-ICRC--25-ffcc222.svg)](./icrc_25_signer_interaction_standard.md)
[![Standard Issue](https://img.shields.io/badge/ISSUE-ICRC--34-blue?logo=github)](https://github.com/dfinity/wg-identity-authentication/issues/115)
![APPROVED] [![EXTENDS 25]](./icrc_25_signer_interaction_standard.md)

**Authors:** [Dan Ostrovsky](https://github.com/dostro), [Thomas Gladdines](https://github.com/sea-snake)

<!-- TOC -->
* [ICRC-34: Delegation](#icrc-34-delegation)
Expand Down Expand Up @@ -202,3 +202,7 @@ the [IC interface specification, authentication section](https://internetcompute

This standard does not define additional errors. See [ICRC-25](./icrc_25_signer_interaction_standard.md#errors-3) for a
list of errors that can be returned by all methods.

[APPROVED]: https://img.shields.io/badge/STATUS-APPROVED-ed1e7a.svg

[EXTENDS 25]: https://img.shields.io/badge/EXTENDS-ICRC--25-ed1e7a.svg
11 changes: 8 additions & 3 deletions topics/icrc_49_call_canister.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# ICRC-49: Call Canister

[![Status Badge](https://img.shields.io/badge/STATUS-WG_APPROVED-purple.svg)](https://github.com/orgs/dfinity/projects/31)
[![Extension Badge](https://img.shields.io/badge/Extends-ICRC--25-ffcc222.svg)](./icrc_25_signer_interaction_standard.md)
![APPROVED] [![EXTENDS 25]](./icrc_25_signer_interaction_standard.md)

**Authors:** [Frederik Rothenberger](https://github.com/frederikrothenberger)

<!-- TOC -->
* [ICRC-49: Call Canister](#icrc-49-call-canister)
Expand Down Expand Up @@ -187,4 +188,8 @@ This standard defines the following additional errors:

| Code | Message | Meaning | Data |
|------|--------------------|------------------------------------------------------------------------------------------------------------------------------|------|
| 2001 | No consent message | The signer has rejected the request because the target canister does not support ICRC-21 consent messages for the given call | N/A |
| 2001 | No consent message | The signer has rejected the request because the target canister does not support ICRC-21 consent messages for the given call | N/A |

[APPROVED]: https://img.shields.io/badge/STATUS-APPROVED-ed1e7a.svg

[EXTENDS 25]: https://img.shields.io/badge/EXTENDS-ICRC--25-ed1e7a.svg
9 changes: 7 additions & 2 deletions topics/icrc_94_multi_injected_provider_discovery.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# ICRC-94: Multi Injected Provider Discovery for ICRC-25
# ICRC-94: Browser Extension Discovery and Transport

[![Status Badge](https://img.shields.io/badge/STATUS-DRAFT-ffcc00.svg)](https://github.com/orgs/dfinity/projects/31)
![DRAFT] [![EXTENDS 25]](./icrc_25_signer_interaction_standard.md)

**Authors:** [Thomas Gladdines](https://github.com/sea-snake), [Dan Ostrovsky](https://github.com/dostro)

## Summary

Expand Down Expand Up @@ -90,3 +92,6 @@ The relying party can then subsequently inform the user to make a decision e.g.

If either party receives malformed, unexpected, or otherwise invalid messages, it should ignore them.

[DRAFT]: https://img.shields.io/badge/STATUS-DRAFT-f25a24.svg

[EXTENDS 25]: https://img.shields.io/badge/EXTENDS-ICRC--25-ed1e7a.svg
17 changes: 11 additions & 6 deletions topics/icrc_95_derivationorigin.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# ICRC-95: derivationOrigin
# ICRC-95: Derivation Origin

[![Status Badge](https://img.shields.io/badge/STATUS-DRAFT-ffcc00.svg)](https://github.com/orgs/dfinity/projects/31)
[![Extension Badge](https://img.shields.io/badge/Extends-ICRC--25-ffcc222.svg)](./icrc_25_signer_interaction_standard.md)
![APPROVED] [![EXTENDS 25]](./icrc_25_signer_interaction_standard.md)

**Authors:** [Dan Ostrovsky](https://github.com/dostro)

<!-- TOC -->
* [ICRC-95: derivationOrigin](#icrc-95-derivationorigin)
* [ICRC-95: Derivation Origin](#icrc-95-derivation-origin)
* [Summary](#summary)
* [Motivation](#motivation)
* [Specification](#specification)
* [Definitions](#definitions)
* [derivationOrigin Parameter](#derivationorigin-parameter)
* [Reference Implementation](#reference-implementation)
* [Signer](#signer)
* [DApp Implementation](#dapp-implementation)
* [DApp Implementation](#dapp-implementation)
<!-- TOC -->

## Summary
Expand Down Expand Up @@ -66,4 +67,8 @@ Here is the DApp's request for a delegation using ICRC-95: derivationOrigin:
"maxTimeToLive": "28800000000000"
}
}
```
```

[APPROVED]: https://img.shields.io/badge/STATUS-APPROVED-ed1e7a.svg

[EXTENDS 25]: https://img.shields.io/badge/EXTENDS-ICRC--25-ed1e7a.svg
Loading

0 comments on commit 51c7f41

Please sign in to comment.