From 9ecf430dde4e50772a93567190f0384d58db9f69 Mon Sep 17 00:00:00 2001 From: Ross Nicoll Date: Mon, 9 May 2016 17:37:05 +0100 Subject: [PATCH] Update documentation to match PartyAndReference naming --- docs/build/html/_sources/codestyle.txt | 9 ++- docs/build/html/api/alltypes/index.html | 2 +- .../api/contracts/-cash/-state/-init-.html | 2 +- .../api/contracts/-cash/-state/deposit.html | 2 +- .../api/contracts/-cash/-state/index.html | 4 +- .../api/contracts/-cash/generate-issue.html | 4 +- .../build/html/api/contracts/-cash/index.html | 2 +- .../-commercial-paper/-state/-init-.html | 2 +- .../-commercial-paper/-state/index.html | 6 +- .../-commercial-paper/-state/issuance.html | 2 +- .../-state/with-issuance.html | 4 +- .../-commercial-paper/generate-issue.html | 4 +- .../contracts/-commercial-paper/index.html | 2 +- .../-crowd-fund/generate-register.html | 4 +- .../html/api/contracts/-crowd-fund/index.html | 2 +- .../-dummy-contract/generate-initial.html | 4 +- .../api/contracts/-dummy-contract/index.html | 2 +- .../api/core/-party-and-reference/-init-.html | 16 +++++ .../api/core/-party-and-reference/index.html | 57 +++++++++++++++++ .../api/core/-party-and-reference/party.html | 15 +++++ .../core/-party-and-reference/reference.html | 15 +++++ .../core/-party-and-reference/to-string.html | 15 +++++ docs/build/html/api/core/-party/index.html | 4 +- docs/build/html/api/core/-party/ref.html | 4 +- docs/build/html/api/core/index.html | 4 +- docs/build/html/api/index-outline.html | 64 +++++++++---------- docs/build/html/codestyle.html | 8 +++ docs/source/codestyle.rst | 9 ++- 28 files changed, 204 insertions(+), 64 deletions(-) create mode 100644 docs/build/html/api/core/-party-and-reference/-init-.html create mode 100644 docs/build/html/api/core/-party-and-reference/index.html create mode 100644 docs/build/html/api/core/-party-and-reference/party.html create mode 100644 docs/build/html/api/core/-party-and-reference/reference.html create mode 100644 docs/build/html/api/core/-party-and-reference/to-string.html diff --git a/docs/build/html/_sources/codestyle.txt b/docs/build/html/_sources/codestyle.txt index 681884292c..2e15c7fd28 100644 --- a/docs/build/html/_sources/codestyle.txt +++ b/docs/build/html/_sources/codestyle.txt @@ -52,6 +52,14 @@ Code is vertically dense, blank lines in methods are used sparingly. This is so We use spaces and not tabs. +1.2 Naming +---------- + +Naming generally follows Java standard style (pascal case for class names, camel case for methods, properties and +variables). Where a class name describes a tuple, "And" should be included in order to clearly indicate the elements are +individual parts, for example ``PartyAndReference``, not ``PartyReference`` (which sounds like a reference to a +``Party``). + 2. Comments ########### @@ -177,4 +185,3 @@ instead do this The latter is easier to catch and handle if later necessary, and the type name should explain what went wrong. Note that Kotlin does not require exception types to be declared in method prototypes like Java does. - diff --git a/docs/build/html/api/alltypes/index.html b/docs/build/html/api/alltypes/index.html index 3cb9c2ed05..a569f7d2c6 100644 --- a/docs/build/html/api/alltypes/index.html +++ b/docs/build/html/api/alltypes/index.html @@ -918,7 +918,7 @@ functionality to Java, but it wont arrive for a few years yet

-core.PartyReference +core.PartyAndReference

Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.

diff --git a/docs/build/html/api/contracts/-cash/-state/-init-.html b/docs/build/html/api/contracts/-cash/-state/-init-.html index 2d4898ad5b..fee165d2a1 100644 --- a/docs/build/html/api/contracts/-cash/-state/-init-.html +++ b/docs/build/html/api/contracts/-cash/-state/-init-.html @@ -7,7 +7,7 @@ contracts / Cash / State / <init>

<init>

-State(deposit: PartyReference, amount: Amount, owner: PublicKey)
+State(deposit: PartyAndReference, amount: Amount, owner: PublicKey)

A state representing a cash claim against some party



diff --git a/docs/build/html/api/contracts/-cash/-state/deposit.html b/docs/build/html/api/contracts/-cash/-state/deposit.html index 5719392e4d..302d5c7438 100644 --- a/docs/build/html/api/contracts/-cash/-state/deposit.html +++ b/docs/build/html/api/contracts/-cash/-state/deposit.html @@ -8,7 +8,7 @@

deposit

-val deposit: PartyReference
+val deposit: PartyAndReference

Where the underlying currency backing this ledger entry can be found (propagated)



diff --git a/docs/build/html/api/contracts/-cash/-state/index.html b/docs/build/html/api/contracts/-cash/-state/index.html index 07026c7fea..a4355918d8 100644 --- a/docs/build/html/api/contracts/-cash/-state/index.html +++ b/docs/build/html/api/contracts/-cash/-state/index.html @@ -18,7 +18,7 @@ <init> -State(deposit: PartyReference, amount: Amount, owner: PublicKey)

A state representing a cash claim against some party

+State(deposit: PartyAndReference, amount: Amount, owner: PublicKey)

A state representing a cash claim against some party

@@ -43,7 +43,7 @@ deposit -val deposit: PartyReference

Where the underlying currency backing this ledger entry can be found (propagated)

+val deposit: PartyAndReference

Where the underlying currency backing this ledger entry can be found (propagated)

diff --git a/docs/build/html/api/contracts/-cash/generate-issue.html b/docs/build/html/api/contracts/-cash/generate-issue.html index 38be4af60c..40c68d08f2 100644 --- a/docs/build/html/api/contracts/-cash/generate-issue.html +++ b/docs/build/html/api/contracts/-cash/generate-issue.html @@ -7,8 +7,8 @@ contracts / Cash / generateIssue

generateIssue

- -fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyReference, owner: PublicKey): Unit
+ +fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyAndReference, owner: PublicKey): Unit

Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.



diff --git a/docs/build/html/api/contracts/-cash/index.html b/docs/build/html/api/contracts/-cash/index.html index 4663b87d2d..b6b628d0c8 100644 --- a/docs/build/html/api/contracts/-cash/index.html +++ b/docs/build/html/api/contracts/-cash/index.html @@ -73,7 +73,7 @@ the same transaction.

generateIssue -fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyReference, owner: PublicKey): Unit

Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.

+fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyAndReference, owner: PublicKey): Unit

Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.

diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/-init-.html b/docs/build/html/api/contracts/-commercial-paper/-state/-init-.html index 6f950169b3..3d39997a1b 100644 --- a/docs/build/html/api/contracts/-commercial-paper/-state/-init-.html +++ b/docs/build/html/api/contracts/-commercial-paper/-state/-init-.html @@ -7,7 +7,7 @@ contracts / CommercialPaper / State / <init>

<init>

-State(issuance: PartyReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)
+State(issuance: PartyAndReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)


diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/index.html b/docs/build/html/api/contracts/-commercial-paper/-state/index.html index cb574e974e..ce3cb54d54 100644 --- a/docs/build/html/api/contracts/-commercial-paper/-state/index.html +++ b/docs/build/html/api/contracts/-commercial-paper/-state/index.html @@ -17,7 +17,7 @@ <init> -State(issuance: PartyReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant) +State(issuance: PartyAndReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant) @@ -41,7 +41,7 @@ issuance -val issuance: PartyReference +val issuance: PartyAndReference @@ -77,7 +77,7 @@ withIssuance -fun withIssuance(newIssuance: PartyReference): <ERROR CLASS> +fun withIssuance(newIssuance: PartyAndReference): <ERROR CLASS> diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html b/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html index f1f65450bd..9d7cc473be 100644 --- a/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html +++ b/docs/build/html/api/contracts/-commercial-paper/-state/issuance.html @@ -8,7 +8,7 @@

issuance

-val issuance: PartyReference
+val issuance: PartyAndReference


diff --git a/docs/build/html/api/contracts/-commercial-paper/-state/with-issuance.html b/docs/build/html/api/contracts/-commercial-paper/-state/with-issuance.html index a995e0d8a0..2c97ca9e5d 100644 --- a/docs/build/html/api/contracts/-commercial-paper/-state/with-issuance.html +++ b/docs/build/html/api/contracts/-commercial-paper/-state/with-issuance.html @@ -7,8 +7,8 @@ contracts / CommercialPaper / State / withIssuance

withIssuance

- -fun withIssuance(newIssuance: PartyReference): <ERROR CLASS>
+ +fun withIssuance(newIssuance: PartyAndReference): <ERROR CLASS>


diff --git a/docs/build/html/api/contracts/-commercial-paper/generate-issue.html b/docs/build/html/api/contracts/-commercial-paper/generate-issue.html index b5bf985fb6..029938de61 100644 --- a/docs/build/html/api/contracts/-commercial-paper/generate-issue.html +++ b/docs/build/html/api/contracts/-commercial-paper/generate-issue.html @@ -7,8 +7,8 @@ contracts / CommercialPaper / generateIssue

generateIssue

- -fun generateIssue(issuance: PartyReference, faceValue: Amount, maturityDate: Instant): TransactionBuilder
+ +fun generateIssue(issuance: PartyAndReference, faceValue: Amount, maturityDate: Instant): TransactionBuilder

Returns a transaction that issues commercial paper, owned by the issuing parties key. Does not update an existing transaction because you arent able to issue multiple pieces of CP in a single transaction at the moment: this restriction is not fundamental and may be lifted later.

diff --git a/docs/build/html/api/contracts/-commercial-paper/index.html b/docs/build/html/api/contracts/-commercial-paper/index.html index 401304d924..9a25ee98c8 100644 --- a/docs/build/html/api/contracts/-commercial-paper/index.html +++ b/docs/build/html/api/contracts/-commercial-paper/index.html @@ -58,7 +58,7 @@ the contracts contents).

generateIssue -fun generateIssue(issuance: PartyReference, faceValue: Amount, maturityDate: Instant): TransactionBuilder

Returns a transaction that issues commercial paper, owned by the issuing parties key. Does not update +fun generateIssue(issuance: PartyAndReference, faceValue: Amount, maturityDate: Instant): TransactionBuilder

Returns a transaction that issues commercial paper, owned by the issuing parties key. Does not update an existing transaction because you arent able to issue multiple pieces of CP in a single transaction at the moment: this restriction is not fundamental and may be lifted later.

diff --git a/docs/build/html/api/contracts/-crowd-fund/generate-register.html b/docs/build/html/api/contracts/-crowd-fund/generate-register.html index 1462ebbd49..77e4bbc232 100644 --- a/docs/build/html/api/contracts/-crowd-fund/generate-register.html +++ b/docs/build/html/api/contracts/-crowd-fund/generate-register.html @@ -7,8 +7,8 @@ contracts / CrowdFund / generateRegister

generateRegister

- -fun generateRegister(owner: PartyReference, fundingTarget: Amount, fundingName: String, closingTime: Instant): TransactionBuilder
+ +fun generateRegister(owner: PartyAndReference, fundingTarget: Amount, fundingName: String, closingTime: Instant): TransactionBuilder

Returns a transaction that registers a crowd-funding campaing, owned by the issuing institutions key. Does not update an existing transaction because its not possible to register multiple campaigns in a single transaction


diff --git a/docs/build/html/api/contracts/-crowd-fund/index.html b/docs/build/html/api/contracts/-crowd-fund/index.html index a5a5ae0583..a99b08b0a4 100644 --- a/docs/build/html/api/contracts/-crowd-fund/index.html +++ b/docs/build/html/api/contracts/-crowd-fund/index.html @@ -104,7 +104,7 @@ the contracts contents).

generateRegister -fun generateRegister(owner: PartyReference, fundingTarget: Amount, fundingName: String, closingTime: Instant): TransactionBuilder

Returns a transaction that registers a crowd-funding campaing, owned by the issuing institutions key. Does not update +fun generateRegister(owner: PartyAndReference, fundingTarget: Amount, fundingName: String, closingTime: Instant): TransactionBuilder

Returns a transaction that registers a crowd-funding campaing, owned by the issuing institutions key. Does not update an existing transaction because its not possible to register multiple campaigns in a single transaction

diff --git a/docs/build/html/api/contracts/-dummy-contract/generate-initial.html b/docs/build/html/api/contracts/-dummy-contract/generate-initial.html index 19657ff999..2ce3efe320 100644 --- a/docs/build/html/api/contracts/-dummy-contract/generate-initial.html +++ b/docs/build/html/api/contracts/-dummy-contract/generate-initial.html @@ -7,8 +7,8 @@ contracts / DummyContract / generateInitial

generateInitial

- -fun generateInitial(owner: PartyReference, magicNumber: Int): TransactionBuilder
+ +fun generateInitial(owner: PartyAndReference, magicNumber: Int): TransactionBuilder


diff --git a/docs/build/html/api/contracts/-dummy-contract/index.html b/docs/build/html/api/contracts/-dummy-contract/index.html index 11dd998b8c..ee0f09db2f 100644 --- a/docs/build/html/api/contracts/-dummy-contract/index.html +++ b/docs/build/html/api/contracts/-dummy-contract/index.html @@ -58,7 +58,7 @@ the contracts contents).

generateInitial -fun generateInitial(owner: PartyReference, magicNumber: Int): TransactionBuilder +fun generateInitial(owner: PartyAndReference, magicNumber: Int): TransactionBuilder diff --git a/docs/build/html/api/core/-party-and-reference/-init-.html b/docs/build/html/api/core/-party-and-reference/-init-.html new file mode 100644 index 0000000000..b8c649ae4a --- /dev/null +++ b/docs/build/html/api/core/-party-and-reference/-init-.html @@ -0,0 +1,16 @@ + + +PartyAndReference.<init> - + + + +core / PartyAndReference / <init>
+
+

<init>

+PartyAndReference(party: Party, reference: OpaqueBytes)
+

Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal +ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.

+
+
+ + diff --git a/docs/build/html/api/core/-party-and-reference/index.html b/docs/build/html/api/core/-party-and-reference/index.html new file mode 100644 index 0000000000..768d52c73d --- /dev/null +++ b/docs/build/html/api/core/-party-and-reference/index.html @@ -0,0 +1,57 @@ + + +PartyAndReference - + + + +core / PartyAndReference
+
+

PartyAndReference

+data class PartyAndReference
+

Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal +ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.

+
+
+

Constructors

+ + + + + + + +
+<init> +PartyAndReference(party: Party, reference: OpaqueBytes)

Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal +ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.

+
+

Properties

+ + + + + + + + + + + +
+party +val party: Party
+reference +val reference: OpaqueBytes
+

Functions

+ + + + + + + +
+toString +fun toString(): String
+ + diff --git a/docs/build/html/api/core/-party-and-reference/party.html b/docs/build/html/api/core/-party-and-reference/party.html new file mode 100644 index 0000000000..b7aebccee3 --- /dev/null +++ b/docs/build/html/api/core/-party-and-reference/party.html @@ -0,0 +1,15 @@ + + +PartyAndReference.party - + + + +core / PartyAndReference / party
+
+

party

+ +val party: Party
+
+
+ + diff --git a/docs/build/html/api/core/-party-and-reference/reference.html b/docs/build/html/api/core/-party-and-reference/reference.html new file mode 100644 index 0000000000..a7a29c3c4f --- /dev/null +++ b/docs/build/html/api/core/-party-and-reference/reference.html @@ -0,0 +1,15 @@ + + +PartyAndReference.reference - + + + +core / PartyAndReference / reference
+
+

reference

+ +val reference: OpaqueBytes
+
+
+ + diff --git a/docs/build/html/api/core/-party-and-reference/to-string.html b/docs/build/html/api/core/-party-and-reference/to-string.html new file mode 100644 index 0000000000..2cbd4b3dcd --- /dev/null +++ b/docs/build/html/api/core/-party-and-reference/to-string.html @@ -0,0 +1,15 @@ + + +PartyAndReference.toString - + + + +core / PartyAndReference / toString
+
+

toString

+ +fun toString(): String
+
+
+ + diff --git a/docs/build/html/api/core/-party/index.html b/docs/build/html/api/core/-party/index.html index 41d06a0151..e211d26a04 100644 --- a/docs/build/html/api/core/-party/index.html +++ b/docs/build/html/api/core/-party/index.html @@ -47,8 +47,8 @@ ref -fun ref(bytes: OpaqueBytes): PartyReference
-fun ref(vararg bytes: Byte): PartyReference +fun ref(bytes: OpaqueBytes): PartyAndReference
+fun ref(vararg bytes: Byte): PartyAndReference diff --git a/docs/build/html/api/core/-party/ref.html b/docs/build/html/api/core/-party/ref.html index 94db4e8377..ee12fcb395 100644 --- a/docs/build/html/api/core/-party/ref.html +++ b/docs/build/html/api/core/-party/ref.html @@ -8,9 +8,9 @@

ref

-fun ref(bytes: OpaqueBytes): PartyReference
+fun ref(bytes: OpaqueBytes): PartyAndReference
-fun ref(vararg bytes: Byte): PartyReference
+fun ref(vararg bytes: Byte): PartyAndReference


diff --git a/docs/build/html/api/core/index.html b/docs/build/html/api/core/index.html index c8e4e9d485..f10e35857e 100644 --- a/docs/build/html/api/core/index.html +++ b/docs/build/html/api/core/index.html @@ -203,9 +203,9 @@ with the commands from the wire, and verified/looked up.

-PartyReference +PartyAndReference -data class PartyReference

Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal +data class PartyAndReference

Reference to something being stored or issued by a party e.g. in a vault or (more likely) on their normal ledger. The reference is intended to be encrypted so its meaningless to anyone other than the party.

diff --git a/docs/build/html/api/index-outline.html b/docs/build/html/api/index-outline.html index 07bb9810b1..4bf5498318 100644 --- a/docs/build/html/api/index-outline.html +++ b/docs/build/html/api/index-outline.html @@ -589,17 +589,17 @@ -State(deposit: PartyReference, amount: Amount, owner: PublicKey)
+State(deposit: PartyAndReference, amount: Amount, owner: PublicKey)
val amount: Amount
val contract: Cash
-val deposit: PartyReference
+val deposit: PartyAndReference
val owner: PublicKey
fun toString(): String
fun withNewOwner(newOwner: PublicKey): <ERROR CLASS>
-fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyReference, owner: PublicKey): Unit
+fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyAndReference, owner: PublicKey): Unit
fun generateSpend(tx: TransactionBuilder, amount: Amount, to: PublicKey, cashStates: List<StateAndRef<State>>, onlyFromParties: Set<Party>? = null): List<PublicKey>
val legalContractReference: SecureHash
fun verify(tx: TransactionForVerification): Unit
@@ -699,15 +699,15 @@ -State(issuance: PartyReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)
+State(issuance: PartyAndReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)
val contract: CommercialPaper
val faceValue: Amount
-val issuance: PartyReference
+val issuance: PartyAndReference
val maturityDate: Instant
val owner: PublicKey
fun toString(): String
fun withFaceValue(newFaceValue: Amount): <ERROR CLASS>
-fun withIssuance(newIssuance: PartyReference): <ERROR CLASS>
+fun withIssuance(newIssuance: PartyAndReference): <ERROR CLASS>
fun withMaturityDate(newMaturityDate: Instant): <ERROR CLASS>
fun withNewOwner(newOwner: PublicKey): <ERROR CLASS>
fun withOwner(newOwner: PublicKey): <ERROR CLASS>
@@ -715,7 +715,7 @@ -fun generateIssue(issuance: PartyReference, faceValue: Amount, maturityDate: Instant): TransactionBuilder
+fun generateIssue(issuance: PartyAndReference, faceValue: Amount, maturityDate: Instant): TransactionBuilder
fun generateMove(tx: TransactionBuilder, paper: StateAndRef<State>, newOwner: PublicKey): Unit
fun generateRedeem(tx: TransactionBuilder, paper: StateAndRef<State>, wallet: List<StateAndRef<State>>): Unit
val legalContractReference: SecureHash
@@ -908,7 +908,7 @@ fun generateClose(tx: TransactionBuilder, campaign: StateAndRef<State>, wallet: List<StateAndRef<State>>): Unit
fun generatePledge(tx: TransactionBuilder, campaign: StateAndRef<State>, subscriber: PublicKey): Unit
-fun generateRegister(owner: PartyReference, fundingTarget: Amount, fundingName: String, closingTime: Instant): TransactionBuilder
+fun generateRegister(owner: PartyAndReference, fundingTarget: Amount, fundingName: String, closingTime: Instant): TransactionBuilder
val legalContractReference: SecureHash
fun verify(tx: TransactionForVerification): Unit
@@ -1236,7 +1236,7 @@ -fun generateInitial(owner: PartyReference, magicNumber: Int): TransactionBuilder
+fun generateInitial(owner: PartyAndReference, magicNumber: Int): TransactionBuilder
val legalContractReference: SecureHash
fun verify(tx: TransactionForVerification): Unit
@@ -3144,13 +3144,13 @@ Party(name: String, owningKey: PublicKey)
val name: String
val owningKey: PublicKey
-fun ref(bytes: OpaqueBytes): PartyReference
-fun ref(vararg bytes: Byte): PartyReference
+fun ref(bytes: OpaqueBytes): PartyAndReference
+fun ref(vararg bytes: Byte): PartyAndReference
fun toString(): String
-data class PartyReference
+data class PartyAndReference
@@ -5658,17 +5658,17 @@ -State(deposit: PartyReference, amount: Amount, owner: PublicKey)
+State(deposit: PartyAndReference, amount: Amount, owner: PublicKey)
val amount: Amount
val contract: Cash
-val deposit: PartyReference
+val deposit: PartyAndReference
val owner: PublicKey
fun toString(): String
fun withNewOwner(newOwner: PublicKey): <ERROR CLASS>
-fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyReference, owner: PublicKey): Unit
+fun generateIssue(tx: TransactionBuilder, amount: Amount, at: PartyAndReference, owner: PublicKey): Unit
fun generateSpend(tx: TransactionBuilder, amount: Amount, to: PublicKey, cashStates: List<StateAndRef<State>>, onlyFromParties: Set<Party>? = null): List<PublicKey>
val legalContractReference: SecureHash
fun verify(tx: TransactionForVerification): Unit
@@ -5739,15 +5739,15 @@ -State(issuance: PartyReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)
+State(issuance: PartyAndReference, owner: PublicKey, faceValue: Amount, maturityDate: Instant)
val contract: CommercialPaper
val faceValue: Amount
-val issuance: PartyReference
+val issuance: PartyAndReference
val maturityDate: Instant
val owner: PublicKey
fun toString(): String
fun withFaceValue(newFaceValue: Amount): <ERROR CLASS>
-fun withIssuance(newIssuance: PartyReference): <ERROR CLASS>
+fun withIssuance(newIssuance: PartyAndReference): <ERROR CLASS>
fun withMaturityDate(newMaturityDate: Instant): <ERROR CLASS>
fun withNewOwner(newOwner: PublicKey): <ERROR CLASS>
fun withOwner(newOwner: PublicKey): <ERROR CLASS>
@@ -5755,7 +5755,7 @@ -fun generateIssue(issuance: PartyReference, faceValue: Amount, maturityDate: Instant): TransactionBuilder
+fun generateIssue(issuance: PartyAndReference, faceValue: Amount, maturityDate: Instant): TransactionBuilder
fun generateMove(tx: TransactionBuilder, paper: StateAndRef<State>, newOwner: PublicKey): Unit
fun generateRedeem(tx: TransactionBuilder, paper: StateAndRef<State>, wallet: List<StateAndRef<State>>): Unit
val legalContractReference: SecureHash
@@ -5869,7 +5869,7 @@ fun generateClose(tx: TransactionBuilder, campaign: StateAndRef<State>, wallet: List<StateAndRef<State>>): Unit
fun generatePledge(tx: TransactionBuilder, campaign: StateAndRef<State>, subscriber: PublicKey): Unit
-fun generateRegister(owner: PartyReference, fundingTarget: Amount, fundingName: String, closingTime: Instant): TransactionBuilder
+fun generateRegister(owner: PartyAndReference, fundingTarget: Amount, fundingName: String, closingTime: Instant): TransactionBuilder
val legalContractReference: SecureHash
fun verify(tx: TransactionForVerification): Unit
@@ -5937,7 +5937,7 @@ -fun generateInitial(owner: PartyReference, magicNumber: Int): TransactionBuilder
+fun generateInitial(owner: PartyAndReference, magicNumber: Int): TransactionBuilder
val legalContractReference: SecureHash
fun verify(tx: TransactionForVerification): Unit
@@ -6940,13 +6940,13 @@ Party(name: String, owningKey: PublicKey)
val name: String
val owningKey: PublicKey
-fun ref(bytes: OpaqueBytes): PartyReference
-fun ref(vararg bytes: Byte): PartyReference
+fun ref(bytes: OpaqueBytes): PartyAndReference
+fun ref(vararg bytes: Byte): PartyAndReference
fun toString(): String
-data class PartyReference
+data class PartyAndReference
diff --git a/docs/build/html/codestyle.html b/docs/build/html/codestyle.html index 798229329d..e646c4f22a 100644 --- a/docs/build/html/codestyle.html +++ b/docs/build/html/codestyle.html @@ -107,6 +107,7 @@
  • Code style guide