Skip to content

Commit

Permalink
Merge branch 'main' into swcurran-rtd-fix-1
Browse files Browse the repository at this point in the history
  • Loading branch information
swcurran authored Oct 15, 2023
2 parents ea22d3a + f503a2e commit d11f89f
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -1294,7 +1294,7 @@ async with profile.session() as session:
- Various documentation and bug fixes
- Add admin routes for fetching and accepting the ledger transaction author agreement [#144](https://github.com/hyperledger/aries-cloudagent-python/pull/144)
- Add support for receiving connection-less proof presentations [#296](https://github.com/hyperledger/aries-cloudagent-python/pull/296)
- Set attachment id explicitely in unbound proof request [#289](https://github.com/hyperledger/aries-cloudagent-python/pull/289)
- Set attachment id explicitly in unbound proof request [#289](https://github.com/hyperledger/aries-cloudagent-python/pull/289)
- Add create-proposal admin endpoint to the present-proof protocol [#288](https://github.com/hyperledger/aries-cloudagent-python/pull/288)
- Remove old anon/authcrypt support [#282](https://github.com/hyperledger/aries-cloudagent-python/pull/282)
- Allow additional endpoints to be specified [#276](https://github.com/hyperledger/aries-cloudagent-python/pull/276)
Expand Down
4 changes: 2 additions & 2 deletions Endorser.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ACA-Py supports an [Endorser Protocol](https://github.com/hyperledger/aries-rfcs/pull/586), that allows an un-privileged agent (an "Author") to request another agent (the "Endorser") to sign their transactions so they can write these transactions to the ledger. This is required on Indy ledgers, where new agents will typically be granted only "Author" privileges.

Transaction Endorsement is built into the protocols for Schema, Credential Definition and Revocation, and endorsements can be explicitely requested, or ACA-Py can be configured to automate the endorsement workflow.
Transaction Endorsement is built into the protocols for Schema, Credential Definition and Revocation, and endorsements can be explicitly requested, or ACA-Py can be configured to automate the endorsement workflow.

## Setting up Connections between Authors and Endorsers

Expand All @@ -12,7 +12,7 @@ Once the connection is established and `active`, the "role" (either Author or En

## Requesting Transaction Endorsement

Transaction Endorsement is built into the protocols for Schema, Credential Definition and Revocation. When executing one of the endpoints that will trigger a ledger write, an endorsement protocol can be explicitely requested by specifying the `connection_id` (of the Endorser connection) and `create_transaction_for_endorser`.
Transaction Endorsement is built into the protocols for Schema, Credential Definition and Revocation. When executing one of the endpoints that will trigger a ledger write, an endorsement protocol can be explicitly requested by specifying the `connection_id` (of the Endorser connection) and `create_transaction_for_endorser`.

(Note that endorsement requests can be automated, see the secion on "Configuring ACA-Py" below.)

Expand Down
2 changes: 1 addition & 1 deletion aries_cloudagent/commands/start.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def execute(argv: Sequence[str] = None):
settings = get_settings(args)
common_config(settings)

# set ledger to read only if explicitely specified
# set ledger to read only if explicitly specified
settings["ledger.read_only"] = settings.get("read_only_ledger", False)

# Create the Conductor instance
Expand Down
2 changes: 1 addition & 1 deletion aries_cloudagent/core/conductor.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ class Conductor:
"""Conductor class.
Class responsible for initializing concrete implementations
of our require interfaces and routing inbound and outbound message data.
of our required interfaces and routing inbound and outbound message data.
"""

def __init__(self, context_builder: ContextBuilder) -> None:
Expand Down
2 changes: 1 addition & 1 deletion aries_cloudagent/resolver/did_resolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ async def _match_did_to_resolver(
)
resolvers = list(chain(native_resolvers, non_native_resolvers))
if not resolvers:
raise DIDMethodNotSupported(f'No resolver supprting DID "{did}" loaded')
raise DIDMethodNotSupported(f'No resolver supporting DID "{did}" loaded')
return resolvers

async def dereference(
Expand Down
2 changes: 1 addition & 1 deletion aries_cloudagent/utils/tracing.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def get_timer() -> float:

def tracing_enabled(context, message) -> bool:
"""Determine whether to log trace messages or not."""
# check if tracing is explicitely on
# check if tracing is explicitly on
if context.get("trace.enabled"):
return True

Expand Down
2 changes: 1 addition & 1 deletion demo/AliceWantsAJsonCredential.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ You do *not* create a schema or cred def for a JSON-LD credential (these are onl

You will need to create a DID as above for Alice as well (`/wallet/did/create` etc ...).

Congradulations, you are now ready to start issuing JSON-LD credentials!
Congratulations, you are now ready to start issuing JSON-LD credentials!

- You have two agents with a connection established between the agents - you will need to copy Faber's `connection_id` into the examples below.
- You have created a (non-public) DID for Faber to use to sign/issue the credentials - you will need to copy the DID that you created above into the examples below (as `issuer`).
Expand Down
2 changes: 1 addition & 1 deletion demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ To enable support for revoking credentials, run the `faber` demo with the `--rev
./run_demo faber --revocation
```

Note that you don't specify this option with `alice` because it's only applicable for the credential `issuer` (who has to enable revocation when creating a credential definition, and explicitely revoke credentials as appropriate; alice doesn't have to do anything special when revocation is enabled).
Note that you don't specify this option with `alice` because it's only applicable for the credential `issuer` (who has to enable revocation when creating a credential definition, and explicitly revoke credentials as appropriate; alice doesn't have to do anything special when revocation is enabled).

You need to run an AnonCreds revocation registry tails server in order to support revocation - the details are described in the [Alice gets a Phone](https://github.com/hyperledger/aries-cloudagent-python/blob/master/demo/AliceGetsAPhone.md#run-an-instance-of-indy-tails-server) demo instructions.

Expand Down
2 changes: 1 addition & 1 deletion demo/docker-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ For example start the endorser service as `LEDGER_URL=http://test.bcovrin.vonx.i

### Connecting the Author to the Endorser

Endorser Service: Use the `GET /v1/admin/config` endpoint to fetch the endorser's configuration, including the public DID (which the author will need to know). Also confirm whether the `ENDORSER_AUTO_ACCEPT_CONNECTIONS` and `ENDORSER_AUTO_ENDORSE_REQUESTS` settings are `True` or `False` - for the following we will assume that both are `False` and the endorser must explicitely respond to all requests.
Endorser Service: Use the `GET /v1/admin/config` endpoint to fetch the endorser's configuration, including the public DID (which the author will need to know). Also confirm whether the `ENDORSER_AUTO_ACCEPT_CONNECTIONS` and `ENDORSER_AUTO_ENDORSE_REQUESTS` settings are `True` or `False` - for the following we will assume that both are `False` and the endorser must explicitly respond to all requests.

Author Agent: Use the `POST /didexchange/create-request` to request a connection with the endorser, using the endorser's public DID. Set the `alias` to `Endorser` - this *MUST* match the `--endorser-alias 'Endorser'` setting (in the ngrok-wait.sh script). Use the `GET /connections` endpoint to verify the connection is in `request` state.

Expand Down

0 comments on commit d11f89f

Please sign in to comment.