Skip to content

Commit

Permalink
Update Candid Files (#692)
Browse files Browse the repository at this point in the history
# Motivation
The canisters APIs have been updated.

# Changes
* Updated the candid interface files for the canisters used in this
library.
* Updated the javascript bindings for the latest candid interfaces.

# Tests
- [ ] Please check the API updates for any breaking changes that affect
our code.

Co-authored-by: gix-bot <[email protected]>
  • Loading branch information
sa-github-api and gix-bot authored Aug 6, 2024
1 parent c168456 commit 706bf1c
Show file tree
Hide file tree
Showing 29 changed files with 397 additions and 86 deletions.
2 changes: 1 addition & 1 deletion packages/ckbtc/candid/minter.did
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Generated from IC repo commit de29a1a (2024-07-18 tags: release-2024-07-18_01-30--github-base) 'rs/bitcoin/ckbtc/minter/ckbtc_minter.did' by import-candid
// Generated from IC repo commit 3d0b3f1 (2024-08-02 tags: release-2024-08-02_01-30-base) 'rs/bitcoin/ckbtc/minter/ckbtc_minter.did' by import-candid
// Represents an account on the ckBTC ledger.
type Account = record { owner : principal; subaccount : opt blob };

Expand Down
2 changes: 1 addition & 1 deletion packages/cketh/candid/minter.did
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Generated from IC repo commit de29a1a (2024-07-18 tags: release-2024-07-18_01-30--github-base) 'rs/ethereum/cketh/minter/cketh_minter.did' by import-candid
// Generated from IC repo commit 3d0b3f1 (2024-08-02 tags: release-2024-08-02_01-30-base) 'rs/ethereum/cketh/minter/cketh_minter.did' by import-candid
type EthereumNetwork = variant {
// The public Ethereum mainnet.
Mainnet;
Expand Down
2 changes: 1 addition & 1 deletion packages/cketh/candid/orchestrator.did
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Generated from IC repo commit de29a1a (2024-07-18 tags: release-2024-07-18_01-30--github-base) 'rs/ethereum/ledger-suite-orchestrator/ledger_suite_orchestrator.did' by import-candid
// Generated from IC repo commit 3d0b3f1 (2024-08-02 tags: release-2024-08-02_01-30-base) 'rs/ethereum/ledger-suite-orchestrator/ledger_suite_orchestrator.did' by import-candid
type OrchestratorArg = variant {
UpgradeArg : UpgradeArg;
InitArg : InitArg;
Expand Down
2 changes: 1 addition & 1 deletion packages/cmc/candid/cmc.certified.idl.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ export const idlFactory = ({ IDL }) => {
'public' : IDL.Null,
});
const CanisterSettings = IDL.Record({
'controller' : IDL.Opt(IDL.Principal),
'freezing_threshold' : IDL.Opt(IDL.Nat),
'wasm_memory_threshold' : IDL.Opt(IDL.Nat),
'controllers' : IDL.Opt(IDL.Vec(IDL.Principal)),
'reserved_cycles_limit' : IDL.Opt(IDL.Nat),
'log_visibility' : IDL.Opt(log_visibility),
Expand Down
2 changes: 1 addition & 1 deletion packages/cmc/candid/cmc.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import type { Principal } from "@dfinity/principal";
export type AccountIdentifier = string;
export type BlockIndex = bigint;
export interface CanisterSettings {
controller: [] | [Principal];
freezing_threshold: [] | [bigint];
wasm_memory_threshold: [] | [bigint];
controllers: [] | [Array<Principal>];
reserved_cycles_limit: [] | [bigint];
log_visibility: [] | [log_visibility];
Expand Down
88 changes: 43 additions & 45 deletions packages/cmc/candid/cmc.did
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
// Generated from IC repo commit de29a1a (2024-07-18 tags: release-2024-07-18_01-30--github-base) 'rs/nns/cmc/cmc.did' by import-candid
// Generated from IC repo commit 3d0b3f1 (2024-08-02 tags: release-2024-08-02_01-30-base) 'rs/nns/cmc/cmc.did' by import-candid
type Cycles = nat;
type BlockIndex = nat64;
type log_visibility = variant {
controllers;
public;
};
type CanisterSettings = record {
controller : opt principal;
controllers : opt vec principal;
compute_allocation : opt nat;
memory_allocation : opt nat;
freezing_threshold : opt nat;
reserved_cycles_limit: opt nat;
reserved_cycles_limit : opt nat;
log_visibility : opt log_visibility;
wasm_memory_limit: opt nat;
wasm_memory_limit : opt nat;
wasm_memory_threshold : opt nat;
};
type Subaccount = opt blob;
type Memo = opt blob;
Expand All @@ -27,18 +27,17 @@ type NotifyTopUpArg = record {
canister_id : principal;
};


type SubnetSelection = variant {
/// Choose a specific subnet
Subnet : record {
subnet: principal;
};
/// Choose a random subnet that fulfills the specified properties
Filter : SubnetFilter;
/// Choose a specific subnet
Subnet : record {
subnet : principal;
};
/// Choose a random subnet that fulfills the specified properties
Filter : SubnetFilter;
};

type SubnetFilter = record {
subnet_type: opt text;
subnet_type : opt text;
};

// The argument of the [create_canister] method.
Expand All @@ -50,10 +49,10 @@ type CreateCanisterArg = record {
// An optional subnet type that, if set, determines what type of subnet
// the new canister will be created on.
// Deprecated. Use subnet_selection instead.
subnet_type: opt text;
subnet_type : opt text;

// Optional instructions to select on which subnet the new canister will be created on.
subnet_selection: opt SubnetSelection;
subnet_selection : opt SubnetSelection;
};

// The argument of the [notify_create_canister] method.
Expand All @@ -67,11 +66,11 @@ type NotifyCreateCanisterArg = record {
// An optional subnet type that, if set, determines what type of subnet
// the new canister will be created on.
// Deprecated. Use subnet_selection instead.
subnet_type: opt text;
subnet_type : opt text;

// Optional instructions to select on which subnet the new canister will be created on.
// vec may contain no more than one element.
subnet_selection: opt SubnetSelection;
subnet_selection : opt SubnetSelection;

// Optional canister settings that, if set, are applied to the newly created canister.
// If not specified, the caller is the controller of the canister and the other settings are set to default values.
Expand All @@ -83,17 +82,17 @@ type NotifyCreateCanisterArg = record {
type CreateCanisterError = variant {
Refunded : record {
// The amount of cycles returned to the calling canister
refund_amount: nat;
refund_amount : nat;

// The reason why creating a canister failed.
create_error: text;
create_error : text;
};
RefundFailed : record {
// The reason why creating a canister failed.
create_error: text;
create_error : text;

// The reason why refunding cycles failed.
refund_error: text;
refund_error : text;
};
};

Expand Down Expand Up @@ -153,7 +152,6 @@ type IcpXdrConversionRate = record {
xdr_permyriad_per_icp : nat64;
};


type IcpXdrConversionRateResponse = record {
// The latest ICP/XDR conversion rate.
data : IcpXdrConversionRate;
Expand All @@ -176,49 +174,49 @@ type IcpXdrConversionRateResponse = record {
};

type SubnetTypesToSubnetsResponse = record {
data: vec record { text; vec principal };
data : vec record { text; vec principal };
};

type PrincipalsAuthorizedToCreateCanistersToSubnetsResponse = record {
data: vec record { principal; vec principal };
data : vec record { principal; vec principal };
};

type AccountIdentifier = text;

type ExchangeRateCanister = variant {
/// Enables the exchange rate canister with the given canister ID.
Set: principal;
/// Disable the exchange rate canister.
Unset;
/// Enables the exchange rate canister with the given canister ID.
Set : principal;
/// Disable the exchange rate canister.
Unset;
};

type CyclesCanisterInitPayload = record {
ledger_canister_id: opt principal;
governance_canister_id: opt principal;
minting_account_id: opt AccountIdentifier;
last_purged_notification: opt nat64;
exchange_rate_canister: opt ExchangeRateCanister;
cycles_ledger_canister_id: opt principal;
ledger_canister_id : opt principal;
governance_canister_id : opt principal;
minting_account_id : opt AccountIdentifier;
last_purged_notification : opt nat64;
exchange_rate_canister : opt ExchangeRateCanister;
cycles_ledger_canister_id : opt principal;
};

type NotifyMintCyclesArg = record {
block_index: BlockIndex;
to_subaccount: Subaccount;
deposit_memo: Memo;
block_index : BlockIndex;
to_subaccount : Subaccount;
deposit_memo : Memo;
};

type NotifyMintCyclesResult = variant {
Ok: NotifyMintCyclesSuccess;
Err: NotifyError;
Ok : NotifyMintCyclesSuccess;
Err : NotifyError;
};

type NotifyMintCyclesSuccess = record {
// Cycles ledger block index of deposit
block_index: nat;
// Amount of cycles that were minted and deposited to the cycles ledger
minted: nat;
// New balance of the cycles ledger account
balance: nat;
// Cycles ledger block index of deposit
block_index : nat;
// Amount of cycles that were minted and deposited to the cycles ledger
minted : nat;
// New balance of the cycles ledger account
balance : nat;
};

service : (opt CyclesCanisterInitPayload) -> {
Expand Down Expand Up @@ -246,4 +244,4 @@ service : (opt CyclesCanisterInitPayload) -> {
get_principals_authorized_to_create_canisters_to_subnets : () -> (PrincipalsAuthorizedToCreateCanistersToSubnetsResponse) query;

get_build_metadata : () -> (text) query;
}
};
2 changes: 1 addition & 1 deletion packages/cmc/candid/cmc.idl.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ export const idlFactory = ({ IDL }) => {
'public' : IDL.Null,
});
const CanisterSettings = IDL.Record({
'controller' : IDL.Opt(IDL.Principal),
'freezing_threshold' : IDL.Opt(IDL.Nat),
'wasm_memory_threshold' : IDL.Opt(IDL.Nat),
'controllers' : IDL.Opt(IDL.Vec(IDL.Principal)),
'reserved_cycles_limit' : IDL.Opt(IDL.Nat),
'log_visibility' : IDL.Opt(log_visibility),
Expand Down
37 changes: 37 additions & 0 deletions packages/ic-management/candid/ic-management.certified.idl.js
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,22 @@ export const idlFactory = ({ IDL }) => {
'amount' : IDL.Nat,
});
const raw_rand_result = IDL.Vec(IDL.Nat8);
const schnorr_algorithm = IDL.Variant({
'ed25519' : IDL.Null,
'bip340secp256k1' : IDL.Null,
});
const schnorr_public_key_args = IDL.Record({
'key_id' : IDL.Record({
'algorithm' : schnorr_algorithm,
'name' : IDL.Text,
}),
'canister_id' : IDL.Opt(canister_id),
'derivation_path' : IDL.Vec(IDL.Vec(IDL.Nat8)),
});
const schnorr_public_key_result = IDL.Record({
'public_key' : IDL.Vec(IDL.Nat8),
'chain_code' : IDL.Vec(IDL.Nat8),
});
const sign_with_ecdsa_args = IDL.Record({
'key_id' : IDL.Record({ 'name' : IDL.Text, 'curve' : ecdsa_curve }),
'derivation_path' : IDL.Vec(IDL.Vec(IDL.Nat8)),
Expand All @@ -278,6 +294,17 @@ export const idlFactory = ({ IDL }) => {
const sign_with_ecdsa_result = IDL.Record({
'signature' : IDL.Vec(IDL.Nat8),
});
const sign_with_schnorr_args = IDL.Record({
'key_id' : IDL.Record({
'algorithm' : schnorr_algorithm,
'name' : IDL.Text,
}),
'derivation_path' : IDL.Vec(IDL.Vec(IDL.Nat8)),
'message' : IDL.Vec(IDL.Nat8),
});
const sign_with_schnorr_result = IDL.Record({
'signature' : IDL.Vec(IDL.Nat8),
});
const start_canister_args = IDL.Record({ 'canister_id' : canister_id });
const stop_canister_args = IDL.Record({ 'canister_id' : canister_id });
const stored_chunks_args = IDL.Record({ 'canister_id' : canister_id });
Expand Down Expand Up @@ -374,11 +401,21 @@ export const idlFactory = ({ IDL }) => {
[],
),
'raw_rand' : IDL.Func([], [raw_rand_result], []),
'schnorr_public_key' : IDL.Func(
[schnorr_public_key_args],
[schnorr_public_key_result],
[],
),
'sign_with_ecdsa' : IDL.Func(
[sign_with_ecdsa_args],
[sign_with_ecdsa_result],
[],
),
'sign_with_schnorr' : IDL.Func(
[sign_with_schnorr_args],
[sign_with_schnorr_result],
[],
),
'start_canister' : IDL.Func([start_canister_args], [], []),
'stop_canister' : IDL.Func([stop_canister_args], [], []),
'stored_chunks' : IDL.Func(
Expand Down
26 changes: 26 additions & 0 deletions packages/ic-management/candid/ic-management.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,16 @@ export interface provisional_top_up_canister_args {
}
export type raw_rand_result = Uint8Array | number[];
export type satoshi = bigint;
export type schnorr_algorithm = { ed25519: null } | { bip340secp256k1: null };
export interface schnorr_public_key_args {
key_id: { algorithm: schnorr_algorithm; name: string };
canister_id: [] | [canister_id];
derivation_path: Array<Uint8Array | number[]>;
}
export interface schnorr_public_key_result {
public_key: Uint8Array | number[];
chain_code: Uint8Array | number[];
}
export interface sign_with_ecdsa_args {
key_id: { name: string; curve: ecdsa_curve };
derivation_path: Array<Uint8Array | number[]>;
Expand All @@ -258,6 +268,14 @@ export interface sign_with_ecdsa_args {
export interface sign_with_ecdsa_result {
signature: Uint8Array | number[];
}
export interface sign_with_schnorr_args {
key_id: { algorithm: schnorr_algorithm; name: string };
derivation_path: Array<Uint8Array | number[]>;
message: Uint8Array | number[];
}
export interface sign_with_schnorr_result {
signature: Uint8Array | number[];
}
export interface start_canister_args {
canister_id: canister_id;
}
Expand Down Expand Up @@ -343,7 +361,15 @@ export interface _SERVICE {
undefined
>;
raw_rand: ActorMethod<[], raw_rand_result>;
schnorr_public_key: ActorMethod<
[schnorr_public_key_args],
schnorr_public_key_result
>;
sign_with_ecdsa: ActorMethod<[sign_with_ecdsa_args], sign_with_ecdsa_result>;
sign_with_schnorr: ActorMethod<
[sign_with_schnorr_args],
sign_with_schnorr_result
>;
start_canister: ActorMethod<[start_canister_args], undefined>;
stop_canister: ActorMethod<[stop_canister_args], undefined>;
stored_chunks: ActorMethod<[stored_chunks_args], stored_chunks_result>;
Expand Down
Loading

0 comments on commit 706bf1c

Please sign in to comment.